amp-install-serviceworker component enables service worker installation via same origin or via the Google AMP Cache.
Service workers can run in the background even when the browser is closed, cache required contents in advance of rendering time, send notifications to users, and more.
This sample installs a service worker which caches this page in the background. You can test this by loading this page while offline once the service worker has been installed.
Service Workers are currently available in Chrome, Edge, Firefox, Opera and Safari.
Workbox is a great library for implementing service workers.
Import the amp-install-serviceworker component.
<script async custom-element="amp-install-serviceworker" src="https://cdn.ampproject.org/v0/amp-install-serviceworker-0.1.js"></script>
Installing the service worker
amp-install-serviceworker can include the
src is the location of the service worker to be installed, and is used when the document is accessed via the same origin as the service worker file. When the document is accessed via the Google AMP Cache, the HTML document noted in the
data-iframe-src attribute is used to install the service worker. We recommend using both attributes.
The reason why
amp-install-serviceworker requires a separate
data-iframe-src option is because browsers can't install service worker from other domains for security reasons. For details of the security considerations of service worker, see official specs.
If you don't want to provide a special minimal document to install a sevice worker, you can simply link to the AMP document on your own origin.
<amp-install-serviceworker src="/serviceworker.js" data-iframe-src="https://amp.dev/serviceworker.html" layout="nodisplay"> </amp-install-serviceworker>
In this sample, when users access this AMP page for the second time, the service worker is installed and caches all image files and video files under the root path of this domain.
Confirm that the service worker is installed and works as expected by following the following steps:
1. Access amp-install-serviceworker twice.
2. Open Chrome Dev Tools and navigate to the "Resources" tab (or "Application" tab on newer versions of Chrome). In the "Service Workers" section you can see that
/sw.js is installed.
3. Then open the "Cached Storage" section. It shows all cached images and videos.
4. Disable your network connection and reload this page. It still works! In the "Network" tab in Dev Tools, you'll see which resources are cached by the service worker.
If the explanations on this page don't cover all of your questions feel free to reach out to other AMP users to discuss your exact use case.Go to Stack Overflow An unexplained feature?
The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.Edit sample on GitHub
Written by @ymotongpoo