Nuxt Icon

npm version License npm downloads

Icon module for Nuxt with 100,000+ ready to use icons from Iconify.

Features ✨

  • Nuxt 3 ready
  • Support 100,000 open source vector icons via Iconify
  • Emoji Support
  • Custom SVG support (via Vue component)

Setup ⛓️

Add nuxt-icon dependency to your project:

npm install --save-dev nuxt-icon

# Using yarn
yarn add --dev nuxt-icon

Add it to the modules array in your nuxt.config.ts:

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: ['nuxt-icon']

That’s it, you can now use the <Icon /> in your components!

✨ If you are using VS Code, you can use the Iconify IntelliSense extension by @antfu

Usage ?


  • name (required): icon name, emoji or global component name
  • size: icon size (default: 1em)

Iconify dataset

You can use any name from the collection:

<Icon name="uil:github" />


<Icon name="?" />

Vue component

<Icon name="NuxtIcon" />

Note that NuxtIcon needs to be inside components/global/ folder (see example).

Configuration ⚙️

To update the default size (1em) of the <Icon />, create an app.config.ts with the nuxtIcon.size property:

// app.config.ts
export default defineAppConfig({
  nuxtIcon: {
    size: '24px' // default <Icon> size applied

Contributing ?

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Run npm run dev:prepare to generate type stubs.
  4. Use npm run dev to start playground in development mode.

Credits ?

License ?

MIT License


View Github