svgicons2svgfont

v15.0.0

Published

2 months ago

Read a set of SVG icons and output a SVG font

Downloads

881,082

0High
0Medium
0Low

SVG icons font creation fonts

svgicons2svgfont

Read a set of SVG icons and output a SVG font

svgicons2svgfont is a simple tool to merge multiple icons to an SVG font.

'rect', 'line', 'circle', 'ellipsis', 'polyline' and 'polygon' shapes will be converted to pathes. Multiple pathes will be merged.

Transform attributes support is currenly experimental, report issues if any.

You can test this library with the frontend generator.

You may want to convert fonts to icons, if so use svgfont2svgicons.

Usage

In your scripts

import { SVGIcons2SVGFontStream } from 'svgicons2svgfont';
import { createReadStream, createWriteStream } from 'node:fs';

const fontStream = new SVGIcons2SVGFontStream({
  fontName: 'hello',
});

// Setting the font destination
fontStream
  .pipe(createWriteStream('fonts/hello.svg'))
  .on('finish', function () {
    console.log('Font successfully created!');
  })
  .on('error', function (err) {
    console.log(err);
  });

// Writing glyphs
const glyph1 = createReadStream('icons/icon1.svg');
glyph1.metadata = {
  unicode: ['\uE001\uE002'],
  name: 'icon1',
};
fontStream.write(glyph1);

// Multiple unicode values are possible
const glyph2 = createReadStream('icons/icon1.svg');
glyph2.metadata = {
  unicode: ['\uE002', '\uEA02'],
  name: 'icon2',
};
fontStream.write(glyph2);

// Either ligatures are available
const glyph3 = createReadStream('icons/icon1.svg');
glyph3.metadata = {
  unicode: ['\uE001\uE002'],
  name: 'icon1-icon2',
};
fontStream.write(glyph3);

// Do not forget to end the stream
fontStream.end();

Debugging

To debug, simply use the following env var: DEBUG=svgicons2svgfont.

CLI interface

All options are available except the log one by using this pattern: --{LOWER_CASE(optionName)}={optionValue}.

svgicons2svgfont --fontName=hello -o font/destination/file.svg icons/directory/*.svg

Note that you won't be able to customize icon names or icons unicodes by passing options but by using the following convention to name your icons files: ${icon.unicode}-${icon.name}.svg where icon.unicode is a comma separated list of unicode strings (ex: 'uEA01,uE001,uE001uE002', note that the last string is in fact a ligature).

There is a few more options for the CLI interface, you can list all of them:

npx svgicons2svgfont --help

Gives:

Usage: svgicons2svgfont [options] <icons ...>

Options:
  -V, --version               output the version number
  -v, --verbose               tell me everything!
  -o, --output [/dev/stdout]  file to write output to
  -f, --fontName [value]      the font family name you want [iconfont]
  -i, --fontId [value]        the font id you want [fontName]
  -st, --style [value]        the font style you want
  -we, --weight [value]       the font weight you want
  -w, --fixedWidth            creates a monospace font of the width of the largest input icon
  -c, --centerHorizontally    calculate the bounds of a glyph and center it horizontally
  -y, --centerVertically      centers the glyphs vertically in the generated font.
  -n, --normalize             normalize icons by scaling them to the height of the highest icon
  -p, --preserveAspectRatio   used with normalize to scale down glyph if the SVG width is greater than the height
  -h, --height [value]        the output font height [MAX(icons.height)] (icons will be scaled so the highest has
                              this height)
  -r, --round [value]         setup the SVG path rounding [10e12]
  -d, --descent [value]       the font descent [0]
  -a, --ascent [value]        the font ascent [height - descent]
  -s, --startUnicode [value]  the start unicode code point for unprefixed files [0xEA01]
  -u, --prependUnicode        prefix files with their automatically allocated unicode code point
  -m, --metadata              content of the metadata tag
  --help                      display help for command

API

new SVGIcons2SVGFontStream(options)

options.fontName

Type: String Default value: 'iconfont'

The font family name you want.

options.fontId

Type: String Default value: the options.fontName value

The font id you want.

options.fontStyle

Type: String Default value: ''

The font style you want.