Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 5 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Access thousands of icons as components **on-demand** universally.
- 🌏 Universal
- 🤹 **Any** icon sets - ~150 popular sets with over 200,000 icons, logos, emojis, etc. Powered by [Iconify](https://github.com/iconify/iconify).
- 📦 **Major** build tools - Vite, Webpack, Rollup, Nuxt, Rspack, etc. Powered by [unplugin](https://github.com/unjs/unplugin).
- 🚀 **Major** frameworks - Vanilla, Web Components, React, Vue 3, Vue 2, Solid, Svelte, and more. [Contribute](./src/core/compilers).
- 🚀 **Major** frameworks - Vanilla, Web Components, React, Vue 3, Solid, Svelte, and more. [Contribute](./src/core/compilers).
- 🍱 **Any** combinations of them!
- ☁️ On-demand - Only bundle the icons you really use, while having all the options.
- 🖨 SSR / SSG friendly - Ship the icons with your page, no more FOUC.
Expand Down Expand Up @@ -458,9 +458,9 @@ See [the Astro + Vue example](examples/astro-vue) for a working example project.
###### Frameworks

<details>
<summary>Vue 3 / Vue 2.7+</summary><br>
<summary>Vue 3</summary><br>

Vue 3 / Vue 2.7+ support requires peer dependency `@vue/compiler-sfc`:
Vue 3 support requires peer dependency `@vue/compiler-sfc`:

> Note that as of Vue 3.2.13+, this is no longer required as it is now included as a dependency of the main `vue` package.

Expand Down Expand Up @@ -491,38 +491,6 @@ See [the Vue 3 example](examples/vite-vue3) for a working example project.

<br></details>

<details>
<summary>Vue 2 (only for versions < 2.7)</summary><br>

Vue 2 support requires peer dependency `vue-template-compiler`:

```bash
npm i -D vue-template-compiler
```

```ts
Icons({ compiler: 'vue2' })
```

Type Declarations

<!-- eslint-skip -->

```jsonc
// tsconfig.json
{
"compilerOptions": {
"types": [
"unplugin-icons/types/vue",
]
}
}
```

See [the Vue 2 example](examples/vite-vue2) for a working example project.

<br></details>

<details>
<summary>React</summary><br>

Expand Down Expand Up @@ -1107,15 +1075,15 @@ Icons({
scale: 1.2, // Scale of icons against 1em
defaultStyle: '', // Style apply to icons
defaultClass: '', // Class names apply to icons
compiler: null, // 'vue2', 'vue3', 'jsx'
compiler: null, // 'vue3', 'jsx'
jsx: 'react', // 'react' or 'preact'
})
```

## Auto Importing

<details>
<summary>Vue 2 & 3</summary><br>
<summary>Vue 3</summary><br>

Use with [`unplugin-vue-components`](https://github.com/antfu/unplugin-vue-components)

Expand Down
2 changes: 0 additions & 2 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
| `Solid (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-solid) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-solid) |
| `Svelte (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-svelte) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-svelte) |
| `VanillaJS (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-vanilla) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-vanilla) |
| `Vue2 (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-vue2) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-vue2) |
| `Vue3 (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-vue3) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-vue3) |
| `Vue3 legacy (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-vue3-legacy) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-vue3-legacy) |
| `Web Components (Vite)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vite-web-components) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vite-web-components) |
| `Vue2 (Vue CLI)` | [GitHub](https://github.com/unplugin/unplugin-icons/tree/main/examples/vue-cli-vue2) | [Play Online](https://stackblitz.com/fork/github/unplugin/unplugin-icons/tree/main/examples/vue-cli-vue2) |
15 changes: 0 additions & 15 deletions examples/vite-vue2/.stackblitz.js

This file was deleted.

38 changes: 0 additions & 38 deletions examples/vite-vue2/App.vue

This file was deleted.

23 changes: 0 additions & 23 deletions examples/vite-vue2/components.d.ts

This file was deleted.

11 changes: 0 additions & 11 deletions examples/vite-vue2/index.html

This file was deleted.

4 changes: 0 additions & 4 deletions examples/vite-vue2/main.ts

This file was deleted.

36 changes: 0 additions & 36 deletions examples/vite-vue2/package.json

This file was deleted.

23 changes: 0 additions & 23 deletions examples/vite-vue2/vite.config.ts

This file was deleted.

13 changes: 0 additions & 13 deletions examples/vite-vue2/vue-shim.d.ts

This file was deleted.

1 change: 1 addition & 0 deletions examples/vite-vue3/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// @ts-nocheck
// Generated by unplugin-vue-components
// Read more: https://github.com/vuejs/core/pull/3399
// biome-ignore lint: disable
export {}

/* prettier-ignore */
Expand Down
1 change: 0 additions & 1 deletion examples/vue-cli-vue2/.npmrc

This file was deleted.

15 changes: 0 additions & 15 deletions examples/vue-cli-vue2/.stackblitz.js

This file was deleted.

5 changes: 0 additions & 5 deletions examples/vue-cli-vue2/babel.config.js

This file was deleted.

27 changes: 0 additions & 27 deletions examples/vue-cli-vue2/package.json

This file was deleted.

16 changes: 0 additions & 16 deletions examples/vue-cli-vue2/public/index.html

This file was deleted.

29 changes: 0 additions & 29 deletions examples/vue-cli-vue2/src/App.vue

This file was deleted.

8 changes: 0 additions & 8 deletions examples/vue-cli-vue2/src/main.ts

This file was deleted.

5 changes: 0 additions & 5 deletions examples/vue-cli-vue2/src/shims-vue.d.ts

This file was deleted.

Loading
Loading