npm.io
0.6.0 • Published 3 years agoCLI

svg-fab

Licence
MIT
Version
0.6.0
Deps
5
Size
7 kB
Vulns
7
Weekly
0

svg-fab

This utility will convert a Sketch-exported SVG into a <symbol> element suitable for use as an icon.

Usage

The source SVG must be composed of a single path - use the "Layer > Convert to Outlines" command in Sketch.

Once you have your SVG, install the utility:

npm install -g svg-fab

Then, specify a name for the symbol and the path to the SVG like so:

svg-fab -n expand my-expand-icon.svg

The utility prints its output to stdout. You can copy and paste the <symbol> element it generates into your sprite sheet.

The name argument is automatically slugified - wrap it in double quotes if it contains spaces. For example:

svg-fab -n "my extremely long, convoluted, and entirely unfriendly icon name" my-icon.svg

In this example the exported <symbol> will have an id attribute of icon-my-extremely-long-convoluted-and-entirely-unfriendly-icon-name.

Keywords