Collect SVGs into multiple fonts and a character code mapping
Install the module with: npm install fontsmith
var fontsmith = require('fontsmith');
fontsmith({src: ['paths', 'to', 'svgs']}, function (err, res) {
res.map; // Map of file name to unicode value for character
res.fonts; // Object containing binary string representations of fonts (e.g. {svg, ttf, woff, eot})
});
Currently, there is only the icomoon-phantomjs engine.
This requires installing phantomjs and having it accessible from your path (i.e. phantomjs --version
will work).
fontsmith
provides a single function as its export.
/**
* Function which eats SVGs and outputs fonts and a mapping from file names to unicode values
* @param {Object} params Object containing all parameters for fontsmith
* @param {String[]} params.src Array of paths to SVGs to compile
* @param {Function} cb Error-first function to callback with composition results
*/
Below is taken from the test
folder
var files = [
'test_files/eye.svg',
'test_files/moon.svg',
'test_files/building_block.svg'
],
params = {src: this.files};
fontsmith(params, function (err, res) {
err; // Any errors that might have popped up
res.map; // Map of file name to unicode value for character
res.fonts; // Object containing binary string representations of fonts (e.g. {svg, ttf, woff, eot})
});
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint using grunt and test via npm test
.
Building Block designed by Michael Rowe from The Noun Project
Eye designed by Dmitry Baranovskiy from The Noun Project
Moon designed by P.J. Onori from The Noun Project
Support this project and others by twolfson via gittip.
Copyright (c) 2013 Todd Wolfson
Licensed under the MIT license.