serviceworker-helpers

Display a toast on available service worker update

View larger

Close

[ This description is mirrored from README.md at github.com/morbidick/serviceworker-helpers on 2019-05-22 ]

Polymer 2 components to work with Service Workers

HowTo

Register service worker

Since its more or less a one-liner to register your service worker and included in most boilerplates there is no specific element.

<script>
  if ('serviceWorker' in navigator) {
    window.addEventListener('load', function() {
      navigator.serviceWorker.register('/service-worker.js');
    });
  }
</script>

<sw-update-toast>

Displays a toast requesting the user to reload the page when a source code update is available.

The update message can be overwriten by setting message (optional). The display time can be changed by setting duration, defaults to 0 / persistend.

<link rel="import" href="serviceworker-helpers/sw-update-toast.html">

<sw-update-toast
  message="My message"
  duration="5"
></sw-update-toast>

Change the link color by setting the css var --primary-color.

Development

# Get dependencies
$ npm install

# Demo site
$ npm start

# Run tests
$ npm test

Links

• GitHub Homepage
• Issue tracker
• Online Demo
• Documentation
• View on GitHub

Compatibility