@hug/ngx-app-updater
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@hug/ngx-app-updater


hug-logo

Notify about Angular application's update

npm version npm donwloads license GPLv3

build status PRs welcome


This library is a wrapper around the official @angular/service-worker library with extra functionalities.

It adds Progressive Web App supports and updates notifications to an Angular project.


Getting started

To set up or update an Angular project with this library use the Angular CLI's schematic commands:

Installation

ng add @hug/ngx-app-updater
More details

The ng add command will ask you the following questions:

  1. Allow user to cancel an update: whether a user can choose to cancel an update or not

And will also perform the following actions:

  • Imports and registers the service worker in the application.
  • Provide and initialize the library.
  • Adds icons and screenshots files to support the installed PWA.
  • Adds a manifest.webmanifest file.
  • Adds a ngsw-config.json file.
  • Updates the index.html to links the manifest and adds theme-color and noscript tags.

Update

ng update @hug/ngx-app-updater

Features

🚀 Progressive Web App

  • Adds caching and offline behaviors through ngsw-config.json file.
  • Adds icons and screenshots files to support the installed PWA.
  • Adds a manifest.webmanifest file.
  • Updates the index.html to links the manifest and adds theme-color and noscript tags.

📣 Notification

When a new version of your application is deployed, this library will trigger a user notification to inform them that updates are available.

This is particularly useful to ensure that users who rarely close or refresh their web browsers are always running the latest version.

They can choose to update immediately, delay the update until a later time, or be forced to update.

By default, updates are checked every minute, and users are prompted about updates every day.

Usage

Have a look at the Options section to discover what can be customized.

TIP: in case @angular/material is installed, the dialog will be themed accordingly.

TIP: you can provide your own dialog, following this example and using the dialogOptions.component option.

4️⃣0️⃣4️⃣ Not found page

If a new route is to be released in a new version of your application, users that are still using an old version of the application will not be able to access that url on a first try.

To mitigate this behavior, this library provides a 404 page that you could use to notify a user about a potential update.

Users will then be able to relaunch their application, apply the update and be presented with the new route.

Usage

Have a look at the Options section to discover what can be customized.

TIP: in case @angular/material is installed, this page will be themed accordingly.

TIP: you can design your own 404 page following this example.

import { Routes } from '@angular/router';
import { HomePage } from './home.component';

export const routes: Routes = [
  { path: '', component: HomePage },
  {
    path: '**',
    pathMatch: 'full',
    loadComponent: () => import('@hug/ngx-app-updater/not-found').then(m => m.NgxAppUpdaterNotFoundPage)
  }
];

Options

You shouldn't have to configure anything else but in case you wanted to, you can still do it.

The behavior of the library can be configured either in:

  • main.ts (if the app is a standalone Angular application)

    bootstrapApplication(AppComponent, {
      providers: [
        provideAppUpdater(options?: NgxAppUpdaterOptions)
      ]
    });
  • app.module.ts (if the app is not a standalone Angular application)

    @NgModule({
      imports: [
        NgxAppUpdaterModule.forRoot(options?: NgxAppUpdaterOptions)
      ]
    })
    export class AppModule { }

Development

See the developer docs.

Contributing

> Want to Help?

Want to file a bug, contribute some code or improve documentation? Excellent!

But please read up first on the guidelines for contributing, and learn about submission process, coding rules and more.

> Code of Conduct

Please read and follow the Code of Conduct, and help us keep this project open and inclusive.

Credits

Copyright (C) 2021 HUG - Hôpitaux Universitaires Genève

love@hug

Package Sidebar

Install

npm i @hug/ngx-app-updater

Weekly Downloads

45

Version

2.0.0

License

GPL-3.0-only

Unpacked Size

954 kB

Total Files

61

Last publish

Collaborators

  • dsi-hug
  • badisi