@e11ty/eleventy-plugin-svg-sprite
v0.0.2
Published
11ty Plugin for generating SVG Sprites for icons
Downloads
14
Readme
11ty-svg-sprite
Yet another Eleventy plugin for handling SVG files with html-svg-sprite.
Why?
Because the author that wrote an alternative is a pleb, so we hard-fork, refine and isolate. :trollface:
Install
The @11ty/eleventy module is a peer and needs to be installed along side it.
pnpm add 11ty-svg-sprite @11ty/eleventy -DUsage
Pass it to the addPlugin within a .eleventy.js or .eleventy.cjs configuration file. Optionally use with 11ty.ts wrapper for type completions.
const { defineConfig } = require('11ty.ts'); // Optional
const { sprite } = require('@e11ty/eleventy-plugin-svg-sprite');
module.exports = defineConfig(eleventyConfig => {
eleventyConfig.addPlugin(sprite, {
inputPath: '', // Relative path to svg directory
outputPath: '', // The output path of the SVG Sprite
globalClass: '', // Class name to apply to all SVG occurrences
defaultClass: '', // Fallback class applied to SVG icons
spriteShortCode: 'sprite', // The sprite short code, defaults to {% sprite %}/
svgShortCode: 'svg', // Icons tag, default to: {% svg 'icon-name', 'custom-class' %}
spriteConfig: { // SVGO Sprite configuration, below is defaults
mode: {
symbol: {
inline: true,
sprite: 'sprite.svg',
example: false
}
},
shape: {
transform: [ 'svgo' ],
id: {
generator: 'svg-%s'
}
},
svg: {
xmlDeclaration: false,
doctypeDeclaration: false
}
}
});
});There are 2 different short codes. Place the sprite short code in your template and use the svg short code tag to reference different icons.
<body>
{% sprite %}
</body>You can inject the <use> reference using the svg short code within your project at different points, for example:
<section>
{% svg 'name-of-svg', 'custom-class' %}
</section>