Skip to content

Generates manifest.json, browserconfig.xml, and resizes icons for all required sizes

Notifications You must be signed in to change notification settings

odo-network/app-manifest-webpack-plugin

Repository files navigation

App Manifest Webpack Plugin

To aid in the development of your PWA (Progressive Web Application), this plugin will take in a single icon file and automatically generate all required sizes for your various devices and engines that may need them. It will also generate your manifest.json, browserconfig.xml, and other manifest files that browsers use to render your application.

This plugin utilizes favicons.js under the hood and will run through and modify it's output and html that it generates to match your Webpack configuration. In addition, when used in conjunction with html-webpack-plugin and inject, it will insert all of the necessary meta tags into your index.html.

Unfinished - This library is working but it does not cache the results at this time. Until that is completed it will significantly slow down each webpack compilation.

Example

new AppManifestWebpackPlugin({
  logo: path.resolve(rootDir, 'images', 'icon.png'),
  favicons: {
    path: 'images/[hash]/',
    appName: 'My App',
    background: '#121519',
    theme_color: '#303641',
    display: 'fullscreen',
  },
}),

Favicons Config Defaults

{
  "path": "/",
  "appName": null,
  "appDescription": null,
  "developerName": null,
  "developerURL": null,
  "dir": "auto",
  "lang": "en-US",
  "background": "#fff",
  "theme_color": "#fff",
  "display": "standalone",
  "orientation": "any",
  "start_url": "/?homescreen=1",
  "version": "1.0",
  "logging": false,
  "pipeHTML": false,
  "icons": {
    "android": true,
    "appleIcon": true,
    "appleStartup": true,
    "coast": true,
    "favicons": true,
    "firefox": true,
    "windows": true,
    "yandex": true
  }
}

About

Generates manifest.json, browserconfig.xml, and resizes icons for all required sizes

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published