svg-symbol-sprite-loader

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

plugin.

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.

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 () => (
  <svg>
    <use href={`#${iconOne.id}`}>
  </svg>
)

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

• Load sprites from CDN locations without the CORS issues of relative SVG

• Symbol sprites are very effective for creating an icon system. They allows

Contributing 😃

• Review the repo Code of Conductconduct, it is not just for show!
• Review the Contributing Guidecontributing for a helpful code overview and

Thank You 🙏

Repo icon made by
<a href="https://www.flaticon.com/authors/smartline" title="Smartline">Smartline
</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com
</a> is licensed by
<a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">
CC 3.0 BY</a>