Create an SVG font from several SVG icons with Gulp.
You can test this library with the frontend generator.
First, install gulp-svgicons2svgfont
as a development dependency:
npm install --save-dev gulp-svgicons2svgfont
Then, add it to your gulpfile.js
:
var svgicons2svgfont = require('gulp-svgicons2svgfont');
gulp.task('Iconfont', function(){
gulp.src(['assets/icons/*.svg'])
.pipe(svgicons2svgfont({
fontName: 'myfont'
}))
.on('codepoints', function(codepoints) {
console.log(codepoints);
// Here generate CSS/SCSS for your codepoints ...
})
.pipe(gulp.dest('www/font/'));
});
Every icon must be prefixed with it's codepoint. The appendCodepoints
option
allows to do it automatically. Then, in your own CSS, you just have to use
the corresponding codepoint to display your icon. See this
sample less mixin
for a real world usage.
The plugin stream emits a codepoints
event letting you do whatever you want
with them.
Please report icons to font issues to the svgicons2svgfont repository on wich this plugin depends.
Type: Boolean
Default value: false
Set to true to also convert read icons that doesn't have the .svg extension.
A string value that is used to name your font-family (required).
Type: Boolean
Default value: false
Allow to append codepoints to icon files in order to always keep the same codepoints.
Type: integer
Default value: 0xE001
Starting codepoint used for the generated glyphs. Defaults to the start of the Unicode private use area.
The svgfont2svgicons options are also available:
- options.fontName
- options.fixedWidth
- options.centerHorizontally
- options.normalize
- options.fontHeight
- options.descent
- options.log
Feel free to push your code if you agree with publishing under the MIT license.