grunt-svg-symbols
Generate an SVG icon system (based on
<symbol>
) of a specified folder
Getting Started
This plugin requires Grunt >=0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-svg-symbols --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "svg_symbols" task
Overview
In your project's Gruntfile, add a section named svg_symbols
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.precision
Type: Number
Default value: 1
Specify the float precision used while optimizing.
options.currentColor
Type: Boolean
Default value: false
Sets the value of all fill
and stroke
attributes to currentColor
.
options.className
Type: String
Default value: u-hidden
Specify your display: none;
utility class.
options.removeAttrs
Type: String
Default value: null
Remove attributes by providing a regular expression pattern.
options.width
Type: Number
Default value: null
Define the width of the viewbox for all symbols (only necessary when the detection fails).
options.height
Type: Number
Default value: null
Define the height of the viewbox for all symbols (only necessary when the detection fails).
options.preserveViewBox
Type: Boolean
Default value: false
Use viewBox
defined on SVG and ignore width and height options.
Examples
Usage Example
grunt;
Output Example