https://github.com/jofunliang/gulp-svg-symbols2js

Inject SVG Symbols into JavaScript
https://github.com/jofunliang/gulp-svg-symbols2js

gulp-plugin svg-sprites svg-symbol

Last synced: about 2 months ago
JSON representation

Inject SVG Symbols into JavaScript

• Host: GitHub
• URL: https://github.com/jofunliang/gulp-svg-symbols2js
• Owner: JofunLiang
• License: mit
• Created: 2019-06-24T13:38:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T09:22:56.000Z (about 5 years ago)
• Last Synced: 2025-08-09T07:35:51.722Z (2 months ago)
• Topics: gulp-plugin, svg-sprites, svg-symbol
• Language: JavaScript
• Size: 23.4 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# gulp-svg-symbols2js

The plugin inject SVG Symbols files into JavaScript, Works with [gulp-svg-symbols](https://www.npmjs.com/package/gulp-svg-symbols).

![npm](https://img.shields.io/npm/v/gulp-svg-symbols2js.svg)

![npm](https://img.shields.io/npm/dm/gulp-svg-symbols2js.svg)

![NPM](https://img.shields.io/npm/l/gulp-svg-symbols2js.svg)

[中文文档](docs-zh.md)

# Usage

Install gulp-svg-symbols2js as a development dependency:

```

npm install --save-dev gulp-svg-symbols2js

```

Next, add it to one of the streams in your gulpfile.js:

```js

var gulp = require('gulp');

var svgSymbols = require('gulp-svg-symbols');

var svgSymbols2js = require('gulp-svg-symbols2js');

gulp.task("default", function(){

  gulp.src("src/icons/**/*.svg")

    .pipe(svgSymbols())

    .pipe(svgSymbols2js())

    .pipe(gulp.dest("dist/icons"));

})

```

This will change the SVG Symbols files into JavaScript. If you want to do compression, you need to install [gulp-uglify](https://www.npmjs.com/package/gulp-uglify):

```js

var gulp = require('gulp');

var svgSymbols = require('gulp-svg-symbols');

var svgSymbols2js = require('gulp-svg-symbols2js');

var uglify = require('gulp-uglify');

gulp.task("default", function(){

  gulp.src("src/icons/**/*.svg")

    .pipe(svgSymbols())

    .pipe(svgSymbols2js())

    .pipe(uglify())

    .pipe(gulp.dest("dist/icons"));

})

```

# License

This software is released under an [MIT Licence](./LICENSE.md) with an additional non-advertising clause.