@spiriit/vite-plugin-svg-spritemap weekly downloads statistics

vite-plugin-svg-spritemap

This plugin supports Vite 7 and 8.

This ViteJS plugin generates a single SVG spritemap with <symbol>/<view>/<use> for each SVG file. It can also generate a stylesheet (CSS/SCSS/Stylus/Less) containing the sprites to be used directly (via a Data URI or SVG fragments).

[!NOTE] This plugin is inspired by svg-spritemap-webpack-plugin for Webpack.

🚀 Features

• ⚡ Fully integrated in your ViteJS environment
• 📦 Pack your SVG files in one (spritemap) file
• ✨ Use your SVG in <svg> or <img> tags and also directly in your CSS/SCSS/Stylus/Less
• 🍕 Import SVG fragments as VueJS components
• 🎨 Theme an icon per usage with variables
• 🔥 HMR support
• ⚙️ Optimize your SVGs with SVGO or OXVG

📦 Install

npm i -D @spiriit/vite-plugin-svg-spritemap

# yarn
yarn add -D @spiriit/vite-plugin-svg-spritemap

# pnpm
pnpm add -D @spiriit/vite-plugin-svg-spritemap

# bun
bun add -D @spiriit/vite-plugin-svg-spritemap

👨‍💻 Quick start

Add all your SVGs icons in one folder (like below /src/icons folder for example) and pass the first argument as a glob path including your svg files.

// vite.config.js / vite.config.ts
import VitePluginSvgSpritemap from '@spiriit/vite-plugin-svg-spritemap'

export default {
  plugins: [VitePluginSvgSpritemap('./src/icons/*.svg')]
}

You can access the spritemap via the route /__spritemap. All files processed by ViteJS will transform the path of the file on build. The prefix is sprite- by default.

The plugin will generate a spritemap to support all methods described below (files populated with <view> for fragments and <use> for sprite). This can be configured through options.

SVG

<svg>
  <use xlink:href="/__spritemap#sprite-spiriit"></use>
</svg>

By default the generated spritemap uses the deprecated xlink:href attribute inside the <use> tags for compatibility. You can switch to the standard href attribute or emit both with an xlink:href fallback, via the output.hrefAttribute option ('xlink:href' | 'href' | 'both').

Img

You need to add the suffix -view to access the fragment.

<img src="/__spritemap#sprite-spiriit-view" />

📚 Documentation

For more information, check the vite-plugin-svg-spritemap documentation. It covers everything from getting started to advanced topics.

👨‍💼 License

MIT