Network Performance Monitor

    offline-plugin

    5.0.7 • Public • Published

    offline-plugin logo

    offline-plugin for webpack

    backers sponsors npm npm


    This plugin is intended to provide an offline experience for webpack projects. It uses ServiceWorker, and AppCache as a fallback under the hood. Simply include this plugin in your webpack.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.

    Sponsors

    Become a sponsor and get your logo on our README on Github with a link to your site.
    Become a sponsor

    Install

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

    Setup

    First, instantiate the plugin in your webpack.config:

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

    (and optionally configure with options)

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

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

    ES6/Babel/TypeScript

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

    For more details of usage with TypeScript see here

    offline-plugin isn't working?

    ℹ️ Troubleshooting | FAQ

    Docs

    Examples

    Articles

    Options

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

    See all available options here.

    Who is using offline-plugin

    Projects

    PWAs

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

    Like offline-plugin?

    Support it by giving feedback, contributing, becoming a backer/sponsor or just by 🌟 starring the project!

    Backers

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

    Contribution

    See CONTRIBUTING

    License

    MIT
    Logo

    CHANGELOG

    CHANGELOG

    Install

    npm i offline-plugin

    DownloadsWeekly Downloads

    27,940

    Version

    5.0.7

    License

    MIT

    Unpacked Size

    111 kB

    Total Files

    22

    Last publish

    Collaborators

    • nekr