@greenek/grunt-svg-symbols v1.0.0

@greenek/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 @greenek/grunt-svg-symbols --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('@greenek/grunt-svg-symbols');

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.initConfig({
  svg_symbols: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

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.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.

options.svgoOptions

Type: Object Default value: { floatPrecision: 1 }

Examples

Usage Example

grunt.initConfig({
  svg_symbols: {
    options: {
      svgoOptions: {
        floatPrecision: 3
      }
    },
    your_target: {
      files: {
        'icons.svg': ['**/*.svg']
      },
    },
  },
});

Output Example

<svg class="u-hidden">
  <symbol id="mail" viewBox="0 0 80 80">
    <path d="M77.766 17.152l-25.115 21.1 25.09 23.665c.17-.462.266-.94.266..."/>
  </symbol>
  <symbol id="lock" viewBox="0 0 80 80">
    <path d="M61.05 35.833V23.82C61.05 13.01 52.04 4 41.23 4h-.6-.602c-1..."/>
  </symbol>
</svg>

<svg>
  <use xlink:href="#mail"></use>
</svg>