Leverages on favicons to automatically generate your progressive web app for you.

Originally forked from jantimon/favicons-webpack-plugin
What's new?

Installation

Install the plugin with npm:

1$ npm install --save-dev webapp-webpack-plugin

Basic Usage

Add the plugin to your webpack config as follows:

1const WebappWebpackPlugin = require('webapp-webpack-plugin')
2
3...
4
5plugins: [
6  new WebappWebpackPlugin('/path/to/logo.png') // svg works too!
7]

The default configuration will automatically generate webapp manifest files along with 44 different icon formats as appropriate for iOS devices, Android devices, Windows Phone and various desktop browsers out of your single logo.png.

Tip: You might want to fine tune what vendors to support.

A Note on Path Resolution

Under the hood, Webpack resolves the path to logo according to the following rules:

• If /path/to/logo is absolute, there is nothing to resolve and the path specified is used as is.

• If ./path/to/logo is relative, it's resolved with respect to Webpack's context, which defaults to process.cwd().

• If path/to/logo is neither explicitly relative nor absolute, Webpack attempts to resolve it according to resolve.modules, which defaults to modules: ["node_modules"].

HTML Injection

In combination with html-webpack-plugin it will also inject the necessary html for you:

Note: html-webpack-plugin must come before webapp-webpack-plugin in the plugins array.

1<link rel="apple-touch-icon" sizes="57x57" href="/assets/apple-touch-icon-57x57.png">
2<link rel="apple-touch-icon" sizes="60x60" href="/assets/apple-touch-icon-60x60.png">
3<link rel="apple-touch-icon" sizes="72x72" href="/assets/apple-touch-icon-72x72.png">
4<link rel="apple-touch-icon" sizes="76x76" href="/assets/apple-touch-icon-76x76.png">
5<link rel="apple-touch-icon" sizes="114x114" href="/assets/apple-touch-icon-114x114.png">
6<link rel="apple-touch-icon" sizes="120x120" href="/assets/apple-touch-icon-120x120.png">
7<link rel="apple-touch-icon" sizes="144x144" href="/assets/apple-touch-icon-144x144.png">
8<link rel="apple-touch-icon" sizes="152x152" href="/assets/apple-touch-icon-152x152.png">
9<link rel="apple-touch-icon" sizes="167x167" href="/assets/apple-touch-icon-167x167.png">
10<link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon-180x180.png">
11<link rel="apple-touch-icon" sizes="1024x1024" href="/assets/apple-touch-icon-1024x1024.png">
12<link rel="apple-touch-startup-image" media="(device-width: 320px) and (device-height: 480px) and (-webkit-device-pixel-ratio: 1)" href="/assets/apple-touch-startup-image-320x460.png">
13<link rel="apple-touch-startup-image" media="(device-width: 320px) and (device-height: 480px) and (-webkit-device-pixel-ratio: 2)" href="/assets/apple-touch-startup-image-640x920.png">
14<link rel="apple-touch-startup-image" media="(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2)" href="/assets/apple-touch-startup-image-640x1096.png">
15<link rel="apple-touch-startup-image" media="(device-width: 375px) and (device-height: 667px) and (-webkit-device-pixel-ratio: 2)" href="/assets/apple-touch-startup-image-750x1294.png">
16<link rel="apple-touch-startup-image" media="(device-width: 414px) and (device-height: 736px) and (orientation: landscape) and (-webkit-device-pixel-ratio: 3)" href="/assets/apple-touch-startup-image-1182x2208.png">
17<link rel="apple-touch-startup-image" media="(device-width: 414px) and (device-height: 736px) and (orientation: portrait) and (-webkit-device-pixel-ratio: 3)" href="/assets/apple-touch-startup-image-1242x2148.png">
18<link rel="apple-touch-startup-image" media="(device-width: 768px) and (device-height: 1024px) and (orientation: landscape) and (-webkit-device-pixel-ratio: 1)" href="/assets/apple-touch-startup-image-748x1024.png">
19<link rel="apple-touch-startup-image" media="(device-width: 768px) and (device-height: 1024px) and (orientation: landscape) and (-webkit-device-pixel-ratio: 2)" href="/assets/apple-touch-startup-image-1496x2048.png">
20<link rel="apple-touch-startup-image" media="(device-width: 768px) and (device-height: 1024px) and (orientation: portrait) and (-webkit-device-pixel-ratio: 1)" href="/assets/apple-touch-startup-image-768x1004.png">
21<link rel="apple-touch-startup-image" media="(device-width: 768px) and (device-height: 1024px) and (orientation: portrait) and (-webkit-device-pixel-ratio: 2)" href="/assets/apple-touch-startup-image-1536x2008.png">
22<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
23<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
24<link rel="icon" type="image/png" sizes="228x228" href="/assets/coast-228x228.png">
25<link rel="manifest" href="/assets/manifest.json">
26<link rel="shortcut icon" href="/assets/favicon.ico">
27<link rel="yandex-tableau-widget" href="/assets/yandex-browser-manifest.json">
28<meta name="apple-mobile-web-app-capable" content="yes">
29<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
30<meta name="apple-mobile-web-app-title">
31<meta name="application-name">
32<meta name="mobile-web-app-capable" content="yes">
33<meta name="msapplication-TileColor" content="#fff">
34<meta name="msapplication-TileImage" content="/assets/mstile-144x144.png">
35<meta name="msapplication-config" content="/assets/browserconfig.xml">
36<meta name="theme-color" content="#fff">

https://github.com/brunocodutra/webapp-webpack-plugin/blob/master/test/fixtures/expected/html

Advanced Usage

1plugins: [
2  new WebappWebpackPlugin({
3    // Your source logo (required)
4    logo: '/path/to/logo.png',
5    // Enable caching and optionally specify the path to store cached data
6    // Note: disabling caching may increase build times considerably
7    cache: true,
8    // Override the publicPath option usually read from webpack configuration
9    publicPath: '/static',
10    // The directory to output the assets relative to the webpack output dir.
11    // Relative string paths are allowed here ie '../public/static'. If this
12    // option is not set, `prefix` is used.
13    outputPath: '/public/static',
14    // Prefix path for generated assets
15    prefix: 'assets/',
16    // Inject html links/metadata (requires html-webpack-plugin).
17    // This option accepts arguments of different types:
18    //  * boolean
19    //    `false`: disables injection
20    //    `true`: enables injection if that is not disabled in html-webpack-plugin
21    //  * string
22    //    `'force'`: enables injection even if that is disabled in html-webpack-plugin
23    //  * function
24    //    any predicate that takes an instance of html-webpack-plugin and returns either
25    //    `true` or `false` to control the injection of html metadata for the html files
26    //    generated by this instance.
27    inject: true,
28    // Favicons configuration options (see below)
29    favicons: {
30      ...
31    }
32  })
33]

To fine tune what icons/metadata is generated, refer to favicons' documentation.

The options specified under favicons: are handed over as is to favicons, except that if appName, appDescription, version, developerName or developerURL are left undefined, they will be automatically inferred respectively from name, description, version, author.name and author.url as defined in the nearest package.json if available. To disable automatically retrieving metadata from package.json, simply set to null the properties you want to omit.

Examples

Basic

1const WebappWebpackPlugin = require('webapp-webpack-plugin')
2
3...
4
5plugins: [
6  new WebappWebpackPlugin({
7    logo: '/path/to/logo.png', // svg works too!
8    favicons: {
9      appName: 'my-app',
10      appDescription: 'My awesome App',
11      developerName: 'Me',
12      developerURL: null, // prevent retrieving from the nearest package.json
13      background: '#ddd',
14      theme_color: '#333',
15      icons: {
16        coast: false,
17        yandex: false
18      }
19    }
20  })
21]

Handling Multiple HTML Files

1const WebappWebpackPlugin = require('webapp-webpack-plugin')
2const HtmlWebpackPlugin = require('html-webpack-plugin')
3const { basename } = require('path')
4
5...
6
7plugins: [
8    new HtmlWebpackPlugin({
9        template: 'a.html.tmpl',
10        filename: 'a.html',
11    }),
12    new HtmlWebpackPlugin({
13        template: 'b.html.tmpl',
14        filename: 'b.html',
15    }),
16    new WebappWebpackPlugin({
17        logo: 'logo.svg',
18        inject: htmlPlugin => 
19          basename(htmlPlugin.options.filename) === 'a.html',
20    }),
21],

Hooks

To allow other plugins to intercept and customise assets before they are emitted, the following hooks may be tapped

webappWebpackPluginBeforeEmit

AsyncSeriesWaterfallHook

Example implementation:

1  new class {
2    apply(compiler) {
3      compiler.hooks.make.tapAsync("A", (compilation, callback) => {
4        compilation.hooks.webappWebpackPluginBeforeEmit.tapAsync("B", (result, callback) => {
5          // The result of favicons library can be modified here
6          // and it will be returned to WebApp Plugin to be emitted.
7          // Add your custom functions below
8          console.log(result);
9          // Return the custom result
10          return callback(null, result);
11        });
12        return callback();
13      })
14    }
15  }

Rule

A Webpack loader rule is also provided to make the generated HTML tags available to your JS app.

1const plugin = new WebappWebpackPlugin({ logo: '/path/to/logo.png' });
2
3...
4
5plugins: [
6  plugin
7]
8module: {
9  rules: [
10    plugin.rule()
11  ],
12}

1// now inside Webpack bundle
2// you can require logo path
3// and get an array of strings with html tags
4const favicons = require( '/path/to/logo.png' );

Note: logo must be an absolute path for rule to work.

Contribution

You're very welcome to contribute to this project by opening issues and/or pull requests.

Please keep in mind that every change and new feature should be covered by tests.

License

This project is licensed under MIT.