Repository files navigation

offline-plugin for webpack

This plugin is intended to provide an offline experience forwebpack projects. It usesServiceWorker, andAppCache as a fallback under the hood. Simply include this plugin in yourwebpack.config, and the accompanying runtime in your client script, and your project will become offline ready by caching all (or some) of the webpack output assets.

npm install offline-plugin [--save-dev]

First, instantiate the plugin in yourwebpack.config:

// webpack.config.js examplevarOfflinePlugin=require('offline-plugin');module.exports={// ...plugins:[// ... other plugins// it's always better if OfflinePlugin is the last plugin addednewOfflinePlugin()]// ...}

(and optionally configure withoptions)

Then, add theruntime into your entry file (typically main entry):

require('offline-plugin/runtime').install();

ES6/Babel/TypeScript

import*asOfflinePluginRuntimefrom'offline-plugin/runtime';OfflinePluginRuntime.install();

For more details of usage withTypeScript seehere

ℹ️Troubleshooting |FAQ

• Options
• Caches
• Update process
• Cache Maps
• Runtime API

• Single Page Application

• Easy Offline First Apps With Webpack's Offline Plugin
• Handling Client Side App Updates (with Service Workers)

All options are optional andoffline-plugin can be used without specifying them.

• React Boilerplate
• Phenomic
• React, Universally

• offline-plugin PWA
• Omroep West
• Preact (source)
• CodePan (source)
• Offline Kanban (source)
• Online Board (source)
• Fluid Outliner (source)

If you are usingoffline-plugin, feel free to submit a PR to add your project to this list.

Support it by givingfeedback,contributing, becoming abacker/sponsor or just by 🌟 starring the project!

Support us with a monthly donation and help us continue our activities. [Become a backer]

SeeCONTRIBUTING

MIT
Logo

CHANGELOG