Generator a full pack of webfonts from SVG icons.
Features:
- Supported font formats: WOFF2, WOFF, EOT, TTF and SVG.
- Supported browsers: IE8+.
- Generates CSS files and HTML preview, allows to use custom templates.
npm install --save-dev svg-to-webfont
or
yarn add --save-dev svg-to-webfont
Add the svg-to-webfont
script to the pacakge.json file like the example below, make sure to create a config file and add the necessary files and set the relative path of the config file in the script with the -c
arg.
"scripts": {
"svg-to-webfont": "svg-to-webfont -c ./config.json"
},
example of the json config file:
// config.json
{
"dest": "dist",
"icons": "icons",
"fontName": "ircolor-icons",
"css": true,
"cssDest": "dist/css/ircolor-icons.css",
"cssFontsUrl": "../fonts/",
"types": [
"woff",
"woff2",
"ttf",
"eot"
],
"templateOptions": {
"classPrefix": "ir-",
"baseSelector": ".ir"
}
}
running the script form cli like this will run the package:
npm run svg-to-webfont
NOTE : if the pack is created successfully a success message is diplayed !
const { generateIconPackage } = require('svg-to-webfont')
const config = {
dest: "dist",
icons: "icons",
fontName: "ircolor-icons",
css: true,
cssDest: "dist/css/ircolor-icons.css",
cssFontsUrl: "../fonts/",
types: [
"woff",
"woff2",
"ttf",
"eot"
],
templateOptions: {
"classPrefix": "i-",
"baseSelector": ".i"
}
}
generateIconPackage(config)
required
Type: string
path to the folder where svg icons sit.
required
Type: string
Directory for generated font files.
Type: string
Default: 'iconfont'
Name of font and base name of font files.
Type: boolean
Default: true
Whether to generate CSS file.
Type: string
Default: path.join(options.dest, options.fontName + '.css')
Path for generated CSS file.
Type: string
Default: path of default CSS template
Path of custom CSS template. Generator uses handlebars templates.
Template receives options from options.templateOptions
along with the following options:
- fontName
- src
string
– Value of thesrc
property for@font-face
. - codepoints
object
– Codepoints of icons in hex format.
Paths of default templates are stored in the webfontsGenerator.templates
object.
-
webfontsGenerator.templates.css
– Default CSS template path.
It generates classes with names based on values fromoptions.templateOptions
. -
webfontsGenerator.templates.scss
– Default SCSS template path.
It generates mixinwebfont-icon
to add icon styles.
It is safe to use multiple generated files with mixins together.
Example of use:@import 'iconfont'; .icon { @include webfont-icon('icon'); }
Type: string
Default: options.destCss
Fonts path used in CSS file.
Type: boolean
Default: false
Whether to generate HTML preview.
Type: string
Default: path.join(options.dest, options.fontName + '.html')
Path for generated HTML file.
Type: string
Default: templates/html.hbs
HTML template path. Generator uses handlebars templates.
Template receives options from options.templateOptions
along with the following options:
- fontName
- styles
string
– Styles generated with default CSS template. (cssFontsPath
is chaged to relative path fromhtmlDest
todest
) - names
array.<string>
– Names of icons.
Type: object
Additional options for CSS & HTML templates, that extends default options.
Default options are:
{
classPrefix: 'icon-',
baseSelector: '.icon'
}
Type: array<string>
Default: ['woff2', 'woff', 'eot']
Font file types to generate.
Possible values: svg, ttf, woff, woff2, eot
.
Type: array<string>
Default: ['eot', 'woff2', 'woff', 'ttf', 'svg']
Order of src
values in font-face
in CSS file.
Type: function(string) -> string
Default: basename of file
Function that takes path of file and return name of icon.
Type: number
Default: 0xF101
Starting codepoint. Defaults to beginning of unicode private area.
Type: object
Specific codepoints for certain icons.
Icons without codepoints will have codepoints incremented from startCodepoint
skipping duplicates.
Options that are passed directly to svgicons2svgfont.
Type: object
Specific per format arbitrary options to pass to the generator
format and matching generator:
svg
- svgicons2svgfont.ttf
- svg2ttf.woff2
- ttf2woff2.woff
- ttf2woff.eot
- ttf2eot.
Type: boolean
Default: true
It is possible to not create files and get generated fonts in object
to write them to files later.
Also results object will have function generateCss([urls])
where urls
is an object with future fonts urls.
Public domain, see the LICENCE
file.