Vite 中文文档

vite-plugin-svg-icons


English| 中文

Used to generate svg sprite map.

Feature


PreloadingAll icons are generated when the project is running, and you only need to operate dom once.
High performanceBuilt-in cache, it will be regenerated only when the file is modified.

Installation (yarn or npm)


node version:>=12.0.0

vite version:>=2.0.0

  1. ``` shell
  2. yarn add vite-plugin-svg-icons -D
  3. # or
  4. npm i vite-plugin-svg-icons -D
  5. # or
  6. pnpm install vite-plugin-svg-icons -D
  7. ```

Usage


Configuration plugin in vite.config.ts

  1. ``` ts
  2. import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
  3. import path from 'path'

  5. export default () => {
  6.   return {
  7.     plugins: [
  8.       createSvgIconsPlugin({
  9.         // Specify the icon folder to be cached
  10.         iconDirs: [path.resolve(process.cwd(), 'src/icons')],
  11.         // Specify symbolId format
  12.         symbolId: 'icon-[dir]-[name]',

  14.         /**
  15.          * custom insert position
  16.          * @default: body-last
  17.          */
  18.         inject?: 'body-last' | 'body-first'

  20.         /**
  21.          * custom dom id
  22.          * @default: __svg__icons__dom__
  23.          */
  24.         customDomId: '__svg__icons__dom__',
  25.       }),
  26.     ],
  27.   }
  28. }
  29. ```

Introduce the registration script in src/main.ts

  1. ``` ts
  2. import 'virtual:svg-icons-register'
  3. ```

Here the svg sprite map has been generated

How to use in components


Vue way


/src/components/SvgIcon.vue

  1. ``` vue
  2. <template>
  3.   <svg aria-hidden="true">
  4.     <use :href="symbolId" :fill="color" />
  5.   </svg>
  6. </template>

  8. <script>
  9. import { defineComponent, computed } from 'vue'

  11. export default defineComponent({
  12.   name: 'SvgIcon',
  13.   props: {
  14.     prefix: {
  15.       type: String,
  16.       default: 'icon',
  17.     },
  18.     name: {
  19.       type: String,
  20.       required: true,
  21.     },
  22.     color: {
  23.       type: String,
  24.       default: '#333',
  25.     },
  26.   },
  27.   setup(props) {
  28.     const symbolId = computed(() => `#${props.prefix}-${props.name}`)
  29.     return { symbolId }
  30.   },
  31. })
  32. </script>
  33. ```

Icons Directory Structure


  1. ``` shell
  2. # src/icons

  4. - icon1.svg
  5. - icon2.svg
  6. - icon3.svg
  7. - dir/icon1.svg
  8. ```

/src/App.vue

  1. ``` vue
  2. <template>
  3.   <div>
  4.     <SvgIcon name="icon1"></SvgIcon>
  5.     <SvgIcon name="icon2"></SvgIcon>
  6.     <SvgIcon name="icon3"></SvgIcon>
  7.     <SvgIcon name="dir-icon1"></SvgIcon>
  8.   </div>
  9. </template>

  11. <script>
  12. import { defineComponent, computed } from 'vue'

  14. import SvgIcon from './components/SvgIcon.vue'
  15. export default defineComponent({
  16.   name: 'App',
  17.   components: { SvgIcon },
  18. })
  19. </script>
  20. ```

React way


/src/components/SvgIcon.jsx

  1. ``` js
  2. export default function SvgIcon({
  3.   name,
  4.   prefix = 'icon',
  5.   color = '#333',
  6.   ...props
  7. }) {
  8.   const symbolId = `#${prefix}-${name}`

  10.   return (
  11.     <svg {...props} aria-hidden="true">
  12.       <use href={symbolId} fill={color} />
  13.     </svg>
  14.   )
  15. }
  16. ```

Icons Directory Structure


  1. ``` shell
  2. # src/icons

  4. - icon1.svg
  5. - icon2.svg
  6. - icon3.svg
  7. - dir/icon1.svg
  8. ```

/src/App.jsx

  1. ``` js
  2. import SvgIcon from './components/SvgIcon'

  4. export default function App() {
  5.   return (
  6.     <>
  7.       <SvgIcon name="icon1"></SvgIcon>
  8.       <SvgIcon name="icon1"></SvgIcon>
  9.       <SvgIcon name="icon1"></SvgIcon>
  10.       <SvgIcon name="dir-icon1"></SvgIcon>
  11.     </>
  12.   )
  13. }
  14. ```

Get all SymbolId


  1. ``` ts
  2. import ids from 'virtual:svg-icons-names'
  3. // => ['icon-icon1','icon-icon2','icon-icon3']
  4. ```

Options


Parameter Type Default Description
:--- :--- :--- :---
iconDirs string[] - Need to generate the icon folder of the Sprite image
symbolId string icon-[dir]-[name] svg symbolId format, see the description below
svgoOptions boolean｜SvgoOptions true svg compression configuration, can be an objectOptions
inject string body-last svgDom default insertion position, optional body-first
customDomId string __svg__icons__dom__ Customize the ID of the svgDom insert node

symbolId

icon-[dir]-[name]

[name]:

svg file name

[dir]

The svg of the plug-in will not generate hash to distinguish, but distinguish it by folder.

If the folder corresponding to iconDirs contains this other folder

example:

Then the generated SymbolId is written in the comment

  1. ``` shell
  2. # src/icons
  3. - icon1.svg # icon-icon1
  4. - icon2.svg # icon-icon2
  5. - icon3.svg # icon-icon3
  6. - dir/icon1.svg # icon-dir-icon1
  7. - dir/dir2/icon1.svg # icon-dir-dir2-icon1
  8. ```

Typescript Support


If using Typescript, you can add in tsconfig.json

  1. ``` json
  2. // tsconfig.json
  3. {
  4.   "compilerOptions": {
  5.     "types": ["vite-plugin-svg-icons/client"]
  6.   }
  7. }
  8. ```

Note

Although the use of folders to distinguish between them can largely avoid the problem of duplicate names, there will also be svgs with multiple folders and the same file name in iconDirs.

This needs to be avoided by the developer himself

Example


Run

  1. ``` shell
  2. pnpm install
  3. cd ./packages/playground/basic
  4. pnpm run dev
  5. pnpm run build

  7. ```

Sample project


Vben Admin

License


MIT © Vben-2020