svgicons2svgfont
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
var svgicons2svgfont = require('svgicons2svgfont');
var fs = require('fs');
var fontStream = svgicons2svgfont({
fontName: 'hello'
});
fontStream.pipe(fs.createWriteStream('fonts/hello.svg'))
.on('finish',function() {
console.log('Font successfully created!')
})
.on('error',function(err) {
console.log(err);
});
var glyph1 = fs.createReadStream('icons/icon1.svg');
glyph1.metadata = {
unicode: '\uE001\uE002',
name: 'icon1'
};
fontStream.write(glyph);
var glyph2 = fs.createReadStream('icons/icon1.svg');
glyph2.metadata = {
unicode: ['\uE002', '\uEA02'],
name: 'icon2'
};
fontStream.write(glyph2);
var glyph3 = fs.createReadStream('icons/icon1.svg');
glyph3.metadata = {
unicode: '\uE001\uE002',
name: 'icon1-icon2'
};
fontStream.write(glyph3);
fontStream.end();
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,uEOO1uEOO2', note that the last
string is in fact a ligature).
API
svgicons2svgfont(options)
options.fontName
Type: String
Default value: 'iconfont'
The font family name you want.
options.fixedWidth
Type: Boolean
Default value: false
Creates a monospace font of the width of the largest input icon.
options.centerHorizontally
Type: Boolean
Default value: false
Calculate the bounds of a glyph and center it horizontally.
Warning: The bounds calculation is currently a naive implementation that
may not work for some icons. We need to create a svg-pathdata-draw module on
top of svg-pathdata to get the real bounds of the icon. It's on the bottom
of my to do, but feel free to work on it. Discuss it in the
related issue.
options.normalize
Type: Boolean
Default value: false
Normalize icons by scaling them to the height of the highest icon.
options.fontHeight
Type: Number
Default value: MAX(icons.height)
The outputted font height (defaults to the height of the highest input icon).
options.round
Type: Number
Default value: 10e12
Setup SVG path rounding.
options.descent
Type: Number
Default value: 0
The font descent. It is usefull to fix the font baseline yourself.
Warning: The descent is a positive value!
The ascent formula is: ascent = fontHeight - descent.
options.log
Type: Function
Default value: false
Allows you to provide your own logging function. Set to function(){}
to
impeach logging.
options.error
Type: Function
Default value: false
Allows you to provide your own error logging function. Set to function(){}
to
impeach logging.
Build systems
Grunt plugins
grunt-svgicons2svgfont
and grunt-webfont.
Gulp plugins
Try gulp-iconfont and
gulp-svgicons2svgfont.
### Stylus plugin
Use stylus-iconfont.
### Mimosa plugin
Use mimosa-svgs-to-iconfonts.
## CLI alternatives
You can combine this plugin's CLI interface with
svg2ttf,
ttf2eot,
ttf2woff
and ttf2woff2.
You can also use webfonts-generator.
Stats
Contributing
Feel free to push your code if you agree with publishing under the MIT license.