Necromancers Playing MTG

    vite-plugin-favicon
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.8 • Public • Published

    Favicons Vite Plugin

    version NPM Codecov Libraries.io dependency status for latest release Rate on Openbase Test Release

    Leverages on favicons to automatically generate your favicons for you. And if you want to also consolidate your PWA manifest, will generate that as well with linked icons.

    Partially adapted from and config compatible with favicons-webpack-plugin

    Installation

    Install the plugin with npm:

    $ npm install --save-dev vite-plugin-favicon
    # Or shorthand
    npm i -D vite-plugin-favicon

    Zero Config Usage

    Add your base logo as logo.png file to your assets folder.

    Add the plugin to your vite config as follows:

    const ViteFaviconsPlugin = require('vite-plugin-favicon')
    // or ESM
    import { ViteFaviconsPlugin } from "module";
    
    plugins: [
      ViteFaviconsPlugin()
    ]

    Basic Usage

    Add the plugin to your vite config as follows:

    const ViteFaviconsPlugin = require('vite-plugin-favicon')
    // or ESM
    import { ViteFaviconsPlugin } from "module";
    
    ...
    
    plugins: [
      ViteFaviconsPlugin('/path/to/logo.png') // svg works too!
    ]

    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, Vite/Rollup resolve the paths to the logo and favicons 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 process.cwd().

    HTML Injection

    In combination with Vite's html plugin hooks it will also inject the necessary html for you:

    <link rel="apple-touch-icon" sizes="57x57" href="/assets/apple-touch-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/assets/apple-touch-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/assets/apple-touch-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/assets/apple-touch-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/assets/apple-touch-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/assets/apple-touch-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/assets/apple-touch-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/assets/apple-touch-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="167x167" href="/assets/apple-touch-icon-167x167.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon-180x180.png">
    <link rel="apple-touch-icon" sizes="1024x1024" href="/assets/apple-touch-icon-1024x1024.png">
    <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">
    <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">
    <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">
    <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">
    <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">
    <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">
    <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">
    <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">
    <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">
    <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">
    <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
    <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="228x228" href="/assets/coast-228x228.png">
    <link rel="manifest" href="/assets/manifest.json">
    <link rel="shortcut icon" href="/assets/favicon.ico">
    <link rel="yandex-tableau-widget" href="/assets/yandex-browser-manifest.json">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
    <meta name="apple-mobile-web-app-title">
    <meta name="application-name">
    <meta name="mobile-web-app-capable" content="yes">
    <meta name="msapplication-TileColor" content="#fff">
    <meta name="msapplication-TileImage" content="/assets/mstile-144x144.png">
    <meta name="msapplication-config" content="/assets/browserconfig.xml">
    <meta name="theme-color" content="#fff">

    Advanced Usage

    plugins: [
      ViteFaviconsPlugin({
        /** Your source logo (Will default to ) */
        logo?: "assets/logo.png",
        /** Inject html links/metadata. */
        inject?: true,
        /** `Favicons` configuration options
        *  - [See `favicons` documentation](https://github.com/itgalaxy/favicons) */
        favicons?: FaviconsConfig,
        /** The root of the project from which you want to load metadata */
        projectRoot?: process.cwd(),
    
        /** prefix is delegated to Rollup/Vite (keeping for people migrating from Webpack)
        * @deprecated */
        prefix?: string,
        /** Caching is delegated to Rollup/Vite (keeping for people migrating from Webpack)
        * @deprecated */
        cache?: boolean,
        /** Public Path is delegated to Rollup/Vite (keeping for people migrating from Webpack)
        * @deprecated */
        publicPath?: string,
        /** Output Path is delegated to Rollup/Vite (keeping for people migrating from Webpack)
        * @deprecated */
        outputPath?: string,
      })
    ]

    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. And if there's no author it will use the first in the contributors. To disable automatically retrieving metadata from package.json, simply set to null the properties you want to omit.

    Examples

    Basic

    const ViteFaviconsPlugin = require('vite-plugin-favicon')
    // or ESM
    import { ViteFaviconsPlugin } from "module";
    
    plugins: [
      ViteFaviconsPlugin({
        logo: './src/logo.png', // svg works too!
        favicons: {
          appName: 'my-app',
          appDescription: 'My awesome App',
          developerName: 'Me',
          developerURL: null, // prevent retrieving from the nearest package.json
          background: '#ddd',
          theme_color: '#333',
          icons: {
            coast: false,
            yandex: false
          }
        }
      })
    ]

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

    Handling Multiple HTML Files

    Vite calls the HTML transform hook for each HTML file template file you have configured in Vite, so this works automatically.

    Changelog

    Take a look at the CHANGELOG.md.

    Contribution

    You're free to contribute to this project by submitting issues and/or pull requests.

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

    License

    This project is licensed under MIT.

    Contributors

    Install

    npm i vite-plugin-favicon

    DownloadsWeekly Downloads

    888

    Version

    1.0.8

    License

    MIT

    Unpacked Size

    61.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • joshhemphill