Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-ball/svg-symbol-sprite-loader
Loader and plugin for generating an SVG symbol sprite
https://github.com/crystal-ball/svg-symbol-sprite-loader
loader plugin sprites svg-icons webpack
Last synced: about 2 months ago
JSON representation
Loader and plugin for generating an SVG symbol sprite
- Host: GitHub
- URL: https://github.com/crystal-ball/svg-symbol-sprite-loader
- Owner: crystal-ball
- License: isc
- Created: 2017-12-10T23:23:27.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-29T23:12:25.000Z (about 1 year ago)
- Last Synced: 2024-11-07T12:16:00.893Z (2 months ago)
- Topics: loader, plugin, sprites, svg-icons, webpack
- Language: JavaScript
- Size: 492 KB
- Stars: 19
- Watchers: 4
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
:status
:integrations
:flair
webpack loader and plugin for creating SVG sprites
- [Configuration guide](#complete)
- [SVG icon system motivation](#system)
---
## Install
```sh
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
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.
_ℹ️ See the [test application](./test-app) for a complete application example_
1. Configure - webpack.config.js
```javascript
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
```javascript
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
```javascript
import iconOne from './media/icon-one.svg'
// ...
export default () => (
)
```
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][conduct], it is **not** just for show!
- Review the [Contributing Guide][contributing] for a helpful code overview and
repository pull request process details.
## Thank You 🙏
[conduct]: ./CODE_OF_CONDUCT.md
[contributing]: ./.github/CONTRIBUTING.md