Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

gulp-svg-icons

0.6.1 • Public • Published

gulp-svg-icons Build Status NPM version Dependency Status

Inserting SVG icons was never so easy.

Install

npm install gulp-svg-icons

Usage

In your HTML sources just add icons like:

<icon-trophy class="red">

and it will be replaced by:

<svg class="icon red"><use xlink:href="#icon-trophy"></use></svg>

where "trophy" is the name of the icon's file (path/to/the/icons/trophy.svg); and use the placeholder where you want the symbol definitions (in the index.html for example, in case that you are building a SPA):

<!-- icons -->

and then invoke it through gulp:

var gulp  = require('gulp');
var Icons = require('gulp-svg-icons');
 
var icons = new Icons('src/icons');
 
gulp.task('replace', function() {
 
    var htmls = path.join(fixtures, 'html', '**', '*.html');
 
    return gulp
            .src('src/html/*.html')
            .pipe(icons.replace())
            .pipe(gulp.dest('web'));
});
 
gulp.task('default', ['replace'], function() {
 
    return gulp
            .src('web/index.html')
            .pipe(icons.inject())
            .pipe(gulp.dest('web'));
});

Options

prefix

An string to use on every icon id (concatenated using "-") or a falsy value (false, null...) to avoid prefixes.

placeholder

An string to be replaced with the icons definitions. The default is <!-- icons -->.

style

A function which will receive every icon name and should return the desired CSS class name. The default will return just icon.

injectOnlyUsedIcons

A boolean to indicate if you want to inject only the icons found in the replace process or all the SVG files in the icon's dir. Default is true

external

A function which will receive every icon name and should return the desired path to the icons defs, useful to keep those in an external file (and share them between documents, see this). The default will return just an empty string, meaning that the icons are supposed to be defined in the same document.

install

npm i gulp-svg-icons

Downloadsweekly downloads

7

version

0.6.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability