# vite-plugin-purge-icons

> vite-plugin-purge-icons

Latest version **0.10.0** (published 2023-11-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.0 |
| Published | 2023-11-18 |
| First published | 2020-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 12 |
| Dependencies | 3 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 233 |
| Author | antfu |
| Maintainers | antfu |

## Links

- npm: https://www.npmjs.com/package/vite-plugin-purge-icons
- Repository: https://github.com/antfu/purge-icons
- Issues: https://github.com/antfu/purge-icons/issues
- npm.io page: https://npm.io/package/vite-plugin-purge-icons

## Dependencies (3)

- [@purge-icons/core](https://npm.io/package/@purge-icons/core.md) ^0.10.0
- [@purge-icons/generated](https://npm.io/package/@purge-icons/generated.md) ^0.10.0
- [rollup-plugin-purge-icons](https://npm.io/package/rollup-plugin-purge-icons.md) ^0.10.0

## Recent versions

- 0.10.0 (latest) — 2023-11-18
- 0.9.2 — 2022-12-12
- 0.9.1 — 2022-09-20
- 0.9.0 — 2022-08-09
- 0.8.2 — 2022-07-22
- 0.8.1 — 2022-02-28
- 0.8.0 — 2022-02-26
- 0.7.0 — 2021-02-17
- 0.6.0 — 2021-01-24
- 0.5.2 — 2021-01-19
- 0.5.1 — 2021-01-13
- 0.5.0 — 2021-01-04
- 0.4.5 — 2020-11-05
- 0.4.4 — 2020-10-15
- 0.4.2 — 2020-09-28
- … 11 more at https://npm.io/package/vite-plugin-purge-icons/versions

## README

<h1 align='center'>vite-plugin-purge-icons</h1>

<p align='center'>Vite Plugin for <a href="https://github.com/antfu/purge-icons" target="_blank">PurgeIcons</a></p>


## Usage

> ℹ️ **Vite 2 is supported from `v0.5.x`, Vite 1's support is discontinued.**

Install

```bash
npm i @iconify/iconify
npm i vite-plugin-purge-icons @iconify/json -D
```

> `@iconify/json` is an optional dependencies of PurgeIcons. When it presents in your `node_modules`, PurgeIcons will load the icons from it locally, otherwise, PurgeIcons will try to fetch the iconset your requested online.

Add it to `vite.config.js`

```ts
// vite.config.js
import PurgeIcons from 'vite-plugin-purge-icons'

export default {
  plugins: [
    PurgeIcons({
      /* PurgeIcons Options */
    })
  ]
}
```

Import `@purge-icons/generated` in your `main.js`

```ts
import { createApp } from 'vue'
import App from './App.vue'

import '@purge-icons/generated' // <-- This

createApp(App).mount('#app')
```

## Configuration

Check out in [PurgeIcons](https://github.com/antfu/purge-icons#programmatic-api)

## Example

See the [Vitesse](https://github.com/antfu/vitesse) starter template.

## License

MIT License © 2020 [Anthony Fu](https://github.com/antfu)

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