icon-gen

npm-icon-gen

Generate an icon files from the SVG or PNG files.

Node.js requirements

This module depends on svg2png. Therefore we need Node v6 or later. The following is a quotation from README of svg2png.

svg2png uses the latest in ES2015 features, and as such requires a recent version of Node.js. Only the 6.x series onward is supported.

Support formats

Supported the output format of the icon are following.

Platform	Icon
Windows	app.ico or specified name.
macOS	app.icns or specified name.
Favicon	favicon.ico and favicon-XX.png.

Installation

$ npm install icon-gen

Usage

SVG

SVG files are rendering to PNG file in svg2png. Rendering files is output to a temporary directory of the each OS.

Rendering of svg2png is run by phantomjs. Please use the PNG directory If the rendering quality there is a problem.

const icongen = require('icon-gen');

const options = {
  report: true
};

icongen('./sample.svg', './dist', options)
.then((results) => {
  console.log(results)
})
.catch((err) => {
  console.error(err)
});

PNG

Generate an icon files from the directory of PNG files.

const icongen = require('icon-gen');

const options = {
  type: 'png',
  report: true
};

icongen('./images', './dist', options)
.then((results) => {
  console.log(results);
} )
.catch((err) => {
  console.error(err);
});

Required PNG files is below. Favicon outputs both the ICO and PNG files ( see: audreyr/favicon-cheat-sheet ).

Name	Size	ICO	ICNS	Fav ICO	Fav PNG
16.png	16x16	✔	✔	✔
24.png	24x24	✔		✔
32.png	32x32	✔	✔	✔	✔
48.png	48x48	✔		✔
57.png	57x57				✔
64.png	64x64	✔	✔	✔
72.png	72x72				✔
96.png	96x96				✔
120.png	120x120				✔
128.png	128x128	✔	✔		✔
144.png	144x144				✔
152.png	152x152				✔
195.png	195x195				✔
228.png	228x228				✔
256.png	256x256	✔	✔
512.png	512x512		✔
1024.png	1024x1024		✔

Node API

icongen

icongen is promisify function.

icongen(src, dest[, options])

Name	Type	Description
src	String	Path of the SVG file or PNG files directory that becomes the source.
dest	String	Destination directory path.
options	Object	Options.

options:

Name	Type	Description
type	String	Type of input file. Allowed value is a svg or png. 'svg' is SVG file, png is PNG files directory. Default is svg.
modes	Array	Mode of output files. Allow value is a ico, icns, favicon and all. Default is all.
names	Object	Change an output file names for ICO and ICNS.
report	Boolean	Display the process reports. Default is false, disable a report.
sizes	Object	List of sizes to include for ICO and ICNS.

names:

Use this property is specified without an extension. Default name is the app.

Name	Type	Description
ico	String	Name of the ico file.
icns	String	Name of the icns file.

sizes:

Use this property is specified without an extension. Default name is the app.

Name	Type	Description
ico	Array	List of sizes for the ico file.
icns	Array	List of sizes for the icns file.

CLI

Usage: icon-gen [OPTIONS]

  Generate an icon from the SVG or PNG file.

  Options:
    -h, --help    Display this text.

    -v, --version Display the version number.

    -i, --input   Path of the SVG file or PNG file directory.

    -o, --output  Path of the output directory.

    -t, --type    Type of the input file.
                  'svg' is the SVG file, 'png' is the PNG files directory.
                  Allowed values: svg, png
                  Default is 'svg'.

    -m, --modes   Mode of the output files.
                  Allowed values: ico, icns, favicon, all
                  Default is 'all'.

    -n, --names   Change an output file names for ICO and ICNS.
                  ex: 'ico=foo,icns=bar'
                  Default is 'app.ico' and 'app.ico'.

    -r, --report  Display the process reports.
                  Default is disable.

    -s, --sizes   List of sizes to include for ICO and ICNS.
                  ex: 'ico=[12,24,32],icns=[12,24,64]'

  Examples:
    $ icon-gen -i sample.svg -o ./dist -r
    $ icon-gen -i ./images -o ./dist -t png -r
    $ icon-gen -i sample.svg -o ./dist -m ico,favicon -r
    $ icon-gen -i sample.svg -o ./dist -n ico=foo,icns=bar

  See also:
    https://github.com/akabekobeko/npm-icon-gen

ChangeLog

• CHANGELOG

License

• MIT