# purge-icons-vue

> PurgeIcons's vue 2 icon component

Latest version **1.2.1** (published 2020-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install purge-icons-vue
pnpm add purge-icons-vue
yarn add purge-icons-vue
bun add purge-icons-vue
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-09-13 |
| First published | 2020-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lucas Yang |
| Maintainers | ycs77 |
| Keywords | purge-icons, vue, vue.js |

## Links

- npm: https://www.npmjs.com/package/purge-icons-vue
- Repository: https://github.com/ycs77/purge-icons-vue
- Issues: https://github.com/ycs77/purge-icons-vue/issues
- npm.io page: https://npm.io/package/purge-icons-vue

## Dependencies (2)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.11.2
- [@purge-icons/generated](https://npm.io/package/@purge-icons/generated.md) ^0.4

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2020-09-13
- 1.2.0 — 2020-09-08
- 1.1.0 — 2020-09-08
- 1.0.1 — 2020-09-08

## README

# PurgeIcons's Vue 2 Icon Component

[![npm version](https://img.shields.io/npm/v/purge-icons-vue?style=flat-square)](https://www.npmjs.com/package/purge-icons-vue)

> Adapted from https://github.com/antfu/vitesse/blob/master/src/components/Icon.vue

Must install [PurgeIcons](https://github.com/antfu/purge-icons).

## Installation

```bash
npm i purge-icons-vue
# or
yarn add purge-icons-vue
```

And register in Vue app entry:

```js
import PurgeIconsVue from 'purge-icons-vue'

Vue.use(PurgeIconsVue)
```

If you installed `postcss-import`, can import CSS file:

```css
@import 'purge-icons-vue';
```

## Usage

```html
<Icon icon="mdi:account" />
```

The icon id follows the rules in [Iconify](https://iconify.design/) which you can use any icons from the supported icon sets. It will only bundles the icons you use, check out [PurgeIcons](https://github.com/antfu/purge-icons) for more details.

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