webpack-favicons

v1.5.4

Published

2 months ago

Webpack plugin to generate favicons for devices and browsers

Downloads

8,547

0High
0Medium
0Low

devinrayolsen

webpack favicon favicons webpack favicon webpack html favicon webpack favicons

Does this plugin work with Webpack 4?

No, you should checkout https://github.com/jantimon/favicons-webpack-plugin for a Webpack 4 compatible plugin.

How does it works

By tapping into the Webpack 5's latest hooks, WebackFavicon digs into a given build to search for any instances of HTML file assets. While doing that, it leverages the favicon (https://github.com/itgalaxy/favicons) module to generate configured favicons off your provided source file.

Once done, you will have device or browser specific generated favicons written to disk while HTML files (with a <head> tag) will have corresponding <link> tags injected.

Does this work with CopyWebpackPlugin?

Yep! While it is more common to see a Webpack configuration using HtmlWebpackPlugin in order to process HTML files; WebpackFavicons will inject <link> tags into HTML documents found being copied by CopyWebpackPlugin and/or HtmlWebpackPlugin.

Install

npm i --save-dev webpack-favicons

yarn add --dev webpack-favicons

Webpack Config

const WebpackFavicons = require('webpack-favicons');

Instantiate a new WebpackFavicons() class within Webpack configuration's plugin array:


// Basic configuration

module.exports = {
  output: {
    path: '/dist', 
    publicPath: '/~media/'
  }  
  plugins: [
    new WebpackFavicons({
      src: 'assets/favicon.svg',
      path: 'img',
      background: '#000',
      theme_color: '#000',
      icons: {
        favicons: true
      }
    })
  ]
};

Will result in file(s) being written to:

/dist/img/favicon.ico
/dist/img/favicon16x16.png
/dist/img/favicon32x32.png
/dist/img/favicon48x48.png

While any HTML with a <head> tag will have paths to favicons added:

<link rel="shortcut icon" href="/~media/img/favicon.ico">
<link rel="icon" type="image/png" sizes="16x16" href="/~media/img/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="/~media/img/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="48x48" href="/~media/img/favicon-48x48.png">

It is recommended that your source favicon file be a SVG vector file to allow best possible quality to generated pixel based favicons from.

Options

Note: These options both come from, and are directly passed to the favicon generating node module. For much more information about these options please visit: https://github.com/itgalaxy/favicons

Option | Type | Description --- | --- | --- src | String | Path to the source favicon file which all favicons will be generated from path | String | Path to where icons get written (is relative to webpack's output.path) appName | String | Your application's name. appShortName | String | Your application's short_name. (Optional. If not set, appName will be used) appDescription | String | Your application's description. developerName | String | Your (or your developer's) name. developerURL | String | Your (or your developer's) URL. dir | String | Primary text direction for name, short_name, and description lang | String | Primary language for name and short_name background | String | Background color for flattened icons. theme_color | String | Theme color user for example in Android's task switcher. appleStatusBarStyle | String | Style for Apple status bar: "black-translucent", "default", "black". display | String | Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". orientation | String | Default orientation: "any", "natural", "portrait" or "landscape". scope | String | set of URLs that the browser considers within your app start_url | String | Start URL when launching the application from a device. version | String | Your application's version string. logging | Boolean | Print logs to console? pixel_art | String | Keeps pixels "sharp" when scaling up, for pixel art. Only supported in offline mode. loadManifestWithCredentials | Boolean | Browsers don't send cookies when fetching a manifest, enable this to fix that. icons | Object | See below for more details about this object's options.

Icon Object's Options

Option | Type | Description --- | --- | --- android | Boolean | Create Android homescreen icon. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources appleIcon | Boolean | Create Apple touch icons. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources appleStartup | Boolean | Create Apple startup images. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources coast | Boolean | Create Opera Coast icon. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources favicons | Boolean | Create regular favicons. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources firefox | Boolean | Create Firefox OS icons. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources windows | Boolean | Create Windows 8 tile icons. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources yandex | Boolean | Create Yandex browser icon. boolean or { offset, background, mask, overlayGlow, overlayShadow } or an array of sources

Callback

Optional callback allowing the opportunity to alter the generated images, html and manifest file(s) data prior to Webpack writing anything to disk:


// Basic configuration

module.exports = {
  output: {
    path: '/dist', 
    publicPath: '/~media/'
  }  
  plugins: [
    new WebpackFavicons({
      ...
    }, (response) => {
      // alter generated images, html or manifest file data here
      response.images[0].name = 'custom.ico';
      response.html[0] = response.html[0].replace('favicon.ico', 'custom.ico');
    })
  ]
};

Tests

Webpack Favicons comes with a few tests. These helps ensure that both favicons get written to disk and that link tags are injected into any HTML assets within the larger Webpack build process.

Simply run npm run test or yarn test from the root of the plugin to run test.

Running a test will produce a /dist/ directory.

If you would like to change a test, update the root package.json file's test script to use any of the /test/test.config.js files.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme