# vite-plugin-svg-icons

> Vite Plugin for fast creating SVG sprites.

Latest version **2.0.1** (published 2022-01-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install vite-plugin-svg-icons
pnpm add vite-plugin-svg-icons
yarn add vite-plugin-svg-icons
bun add vite-plugin-svg-icons
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2022-01-29 |
| First published | 2021-02-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 18.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 947 |
| Author | Vben |
| Maintainers | vvben |
| Keywords | vite, vite-plugin, svg, sprite, svgo, vben |

## Links

- npm: https://www.npmjs.com/package/vite-plugin-svg-icons
- Repository: https://github.com/anncwb/vite-plugin-svg-icons
- Homepage: https://github.com/anncwb/vite-plugin-svg-icons/tree/master/#readme
- Issues: https://github.com/anncwb/vite-plugin-svg-i cons/issues
- npm.io page: https://npm.io/package/vite-plugin-svg-icons

## Dependencies (8)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [etag](https://npm.io/package/etag.md) ^1.8.1
- [svgo](https://npm.io/package/svgo.md) ^2.8.0
- [debug](https://npm.io/package/debug.md) ^4.3.3
- [pathe](https://npm.io/package/pathe.md) ^0.2.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [svg-baker](https://npm.io/package/svg-baker.md) 1.7.0
- [@types/svgo](https://npm.io/package/@types/svgo.md) ^2.6.1

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2022-01-29
- 2.0.0 — 2022-01-28
- 1.1.0 — 2021-12-31
- 1.0.5 — 2021-09-27
- 1.0.4 — 2021-08-03
- 1.0.3 — 2021-08-02
- 1.0.2 — 2021-08-01
- 1.0.1 — 2021-07-06
- 1.0.0 — 2021-06-25
- 0.7.1 — 2021-06-16
- 0.7.0 — 2021-06-01
- 0.6.2 — 2021-05-27
- 0.6.1 — 2021-05-25
- 0.6.0-beta.3 — 2021-05-25
- 0.6.0-beta.2 — 2021-05-25
- … 19 more at https://npm.io/package/vite-plugin-svg-icons/versions

## README

# vite-plugin-svg-icons

**English** | [中文](./README.zh_CN.md)

Used to generate svg sprite map.

## Feature

- **Preloading** All icons are generated when the project is running, and you only need to operate dom once.
- **High performance** Built-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

```bash
yarn add vite-plugin-svg-icons -D
# or
npm i vite-plugin-svg-icons -D
# or
pnpm install vite-plugin-svg-icons -D
```

## Usage

- Configuration plugin in vite.config.ts

```ts
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from 'path'

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

        /**
         * custom insert position
         * @default: body-last
         */
        inject?: 'body-last' | 'body-first'

        /**
         * custom dom id
         * @default: __svg__icons__dom__
         */
        customDomId: '__svg__icons__dom__',
      }),
    ],
  }
}

```

- Introduce the registration script in src/main.ts

```ts
import 'virtual:svg-icons-register'
```

Here the svg sprite map has been generated

## How to use in components

### **Vue way**

`/src/components/SvgIcon.vue`

```vue
<template>
  <svg aria-hidden="true">
    <use :href="symbolId" :fill="color" />
  </svg>
</template>

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

export default defineComponent({
  name: 'SvgIcon',
  props: {
    prefix: {
      type: String,
      default: 'icon',
    },
    name: {
      type: String,
      required: true,
    },
    color: {
      type: String,
      default: '#333',
    },
  },
  setup(props) {
    const symbolId = computed(() => `#${props.prefix}-${props.name}`)
    return { symbolId }
  },
})
</script>
```

#### **Icons Directory Structure**

```bash
# src/icons

- icon1.svg
- icon2.svg
- icon3.svg
- dir/icon1.svg
```

`/src/App.vue`

```vue
<template>
  <div>
    <SvgIcon name="icon1"></SvgIcon>
    <SvgIcon name="icon2"></SvgIcon>
    <SvgIcon name="icon3"></SvgIcon>
    <SvgIcon name="dir-icon1"></SvgIcon>
  </div>
</template>

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

import SvgIcon from './components/SvgIcon.vue'
export default defineComponent({
  name: 'App',
  components: { SvgIcon },
})
</script>
```

### **React way**

`/src/components/SvgIcon.jsx`

```jsx
export default function SvgIcon({
  name,
  prefix = 'icon',
  color = '#333',
  ...props
}) {
  const symbolId = `#${prefix}-${name}`

  return (
    <svg {...props} aria-hidden="true">
      <use href={symbolId} fill={color} />
    </svg>
  )
}
```

#### **Icons Directory Structure**

```bash
# src/icons

- icon1.svg
- icon2.svg
- icon3.svg
- dir/icon1.svg
```

`/src/App.jsx`

```jsx
import SvgIcon from './components/SvgIcon'

export default function App() {
  return (
    <>
      <SvgIcon name="icon1"></SvgIcon>
      <SvgIcon name="icon1"></SvgIcon>
      <SvgIcon name="icon1"></SvgIcon>
      <SvgIcon name="dir-icon1"></SvgIcon>
    </>
  )
}
```

### Get all SymbolId

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

### 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 object[Options](https://github.com/svg/svgo) |
| 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

```bash
# src/icons
- icon1.svg # icon-icon1
- icon2.svg # icon-icon2
- icon3.svg # icon-icon3
- dir/icon1.svg # icon-dir-icon1
- dir/dir2/icon1.svg # icon-dir-dir2-icon1
```

## Typescript Support

If using `Typescript`, you can add in `tsconfig.json`

```json
// tsconfig.json
{
  "compilerOptions": {
    "types": ["vite-plugin-svg-icons/client"]
  }
}
```

**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**

```bash

pnpm install
cd ./packages/playground/basic
pnpm run dev
pnpm run build

```

## Sample project

[Vben Admin](https://github.com/anncwb/vue-vben-admin)

## License

[MIT © Vben-2020](./LICENSE)

---
_Source: https://npm.io/package/vite-plugin-svg-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._