Workbox is a suite of helper libraries for service workers and progressive web apps that lets you implement precaching in a manner of minutes. Its features support runtime caching, routing, offline analytics, background syncing, and more.
Use sw-cli to add a service worker to an existing project in under two minutes.
Generate a service worker in your build process using sw-build.
Go beyond the basics. If you'd like to use the Workbox libraries, and you already have your own service worker, then checkout sw-lib which lets you add to what you've already got.
If you've been using Workbox for a while, or you're ambitious, you can delve into its more advanced features. Browse the recipes section, try the examples, or look up something in the mobules reference.
Each library is installed separately using the command line as listed below. To use a particular library:
-
Install the library. For example:
npm install --save-dev sw-lib -
Copy the library's JavaScript and map files to your serving directory.
cp node_modules/sw-lib/build/* app/ -
Import the library to your service worker file. For example:
importScripts('sw-lib.min.js');
All of the libraries are described below. Each has an About page with basic usage instructions and a Demo directory with an example. The main page of the documentation is here.
Queues failed requests and uses the Background Sync API to replay those requests at a later time when the network state has changed.
Install: npm install --save-dev sw-background-sync-queue
A helper library that uses the Broadcast Channel API to announce when two Response objects differ.
Install: npm install --save-dev sw-broadcast-cache-update
This is a webpack plugin for sw-build
Install: npm install --save-dev sw-build-webpack-plugin
Learn More: About
This module can be used to generate a file manifest or service worker, that can be used with sw-lib.
Install: npm install --save-dev sw-build
This library is still a work in progress and is not functional.
Install: npm install --save-dev sw-cache-expiration
This library takes a Response object and determines whether it's cacheable, based on a specific configuration.
Install: npm install --save-dev sw-cacheable-response
A CLI tool to generate a service worker and a file manifest making use of the sw-lib module.
Install: npm install --global sw-cli
A service worker library to make managing fetch requests and caching as easy as possible.
Install: npm install --save-dev sw-lib
A service worker helper library to retry offline Google Analytics requests when a connection is available.
Install: npm install --save-dev sw-offline-google-analytics
This library is still a work in progress and is not functional.
Install: npm install --save-dev sw-precaching
A service worker helper library to route request URLs to handlers.
Install: npm install --save-dev sw-routing
A service worker helper library that implements various runtime caching strategies.
Install: npm install --save-dev sw-runtime-caching
Please read the guide to contributing prior to filing any pull requests.
Copyright 2016 Google, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.