Have ideas to improve npm?Join in the discussion! »

    gulp-svgicons2svgfont
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.0 • Public • Published

    gulp-svgicons2svgfont

    Create an SVG font from several SVG icons with Gulp.

    NPM version Build status Dependency Status devDependency Status Coverage Status Code Climate

    You can test this library with the frontend generator.

    Usage

    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(){
        svgicons2svgfont(['assets/icons/*.svg'], {
          fontName: 'myfont'
        })
        .on('glyphs', function(glyphs) {
          console.log(glyphs);
          // Here generate CSS/SCSS  for your glyphs ...
        })
        .pipe(gulp.dest('www/font/'));
    });

    Every icon must be prefixed with it's codepoint. The prependUnicode 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. Note this Gulp plugin is strictly equivalent to the above module CLI interface.

    API

    svgicons2svgfont(options)

    options.prependUnicode

    Type: Boolean Default value: false

    Allow to prepend unicode codepoints to icon file names in order to always keep the same codepoints accross each run.

    options.fileName

    Type: String Default value: options.fontName

    Allows to specify a fileName if needed it to be different from the fontName, eg. do not want to have spaces.

    options.startUnicode

    Type: integer Default value: 0xEA01

    Starting codepoint used for the generated glyphs. Defaults to a region within the Unicode private use area which is currently unused. See this blog post for further details and additional suggestions regarding accessibility of icon fonts.

    options.metadataProvider

    Type: Function Default value: require('svgicons2svgfont/src/metadata')(options)

    Allows to define your own logic to attach codepoints to input files.

    options.*

    The svgfont2svgicons options are also available:

    • options.fontName (required)
    • options.fileName
    • options.fontWeight
    • options.fontStyle
    • options.fixedWidth
    • options.centerHorizontally
    • options.normalize
    • options.fontHeight
    • options.round
    • options.descent
    • options.metadata
    • options.log

    Note

    You may look after a full Gulp web font workflow, see gulp-iconfont fot that matter.

    Stats

    NPM NPM

    Contributing

    Feel free to push your code if you agree with publishing under the MIT license.

    Install

    npm i gulp-svgicons2svgfont

    DownloadsWeekly Downloads

    29,128

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    102 kB

    Total Files

    59

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar