https://github.com/yunsii/unplugin-iconify
Unplugin for iconify.
https://github.com/yunsii/unplugin-iconify
css css-generators css-icons iconify unplugin
Last synced: 6 months ago
JSON representation
Unplugin for iconify.
- Host: GitHub
- URL: https://github.com/yunsii/unplugin-iconify
- Owner: yunsii
- License: mit
- Created: 2023-10-13T13:47:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T09:34:20.000Z (almost 2 years ago)
- Last Synced: 2024-12-30T11:45:14.078Z (9 months ago)
- Topics: css, css-generators, css-icons, iconify, unplugin
- Language: CSS
- Homepage:
- Size: 185 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# unplugin-iconify
[Unplugin](https://github.com/unjs/unplugin) for [iconify](https://iconify.design/).
[](https://www.npmjs.com/package/unplugin-iconify) [](https://www.npmjs.com/package/unplugin-iconify)
## Features
- ✨ [`cssGenerators`](./src/types.ts#L4) - Easy to generate icons CSS as your expected
## Install
```bash
npm i unplugin-iconify
```
Vite
```ts
// vite.config.ts
import starter from 'unplugin-iconify/vite'
export default defineConfig({
plugins: [
starter({
/* options */
}),
],
})
```
Example: [`playground/`](./playground/)
Rollup
```ts
// rollup.config.js
import starter from 'unplugin-iconify/rollup'
export default {
plugins: [
starter({
/* options */
}),
],
}
```
Webpack
```ts
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require('unplugin-iconify/webpack')({
/* options */
}),
],
}
```
Nuxt
```ts
// nuxt.config.js
export default defineNuxtConfig({
modules: [
[
'unplugin-iconify/nuxt',
{
/* options */
},
],
],
})
```
> This module works for both Nuxt 2 and [Nuxt Vite](https://github.com/nuxt/vite)
Vue CLI
```ts
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [
require('unplugin-iconify/webpack')({
/* options */
}),
],
},
}
```
esbuild
```ts
// esbuild.config.js
import { build } from 'esbuild'
import starter from 'unplugin-iconify/esbuild'
build({
plugins: [starter()],
})
```
## Related
- [tailwindcss-plugin-iconify](https://github.com/yunsii/tailwindcss-plugin-iconify) - Use any SVG icon powered by Iconify for Tailwind CSS, easy to use local icons and figma icons in particular.
## License
[MIT](./LICENSE) License © 2023 [Yuns](https://github.com/yunsii)