vite-plugin-svg-spritemap

This plugin supports Vite 4 and 5.

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

The plugin outputs can be fully configurable through options.

[!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 an <svg> or <img> tags and also directly in your CSS/SCSS/Stylus/Less
• 🍕 Import SVG fragment as VueJS component
• 🔥 HMR support

📦 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

👨‍💻 Usage

By default, the plugin will generate a spritemap to support all methods described below (files populated with <view> for fragments and <use> for sprite).

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

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

You can access to the spritemap via the route /__spritemap. All files process by ViteJS will transform the path of the file on build. By default, you will need to use the prefix sprite-.

SVG

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

Img

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

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

CSS

You can also use the spritemap SVGs in your CSS. The plugin supports CSS (basic classes) and also SCSS, Stylus and Less (mixins and map with SVG Data URI and sizes).

First you need to adjust the plugin options to set the output styles. For full styles options, check the Options.

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

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

// main.scss
@import './spritemap.scss';

After that, you need to import the file in your current styles. Don't forget to load the CSS via ViteJS.

If you use a CSS preprocessing language, you can use the mixin sprite and access to a map with all sprites infos. If not, you will only access to classes.

You can see the usage in the demo folder :

• CSS
• SCSS
• Less
• Stylus

Advanced

Customize styles outputs

By default, the plugin will generate CSS or a mixin (for SCSS, Less and Stylus) with variables which contains all sprites data.

You can alter the output by using the styles.callback. You can access the default content generated by the plugin but you can also write your own output by using the createSpritemap function.

In the example below, this will generate only background data uri.

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

export default {
  plugins: [
    VitePluginSVGSpritemap('./src/icons/*.svg', {
      styles: {
        filename: 'src/scss/spritemap.css',
        callback: ({ content, options, createSpritemap }) => {
          let insert = ''
          insert += createSpritemap((name, svg) => {
            const selector = `.${options.prefix}${name}`
            let sprite = ''
            sprite = `${selector} {`
            sprite += `\n\tbackground: url("${svg.svgDataUri}") center no-repeat;`
            sprite += '\n}'
            return sprite
          })
          return insert
        }
      }
    })
  ]
}

You can use the include property to controle exactly what to include inside your style. If you want only variables with ['variables'] for SCSS/Less/Stylus or ['bg'] in CSS, only background css class generation for example.

You can also control the names of the mixin, the variables sprites and prefix.

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

export default {
  plugins: [
    VitePluginSVGSpritemap('./src/icons/*.svg', {
      styles: {
        filename: 'src/scss/spritemap.scss',
        names: {
          mixin: 'icon-sprite',
          prefix: 'icon-prefix',
          sprites: 'icons'
        }
      }
    })
  ]
}

Vue components

vite-plugin-svg-spritemap allows you to load icons and create <use> as <svg> and <view> as <img> tags like Vue components.

To do that, import the icons loaded by vite-svg-spritemap and add the ?use or ?view query. The plugin will transform the component.

<script setup lang="ts">
import SpiriitUse from './icons/spiriit.svg?use'
import SpiriitView from './icons/spiriit.svg?view'
import ViteUse from './icons/vite.svg?use'
import ViteView from './icons/vite.svg?view'
</script>

<template>
  <SpiriitUse>
    <!-- You can use the slot to pass a title before the use tag generation -->
    <title>My superb logo</title>
  </SpiriitUse>
  <ViteUse />

  <SpiriitView />
  <ViteView />
</template>

will generate

<svg>
  <title>My superb logo</title>
  <use xlink:href="/__spritemap#sprite-spiriit"></use>
</svg>
<svg>
  <use xlink:href="/__spritemap#sprite-vite"></use>
</svg>
<img src="/__spritemap#sprite-spiriit-view" width="118" height="38">
<img src="/__spritemap#sprite-vite-view" width="31" height="32">

You can see the usage in the corresponding demo folder.

Typescript

For typescript, you need to load the type definitions inside vite-env.d.ts to fix errors with ?use/?view query.

/// <reference types="vite/client" />
/// <reference types="@spiriit/vite-plugin-svg-spritemap/client" />

Nuxt 3

[!NOTE] This plugin only works with Nuxt 3 and Vite as a bundler.

You just need to install the plugin and set it in the right place for Nuxt 3.

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

export default defineNuxtConfig({
  vite: {
    plugins: [
      VitePluginSvgSpritemap('./assets/icons/*.svg'),
    ]
  }
})

You can see the usage in the corresponding demo folder.

Typescript

For usage with TypeScript, you will need to add in a .d.ts file the reference type /// <reference types="@spiriit/vite-plugin-svg-spritemap/dist/client" /> (see issue #38) to use ?use/?view query.

/// <reference types="@spiriit/vite-plugin-svg-spritemap/dist/client" />

Backend integration

ViteJS allows to be use to serve assets. So, you can connect ViteJS with Wordpress, Drupal or any kind of backend.

[!IMPORTANT] To make vite-plugin-svg-spritemap works with this kind of environnment, you will need to handle the right url inside your backend if you are on dev or build.

For example, with <use> on dev, using direcly the id of the svg (with the injectSVGOnDev option).

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

And in prod, by putting the correct URL manually thanks to the manifest.json file information :

<svg>
  <use xlink:href="https://my-cool-website.com/dist/assets/spritemap.95b4c41a.svg#sprite-spiriit"></use>
</svg>

To prevent CORS issue with SVG and <use>, you can use the injectSVGOnDev option. Don't forget to add the HMR script directly above you close body.

<script type="module" src="http://localhost:5173/@vite-plugin-svg-spritemap/client"></script>

You can see an example of integration in the corresponding demo folder.

Multiple Instance

If you want to have multiple SVG sprites files, you can configure multiple instances of the plugin. To do so, you will need the options route. Instead of the traditionnal /__spritemap, you can set for example /__flags.

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

export default {
  plugins: [
    VitePluginSVGSpritemap('./src/icons/*.svg'), // will be route: '__spritemap' by default
    VitePluginSVGSpritemap('./src/flags/*.svg', {
      route: '__flags'
    })
  ]
}

If you are using Sass, Less or Stylus: you can optimize the style file export by only generate one mixin on one instance with styles.include set to ['variables'] or/and use the styles.names object.

🛠 Options

The first argument is a glob path (using fast-glob) and the second is an object with the following options :

| Options | Type | Default | Description | | -------------- | ----------------------------------- | --------- | ------------- | | output | boolean or object or string | true | As a string, set the destination of the file (see output.filename). For more control, see output. Set to false to disable output. | | styles | false or object or string | false | File destination like src/css/spritemap.css or styles object | | prefix | string or false | sprite- | Define the prefix uses for sprite id in <symbol>/<use>/<view>. Set to false to disable the prefix | | svgo | boolean or object | true | Take an SVGO Options object. If true, it will use the default SVGO preset, if false, it will disable SVGO optimization | | injectSVGOnDev | boolean | false | Inject the SVG Spritemap inside the body on dev | | idify | (name:string, svg:object) => string | name => options.prefix + name | Function allowing to customize the id of each symbol of the spritemap svg. | | route | string | __spritemap | Change the route name allowing you to have multiple instance of the plugin |

output

| Options | Type | Default | Description | | -------- | --------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | filename | string | [name].[hash][extname] | The destination of the file. You can use output filename like Rollup. Note: Doesn't support hash number. | | name | string | spritemap.svg | The name of file, appear on the manifest key | | use | boolean | true | Insert use element in the spritemap | | view | boolean | true | Insert view element in the spritemap |

styles

| Options | Type | Description | | -------- | ----------------------------------------- | -------------------------------------------------------------- | | filename | string | The destination of the stylesheet file like your source folder | | lang | less/scss/styl/css or undefined |Enforce the styles language generated by the plugin | | include | boolean or ['mixin', 'variables'] or ['bg', 'mask', 'bg-frag'] or undefined | By default, it will include ['mixin', 'variables'] for SCSS/Less/Stylus and ['bg', 'mask', 'bg-frag'] for CSS. This allowing you to choose what to include | | names | {prefix: 'sprites-prefix', sprites: 'sprites', mixin: 'sprite'} | Allow to customize the variables/mixin names of the generated Sass/Less/Stylus | | callback | undefined | Allow you to customize the output of the generated styles file (see Customize Styles Outputs) |

Example with full options :

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

export default {
  plugins: [
    VitePluginSVGSpritemap('./src/icons/*.svg', {
      prefix: 'icon-',
      route: '__spritemap',
      output: {
        filename: '[name].[hash][extname]',
        name: 'spritemap.svg',
        view: false,
        use: true,
      },
      svgo: {
        plugins: [
          {
            name: 'removeStyleElement',
          },
        ],
      },
      injectSVGOnDev: true,
      idefy: (name, svg) => `icon-${name}-cheese`,
      styles: {
        lang: 'scss',
        filename: 'src/scss/spritemap.scss',
        include: ['mixin', 'variables'],
        names: {
          prefix: 'sprites-prefix',
          sprites: 'sprites',
          mixin: 'sprite',
        },
        callback: ({ content, options, createSpritemap }) => {
          return content
        }
      }
    })
  ]
}

🏃 What's next

• Add variable supports inspired by svg-spritemap-webpack-plugin

👨‍💼 Licence

MIT