Wondering what’s next for npm?Check out our public roadmap! »

    favicons
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/favicons package

    6.2.2 • Public • Published

    Favicons

    NPM version Build Status Coverage Status Dependencies Status DevDependencies Status Greenkeeper badge

    A Node.js module for generating favicons and their associated files. Originally built for Google's Web Starter Kit and Catalyst. Requires Node 4+. Installed through NPM with:

    npm install favicons
    

    Usage

    Node.js

    To use Favicons, require the appropriate module and call it, optionally specifying configuration and callback objects. A sample is shown on the right. The full list of options can be found on GitHub.

    The Gulp / Grunt wrapper modules have a few extra properties. You can also configure and use Favicons from the terminal with dot syntax.

    Favicons generates its icons locally using pure Javascript with no external dependencies.

    Please note: Favicons is tested on Node 10.13 and above.

    var favicons = require("favicons"),
      source = "test/logo.png", // Source image(s). `string`, `buffer` or array of `string`
      configuration = {
        path: "/", // Path for overriding default icons path. `string`
        appName: null, // Your application's name. `string`
        appShortName: null, // Your application's short_name. `string`. Optional. If not set, appName will be used
        appDescription: null, // Your application's description. `string`
        developerName: null, // Your (or your developer's) name. `string`
        developerURL: null, // Your (or your developer's) URL. `string`
        dir: "auto", // Primary text direction for name, short_name, and description
        lang: "en-US", // Primary language for name and short_name
        background: "#fff", // Background colour for flattened icons. `string`
        theme_color: "#fff", // Theme color user for example in Android's task switcher. `string`
        appleStatusBarStyle: "black-translucent", // Style for Apple status bar: "black-translucent", "default", "black". `string`
        display: "standalone", // Preferred display mode: "fullscreen", "standalone", "minimal-ui" or "browser". `string`
        orientation: "any", // Default orientation: "any", "natural", "portrait" or "landscape". `string`
        scope: "/", // set of URLs that the browser considers within your app
        start_url: "/?homescreen=1", // Start URL when launching the application from a device. `string`
        version: "1.0", // Your application's version string. `string`
        logging: false, // Print logs to console? `boolean`
        pixel_art: false, // Keeps pixels "sharp" when scaling up, for pixel art.  Only supported in offline mode.
        loadManifestWithCredentials: false, // Browsers don't send cookies when fetching a manifest, enable this to fix that. `boolean`
        icons: {
          // Platform Options:
          // - offset - offset in percentage
          // - background:
          //   * false - use default
          //   * true - force use default, e.g. set background for Android icons
          //   * color - set background for the specified icons
          //   * mask - apply mask in order to create circle icon (applied by default for firefox). `boolean`
          //   * overlayGlow - apply glow effect after mask has been applied (applied by default for firefox). `boolean`
          //   * overlayShadow - apply drop shadow after mask has been applied .`boolean`
          //
          android: true, // Create Android homescreen icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          appleIcon: true, // Create Apple touch icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          appleStartup: true, // Create Apple startup images. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          coast: true, // Create Opera Coast icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          favicons: true, // Create regular favicons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          firefox: true, // Create Firefox OS icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          windows: true, // Create Windows 8 tile icons. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
          yandex: true, // Create Yandex browser icon. `boolean` or `{ offset, background, mask, overlayGlow, overlayShadow }` or an array of sources
        },
      },
      callback = function (error, response) {
        if (error) {
          console.log(error.message); // Error description e.g. "An unknown error has occurred"
          return;
        }
        console.log(response.images); // Array of { name: string, contents: <buffer> }
        console.log(response.files); // Array of { name: string, contents: <string> }
        console.log(response.html); // Array of strings (html elements)
      };
    
    favicons(source, configuration, callback);

    The default sources are as follow (groupped by platform):

    {
      "android": [
        "android-chrome-144x144.png",
        "android-chrome-192x192.png",
        "android-chrome-256x256.png",
        "android-chrome-36x36.png",
        "android-chrome-384x384.png",
        "android-chrome-48x48.png",
        "android-chrome-512x512.png",
        "android-chrome-72x72.png",
        "android-chrome-96x96.png"
      ],
      "appleIcon": [
        "apple-touch-icon-1024x1024.png",
        "apple-touch-icon-114x114.png",
        "apple-touch-icon-120x120.png",
        "apple-touch-icon-144x144.png",
        "apple-touch-icon-152x152.png",
        "apple-touch-icon-167x167.png",
        "apple-touch-icon-180x180.png",
        "apple-touch-icon-57x57.png",
        "apple-touch-icon-60x60.png",
        "apple-touch-icon-72x72.png",
        "apple-touch-icon-76x76.png",
        "apple-touch-icon-precomposed.png",
        "apple-touch-icon.png"
      ],
      "appleStartup": [
        "apple-touch-startup-image-1125x2436.png",
        "apple-touch-startup-image-1136x640.png",
        "apple-touch-startup-image-1242x2208.png",
        "apple-touch-startup-image-1242x2688.png",
        "apple-touch-startup-image-1334x750.png",
        "apple-touch-startup-image-1536x2048.png",
        "apple-touch-startup-image-1620x2160.png",
        "apple-touch-startup-image-1668x2224.png",
        "apple-touch-startup-image-1668x2388.png",
        "apple-touch-startup-image-1792x828.png",
        "apple-touch-startup-image-2048x1536.png",
        "apple-touch-startup-image-2048x2732.png",
        "apple-touch-startup-image-2160x1620.png",
        "apple-touch-startup-image-2208x1242.png",
        "apple-touch-startup-image-2224x1668.png",
        "apple-touch-startup-image-2388x1668.png",
        "apple-touch-startup-image-2436x1125.png",
        "apple-touch-startup-image-2688x1242.png",
        "apple-touch-startup-image-2732x2048.png",
        "apple-touch-startup-image-640x1136.png",
        "apple-touch-startup-image-750x1334.png",
        "apple-touch-startup-image-828x1792.png"
      ],
      "coast": [
        "coast-228x228.png"
      ],
      "favicons": [
        "favicon-16x16.png",
        "favicon-32x32.png",
        "favicon-48x48.png",
        "favicon.ico"
      ],
      "firefox": [
        "firefox_app_128x128.png",
        "firefox_app_512x512.png",
        "firefox_app_60x60.png"
      ],
      "windows": [
        "mstile-144x144.png",
        "mstile-150x150.png",
        "mstile-310x150.png",
        "mstile-310x310.png",
        "mstile-70x70.png"
      ],
      "yandex": [
        "yandex-browser-50x50.png"
      ]
    }

    You can programmatically access Favicons configuration (icon filenames, HTML, manifest files, etc) with:

    var config = require("favicons").config;

    Gulp

    To use Favicons with Gulp, you can either use the gulp-plugin or call it manually as follows:

    var favicons = require("favicons").stream,
      log = require("fancy-log");
    
    gulp.task("default", function () {
      return gulp
        .src("logo.png")
        .pipe(
          favicons({
            appName: "My App",
            appShortName: "App",
            appDescription: "This is my application",
            developerName: "Hayden Bleasel",
            developerURL: "http://haydenbleasel.com/",
            background: "#020307",
            path: "favicons/",
            url: "http://haydenbleasel.com/",
            display: "standalone",
            orientation: "portrait",
            scope: "/",
            start_url: "/?homescreen=1",
            version: 1.0,
            logging: false,
            html: "index.html",
            pipeHTML: true,
            replace: true,
          })
        )
        .on("error", log)
        .pipe(gulp.dest("./"));
    });

    Output

    For the full list of files, check config/files.json. For the full HTML code, check config/html.js. Finally, for the full list of icons, check config/icons.json.

    Questions

    Why are you missing certain favicons?

    Because pure Javascript modules aren't available at the moment. For example, the El Capitan SVG favicon and the Windows tile silhouette ability both require SVG support. If modules for these task begin to appear, please jump on the appropriate issue and we'll get on it ASAP.

    Thank you

    Contribution

    Feel free to push your code if you agree with publishing under the MIT license.

    When testing, don't forget to update snapshots whenever you edit them: ava --update-snapshots.

    License

    Install

    npm i favicons

    DownloadsWeekly Downloads

    117,174

    Version

    6.2.2

    License

    MIT

    Unpacked Size

    188 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar
    • avatar