Skip to content

sina-byn/svg-spritify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

svg-spritify NPM version NPM monthly downloads NPM total downloads

Creating SVG sprites has never been this easy. Easily generate sprites out of your SVG files.

SVG sprite generator CLI tool

Please consider following this project's author, Sina Bayandorian, and consider starring the project to show your ❤️ and support.

Note:

If you want granular control over the sprite generation process with a fully configurable setup, use version [email protected].
Versions starting from 2.0.0 are designed to be highly customizable via CSS, rather than relying on extensive configuration.

Install

Install with npm :

npm install -g svg-spritify

Usage

npx sprite
<svg width="20" height="20">
  <use href="/path/to/icons.svg#id" />
</svg>

<!-- change icon's size and color -->
<svg width="40" height="40" style="color: blue">
  <use href="/path/to/icons.svg#id" />
</svg>

Options

--no-recursive

By default, this package searches for SVG files in all subdirectories. Use the --no-recursive option to limit the search to the specified directory only.

npx sprite --no-recursive

-i, --input <directory>

Specifies the directory where the SVG files are located. Defaults to process.cwd().

npx sprite -i /path/to/svgs