:status      
:integrations
:flair       

webpack loader and plugin for creating SVG sprites

• Configuration guide
• SVG icon system motivation

Install

1npm 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.
2. The imported SVGs are deduped, sorted, hashed and extracted by the webpack plugin.
3. 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

1const SVGSymbolSprite = require('svg-symbol-sprite-loader')
2const HtmlWebpackPlugin = require('html-webpack-plugin')
3
4module.exports = {
5
6  // ...
7
8  module: {
9    rules: [
10      {
11        // The loader transforms imported SVGs in JS objects of SVG data that
12        // can be used with any icon component
13        test: /\.svg$/,
14        use: [
15          {
16            loader: 'svg-symbol-sprite-loader',
17
18            // optional: Provide a function which returns a customized symbol ID.
19            // It receives the full file path as an argument
20            options: {
21              symbolId: filePath => `icon-${path.basename(filePath, '.svg')}`,
22            },
23          },
24        ],
25      },
26      // ...
27    ],
28  },
29    plugins: [
30      // The plugin will append a script with the sprite hash to head
31      // ⚠️ Order matters, the HTML plugin must be included before the SVG sprite
32      // plugin so that the HTML plugin hooks are registered!
33      new HtmlWebpackPlugin(),
34
35      // The plugin extracts the imported SVGs into a separate sprite file,
36      new new SVGSymbolSprite.Plugin({
37        filename: `icon-sprite${process.env.NODE_ENV === 'production' ? '.[chunkhash]' : ''}.svg`
38      }),
39    ],
40  }
41}

2. Fetch - application source

1import svgSymbolSpriteLoader from 'svg-symbol-sprite-loader'
2
3// Call the sprite loader to fetch and cache the latest SVG sprite.
4svgSymbolSpriteLoader({ useCache: process.env.NODE_ENV === 'production' })

3. Import - application source

1import iconOne from './media/icon-one.svg'
2
3  // ...
4export default () => (
5  <svg>
6    <use href={`#${iconOne.id}`}>
7  </svg>
8)

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 imports.
• 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:

• Review the repo Code of Conduct, it is not just for show!
• Review the Contributing Guide for a helpful code overview and repository pull request process details.

Thank You 🙏