inline-svg plugin for gulp
This plugin takes a couple of SVG files and provides them inside a Sass mixin as inlined background-images. By doing so, you can use them without having to touch your markup.
The inlined SVG gets URL encoded, so it's safe to use starting with IE9.
The generated mixin contains width and height values for each SVG. Those values are taken from the width and height attribute inside the SVG. If it does not provide them, they will be set to 0px. You can still overwrite them in your CSS.
gulp-inline-svg as a development dependency:
npm install --save-dev gulp-inline-svg
Then, add it to your
gulpfile.js. I'd recommend to use it in conjunction with gulp-svgmin to clean the SVG before inlining them.
var inlineSvg =svgMin = ;gulp;
This will create a _svg.scss file inside your 'sass' folder.
Usage inside you Sass code
The _svg.scss file will provide you with the following mixins and functions:
If you want to customize the default configuration, you can pass an options object to the task function:
Specifies the name of the generated file.
The plugin will generate an .scss-file by default, but you can easily adopt this for other languages, by using your own template. With this option, you can specify the path to a mustache template.
You can use the default template as a blueprint to create your own. And please don't hesitate to share your template if you create one for an additional language.