Loader and plugin for generating an SVG symbol sprite

Downloads in past


5.1.03 years ago6 years agoMinified + gzip package size for svg-symbol-sprite-loader in KB


<img height=75 src="./docs/assets/readme-header.png" alt="Crystal Ball Projects documentation"/>

<img src="" alt="Package version" valign="text-top"/>
<img src="" alt="NPM downloads" valign="text-top" />
<img src="" alt="Build status" valign="text-top">
<img src="" alt="Known vulnerabilities" valign="text-top" />
<img src="" alt="Test coverage" valign="text-top" />
<img src="" alt="Maintainability" valign="text-top" />

<img src="" alt="Renovate" valign="text-top" />
<img src="" alt="Commitizen friendly" valign="text-top" />
<img src="" alt="ZenHub" valign="text-top" />
<img src="" alt="Semantic Release" valign="text-top"/>
<img src="" alt="Contributor Covenant" valign="text-top" />

<img src="" alt="Contains magic" valign="text-top" />
<img src="" alt="Full of love" valign="text-top" />

<em>webpack loader and plugin for creating SVG sprites</em>


npm install svg-symbol-sprite-loader

Configuration guide

The ultimate SVG icon system follows this workflow:
  1. SVGs are imported into your application using the webpack loader, they can
be referenced by their ID.
  1. The imported SVGs are deduped, sorted, hashed and extracted by the webpack
  1. The package exports a localStorage cache loader for browser bundles that
will import the emitted sprite. If the sprite contents change, the filename
hash will change and the sprite loader will fetch the latest sprite.
ℹ️ See the test application for a complete application example

1. Configure - webpack.config.js

const SVGSymbolSprite = require('svg-symbol-sprite-loader')
const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {

  // ...

  module: {
    rules: [
        // The loader transforms imported SVGs in JS objects of SVG data that
        // can be used with any icon component
        test: /\.svg$/,
        use: [
            loader: 'svg-symbol-sprite-loader',

            // optional: Provide a function which returns a customized symbol ID.
            // It receives the full file path as an argument
            options: {
              symbolId: filePath => `icon-${path.basename(filePath, '.svg')}`,
      // ...
    plugins: [
      // The plugin will append a script with the sprite hash to head
      // ⚠️ Order matters, the HTML plugin must be included before the SVG sprite
      // plugin so that the HTML plugin hooks are registered!
      new HtmlWebpackPlugin(),

      // The plugin extracts the imported SVGs into a separate sprite file,
      new new SVGSymbolSprite.Plugin({
        filename: `icon-sprite${process.env.NODE_ENV === 'production' ? '.[chunkhash]' : ''}.svg`

2. Fetch - application source

import svgSymbolSpriteLoader from 'svg-symbol-sprite-loader'

// Call the sprite loader to fetch and cache the latest SVG sprite.
svgSymbolSpriteLoader({ useCache: process.env.NODE_ENV === 'production' })

3. Import - application source

import iconOne from './media/icon-one.svg'

  // ...
export default () => (
    <use href={`#${}`}>

SVG icon system motivation

  • Sprite only the SVG icons imported into your application.
  • Use local storage to cache sprites by content hash and only fetch a sprite
when its content has changed.
  • Load sprites from CDN locations without the CORS issues of relative SVG
  • Symbol sprites are very effective for creating an icon system. They allows
svgs to be referenced by id, and don't require including viewbox attributes.

Contributing 😃

All contributions are greatly appreciated 👍🎉. To contribute please:
repository pull request process details.

Thank You 🙏

Repo icon made by
<a href="" title="Smartline">Smartline
</a> from <a href="" title="Flaticon">
</a> is licensed by
<a href="" title="Creative Commons BY 3.0" target="_blank">
CC 3.0 BY</a>