cmi

chrome-manifest-iconify

Takes a master icon and automatically generates icon set for your Chrome extension by parsing the v2 manifest

Showing:

Popularity

Downloads/wk

14

GitHub Stars

4

Maintenance

Last Commit

10mos ago

Contributors

1

Package

Dependencies

2

Size (min+gzip)

27.9KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

chrome-manifest-iconify

NPM version node Build Status Coverage Status dependencies Status devDependencies Status

When creating a Chrome extension, you need to provide a set of icons for context menus, browser actions, page actions, and the Chrome Web Store. Usually, these are just resized versions of the same image. The goal of chrome-manifest-iconify is to intelligently handle the tedious process of generated all these resized clones. All you need to do is provide it a master icon and v2 manifest file. It will parse the manifest to determine the sizes, names, types, and paths of the icons it needs to generate. You can choose from several resizing algorithms as provided by Sharp so your entire icon set looks awesome.

Installation

npm install --save-dev chrome-manifest-iconify

CLI

Options:
  --help             Show help                                         [boolean]
  --version          Show version number                               [boolean]
  -i, --master-icon  Path to the master icon                 [string] [required]
  -m, --manifest     Path to the v2 manifest.json
                                             [string] [default: "manifest.json"]
  -r, --resize-mode  Algorithm for resizing the master icon
     [choices: "nearest", "cubic", "mitchell", "lanczos2", "lanczos3"] [default:
                                                                     "lanczos3"]
  -o, --out-dir      Directory to write the icons                       [string]

Examples:
  chrome-manifest-iconify -i master.svg
  chrome-manifest-iconify -i master.jpg -m src/manifest.json -r nearest -o
  build/icons

Gulp

Instead of directly using this API, you might find it easier to use the Gulp plugin gulp-chrome-manifest-iconify for your project.

API

chrome-manifest-iconify

The chrome-manifest-iconify module

Example

const chromeManifestIconify = require('chrome-manifest-iconify');

const loadIcons = async () => {
  try {
    const icons = await chromeManifestIconify.async({
      manifest: 'src/manifest.json',
      masterIcon: 'img/test-icon.png'
    });

    // Do stuff with icons
    const buffers = await Promise.all(icons.map((i) => i.contents));

    console.log(buffers);
  } catch (err) {
    // Oh, no! Something bad happened
    console.error(err);
  }
};

chrome-manifest-iconify.async(options) ⇒ Promise.<Array.<module:chrome-manifest-iconify.Icon>>

Generates icon set for a Chrome extension by parsing the v2 manifest. Note that this function does not actually write the files.

Kind: static method of chrome-manifest-iconify
Returns: Promise.<Array.<module:chrome-manifest-iconify.Icon>> - A promise that resolves with the generated Icons

ParamTypeDescription
optionsobjectThe options for generating the Icons
options.manifeststringThe path to the v2 manifest.json
options.masterIconstring | BufferEither a path or Buffer of the master icon from which all the generated icons will be reseized
[options.outDir]stringBase directory of the generated Icons. Defaults to parent directory of manifest
[options.resizeMode]stringThe name of a Sharp kernel

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100