craco-workbox

A simple craco plugin to override the workbox config in CRA2

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
craco-workbox
1720.2.0a year ago4 years agoMinified + gzip package size for craco-workbox in KB

Readme

craco-workbox
Prerequisites
Install craco

Install

yarn add craco-workbox -D

# OR

npm install craco-workbox -S

Usage

  1. Add the plugin into your craco.config.js;

// craco.config.js

const CracoWorkboxPlugin = require('craco-workbox');

module.exports = {
    plugins: [{
        plugin: CracoWorkboxPlugin
    }]
}

  1. Add a workbox.config.js file to your project root containing the overrides you would like to pass. For a full list of options see https://developers.google.com/web/tools/workbox/modules/workbox-webpack-plugin#generateswplugin.

// workbox.config.js

module.exports = {
  GenerateSW: options => {
    // override GenerateSW config here
    // e.g. options.skipWaiting = true;
    return options;
  },
  InjectManifest: options => {
    // override InjectManifest config here
    // e.g. options.maximumFileSizeToCacheInBytes = 10 * 1024 * 1024;
    return options;
  }
};

License

Licensed under the MIT License, Copyright ©️ 2019 Kevin S. Perrine. See LICENSE for more information.