Nuxt Icon

Add 200,000+ ready to use icons to your Nuxt application, based on Iconify.

• 📖  Documentation
• ✨  Release Notes
• 🏀  Online playground

Features

• SSR friendly
• 200,000+ open-source vector icons via Iconify
• CSS mode and SVG mode
• Custom icons, from Vue components or local SVG files
• Client bundles for offline icons, and a standalone Vite plugin for Vue apps without Nuxt

Quick Setup

Add the module to your Nuxt project:

npx nuxt add icon

Then use the <Icon> component with any icon name from Icônes:

<template>
  <Icon name="uil:github" />
</template>

Read the documentation for usage, configuration, server and client bundles, icon customization, custom collections and testing.

Contributing

1. Clone this repository
2. Install dependencies using pnpm install (install pnpm with corepack enable, learn more)
3. Run npm run dev:prepare to generate type stubs.
4. Use npm run dev to start playground in development mode.

Credits

• @benjamincanac for the initial version
• @cyberalien for making Iconify

License

MIT License