Icon Fonts

Out of the box, Vuetify supports many popular icon libraries - Material Design Icons, Font Awesome, Phosphor, Lucide, Tabler, and more.

Usage

To change your font library, import one of the pre-defined icon sets or provide your own.

import { createVuetify } from 'vuetify'
import { aliases, mdi } from 'vuetify/iconsets/mdi'

export default createVuetify({
  icons: {
    defaultSet: 'mdi',
    aliases,
    sets: {
      mdi,
    },
  },
})

html

<template>
  <v-icon icon="mdi-home" />
</template>

In the above examples we import the default mdi icon set and its corresponding aliases. These aliases reference commonly used types of icons that are utilized by Vuetify components.

::: info

While it is still possible to supply the icon value through the default slot in Vuetify 3+ (<v-icon>mdi-home</v-icon>), we recommend using the icon prop instead.

:::

Installing icon fonts

You are required to include the specified icon library (even when using the default icons from Material Design Icons). This can be done by including a CDN link or importing the icon library into your application.

::: info

In this page "Material Icons" is used to refer to the official google icons and "Material Design Icons" refers to the extended third-party library

:::

Material Design Icons

This is the default icon set used by Vuetify. It supports local installation with a build process or a CDN link. The following shows how to add the CDN link to your index.html:

MDI - CSS

html

<link href="https://cdn.jsdelivr.net/npm/@mdi/[email protected]/css/materialdesignicons.min.css" rel="stylesheet">

Or as a local dependency:

::: tabs

bash

pnpm add @mdi/font -D

bash

yarn add @mdi/font -D

bash

npm install @mdi/font -D

bash

bun add @mdi/font -D

:::

import '@mdi/font/css/materialdesignicons.css' // Ensure you are using css-loader
import { createVuetify } from 'vuetify'

export default createVuetify({
  icons: {
    defaultSet: 'mdi', // This is already the default value - only for display purposes
  },
})

::: error

DO NOT use a CDN link without specifying a package version. Failure to do so can result in unexpected changes to your application with new releases.

:::

MDI - JS SVG

This is the recommended installation when optimizing your application for production, as only icons used for Vuetify components internally will be imported into your application bundle. You will need to provide your own icons for the rest of the app.

import { createVuetify } from 'vuetify'
import { aliases, mdi } from 'vuetify/iconsets/mdi-svg'

export default createVuetify({
  icons: {
    defaultSet: 'mdi',
    aliases,
    sets: {
      mdi,
    },
  },
})

@mdi/js or unplugin-icons are two alternatives to get the rest of the icons that you will need in your application.

If you want to stick with @mdi/js, use the SVG paths as designated in @mdi/js and only import the icons that you need.

The following example shows how to use an imported icon within a .vue SFC template:

::: tabs

bash

pnpm add @mdi/js -D

bash

yarn add @mdi/js -D

bash

npm install @mdi/js -D

bash

bun add @mdi/js -D

:::

html

<template>
  <v-icon :icon="mdiAccount" />
</template>

<script setup>
  import { mdiAccount } from '@mdi/js'
</script>

Or the icons you want to use can be added as aliases to simplify reuse:

import { createVuetify } from 'vuetify'
import { aliases, mdi } from 'vuetify/iconsets/mdi-svg'
import { mdiAccount } from '@mdi/js'

export default createVuetify({
  icons: {
    defaultSet: 'mdi',
    aliases: {
      ...aliases,
      account: mdiAccount,
    },
    sets: {
      mdi,
    },
  },
})

html

<template>
  <v-icon icon="$account" />
</template>

MDI - Icon search

Use this tool to search for any Material Design Icons and copy them to your clipboard by clicking the item.

UnoCSS icon sets

Vuetify provides pre-configured icon sets that work with UnoCSS Preset Icons. All icons are tree-shaken so only the icons you use are included in your final CSS bundle.

Icon library	Iconify package	Vuetify import	Default set name
Material Design Icons	`@iconify-json/mdi`	`vuetify/iconsets/mdi-unocss`	`mdi`
Font Awesome 6	`@iconify-json/fa6-solid`
`@iconify-json/fa6-regular`	`vuetify/iconsets/fa6`	`fa6`
Phosphor	`@iconify-json/ph`	`vuetify/iconsets/ph`	`ph`
Lucide	`@iconify-json/lucide`	`vuetify/iconsets/lucide`	`lucide`
Tabler	`@iconify-json/tabler`	`vuetify/iconsets/tabler`	`tabler`
Remix Icon	`@iconify-json/ri`	`vuetify/iconsets/ri`	`ri`
BoxIcons	`@iconify-json/bx`	`vuetify/iconsets/bx`	`bx`
Carbon	`@iconify-json/carbon`	`vuetify/iconsets/carbon`	`carbon`
Material Symbols	`@iconify-json/material-symbols`	`vuetify/iconsets/ms`	`ms`

Install unocss and the Iconify package for your chosen library:

::: tabs

bash

pnpm add unocss @iconify-json/ph -D

bash

yarn add unocss @iconify-json/ph -D

bash

npm install unocss @iconify-json/ph -D

bash

bun add unocss @iconify-json/ph -D

:::

Then configure UnoCSS in your project (read the UnoCSS integration section for further details).

::: warning

Don't change the default prefix i- of UnoCSS preset-icons, Vuetify icon sets rely on it.

:::

import { presetIcons, defineConfig } from 'unocss'

export default defineConfig({
  presets: [
    presetIcons({
      processor(props) {
        delete props.color
      },
    }),
  ],
})

Register the icon set in your Vuetify configuration. The following example uses Phosphor, but you can substitute any set from the table above:

import { createVuetify } from 'vuetify'
import { aliases, ph } from 'vuetify/iconsets/ph'

export default createVuetify({
  icons: {
    defaultSet: 'ph',
    aliases,
    sets: {
      ph,
    },
  },
})

Material Icons

For projects without a build process, it is recommended to import the icons from CDN.

Material Icons - CSS

html

<link href="https://fonts.googleapis.com/css?family=Material+Icons" rel="stylesheet">

Some Material Icons are missing by default. For example, person and person_outline are available, but visibility_outline isn't, while visibility is. To use the missing icons, replace the existing <link> with the following:

html

<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css?family=Material+Icons|Material+Icons+Outlined|Material+Icons+Two+Tone|Material+Icons+Round|Material+Icons+Sharp"
/>

Alternatively, it is possible to install locally using yarn or npm. Keep in mind that this is not an official google repository and may not contain all icons.

::: tabs

bash

pnpm add material-design-icons-iconfont -D

bash

yarn add material-design-icons-iconfont -D

bash

npm install material-design-icons-iconfont -D

bash

bun add material-design-icons-iconfont -D

:::

import 'material-design-icons-iconfont/dist/material-design-icons.css' // Ensure your project is capable of handling css files
import { createVuetify } from 'vuetify'
import { aliases, md } from 'vuetify/iconsets/md'

export default createVuetify({
  icons: {
    defaultSet: 'md',
    aliases,
    sets: {
      md,
    },
  },
})

html

<template>
  <v-icon icon="home" />
</template>

Font Awesome

The easiest way to get started with FontAwesome is to use a CDN.

FA 5 - CSS

html

<link href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" rel="stylesheet">

To install locally you can pull in the free version of FontAwesome using your preferred package manager:

::: tabs

bash

pnpm add @fortawesome/fontawesome-free -D

bash

yarn add @fortawesome/fontawesome-free -D

bash

npm install @fortawesome/fontawesome-free -D

bash

bun add @fortawesome/fontawesome-free -D

:::

import '@fortawesome/fontawesome-free/css/all.css' // Ensure your project is capable of handling css files
import { createVuetify } from 'vuetify'
import { aliases, fa } from 'vuetify/iconsets/fa'

export default createVuetify({
  icons: {
    defaultSet: 'fa',
    aliases,
    sets: {
      fa,
    },
  },
})

html

<template>
  <v-icon icon="fas fa-home" />
</template>

::: error

The JavaScript version (all.js) of the FontAwesome icons will NOT work with Vue

:::

FA 4 - CSS

The easiest way to get started with FontAwesome is to use a CDN.

html

<link href="https://cdn.jsdelivr.net/npm/[email protected]/css/font-awesome.min.css" rel="stylesheet">

To install FontAwesome 4 locally is the same as its newer version, just from a different package. You will be using the font-awesome package as opposed to @fortawesome.

::: tabs

bash

pnpm add [email protected] -D

bash

yarn add [email protected] -D

bash

npm install [email protected] -D

bash

bun add [email protected] -D

:::

import 'font-awesome/css/font-awesome.min.css' // Ensure your project is capable of handling css files
import { createVuetify } from 'vuetify'
import { aliases, fa } from 'vuetify/iconsets/fa4'

export default createVuetify({
  icons: {
    defaultSet: 'fa',
    aliases,
    sets: {
      fa,
    },
  },
})

html

<template>
  <v-icon icon="fa-check" />
</template>

FA 5 - SVG

Install the following packages.

::: tabs

bash

pnpm add @fortawesome/fontawesome-svg-core @fortawesome/vue-fontawesome @fortawesome/free-solid-svg-icons @fortawesome/free-regular-svg-icons -D

bash

yarn add @fortawesome/fontawesome-svg-core @fortawesome/vue-fontawesome @fortawesome/free-solid-svg-icons @fortawesome/free-regular-svg-icons -D

bash

npm install @fortawesome/fontawesome-svg-core @fortawesome/vue-fontawesome @fortawesome/free-solid-svg-icons @fortawesome/free-regular-svg-icons -D

bash

bun add @fortawesome/fontawesome-svg-core @fortawesome/vue-fontawesome @fortawesome/free-solid-svg-icons @fortawesome/free-regular-svg-icons -D

:::

Then register the global font-awesome-icon component and use the pre-defined fa-svg icon set. If you have access to Font Awesome Pro icons they can be added to the library in the same way.

import { createApp } from 'vue'
import { createVuetify } from 'vuetify'
import { aliases, fa } from 'vuetify/iconsets/fa-svg'
import { library } from '@fortawesome/fontawesome-svg-core'
import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'
import { fas } from '@fortawesome/free-solid-svg-icons'
import { far } from '@fortawesome/free-regular-svg-icons'

const app = createApp()

app.component('font-awesome-icon', FontAwesomeIcon) // Register component globally
library.add(fas) // Include needed solid icons
library.add(far) // Include needed regular icons

const vuetify = createVuetify({
  icons: {
    defaultSet: 'fa',
    aliases,
    sets: {
      fa,
    },
  },
})

app.use(vuetify)

app.mount('#app')

html

<template>
  <v-icon icon="fas fa-home" />
</template>

Icon aliases

Icon aliases allow you to define short, reusable names for icons that can map to different sources — such as icon names from a set, local Vue components, or raw SVG paths. Aliases are referenced with an initial $ followed by the name of the alias, e.g. $product. The following icons are available as aliases for use in Vuetify components:

Custom aliases

If you are developing custom Vuetify components, you can extend the aliases object to utilize the same functionality that internal Vuetify components use. This makes it easier to manage icons consistently throughout your project.

Here’s an example:

import { createVuetify } from 'vuetify'
import AccountIcon from './account-icon.vue'
import ClosetIcon from './closet-icon.vue'

export const customIcons = {
  mdiCustomAlias: 'mdi-tag',
  account: AccountIcon,
  annotation: [
    'M14 9.45h-1v-1a1 1 0 0 0-2 0v1h-1a1 1 0 0 0 0 2h1v1a1 1 0 0 0 2 0v-1h1a1 1 0 0 0 0-2Zm6.46.18A8.5 8.5 0 1 0 6 16.46l5.3 5.31a1 1 0 0 0 1.42 0L18 16.46a8.46 8.46 0 0 0 2.46-6.83Zm-3.86 5.42l-4.6 4.6l-4.6-4.6a6.49 6.49 0 0 1-1.87-5.22A6.57 6.57 0 0 1 8.42 5a6.47 6.47 0 0 1 7.16 0a6.57 6.57 0 0 1 2.89 4.81a6.49 6.49 0 0 1-1.87 5.24Z',
  ],
  closet: ClosetIcon,
}

export const vuetify = createVuetify({
  theme: {
    defaultTheme: 'light',
    //
  },
  icons: {
    defaultSet: 'mdi',
    aliases: {
      ...customIcons,
    },
  },
})

html

<template>
  <v-btn prepend-icon="$account">Custom Icon 1</v-btn>
  <v-btn prepend-icon="$mdiCustomAlias">Custom Icon 2</v-btn>
  <v-btn prepend-icon="$closet">Custom Icon 3</v-btn>
  <v-btn prepend-icon="$annotation">Custom Icon 4</v-btn>
  <v-btn prepend-icon="mdi-close">Default MDI Icon</v-btn>
</template>

In this setup:

$account and $closet render your own Vue component SVG icons.
$mdiCustomAlias references an alias for the mdi-tag icon.
$annotation references inline SVG path data.

This approach gives you flexibility: you can mix external libraries with your own icons seamlessly, while keeping your templates cleaner and easier to maintain.

Multiple icon sets

Out of the box, Vuetify supports the use of multiple different icon sets at the same time. The following example demonstrates how to change the default icon font to Font Awesome (fa) while still maintaining access to the original Material Design Icons (mdi) through the use of a prefix:

import { createVuetify } from 'vuetify'
import { aliases, fa } from 'vuetify/iconsets/fa'
import { mdi } from 'vuetify/iconsets/mdi'

export default createVuetify({
  icons: {
    defaultSet: 'fa',
    aliases,
    sets: {
      fa,
      mdi,
    },
  },
})

html

<template>
  <v-icon icon="fas fa-plus" /> // This renders a FontAwesome icon
  <v-icon icon="mdi:mdi-minus" /> // This renders a MDI icon
</template>

::: info

It is not necessary to provide a prefix (such as mdi:) for icons from the default icon set

:::

Creating a custom icon set

An icon set consists of an object with one property component which should be a functional component that receives props of type IconsProps, and renders an icon.

In order to use a custom set as the default icon set, you must also add the necessary aliases that correspond to values used by Vuetify components.

import { h } from 'vue'
import type { IconSet, IconAliases, IconProps } from 'vuetify'

const aliases: IconAliases = {
  collapse: '...',
  complete: '...',
  cancel: '...',
  close: '...',
  delete: '...',
  clear: '...',
  success: '...',
  info: '...',
  warning: '...',
  error: '...',
  prev: '...',
  next: '...',
  checkboxOn: '...',
  checkboxOff: '...',
  checkboxIndeterminate: '...',
  delimiter: '...',
  sortAsc: '...',
  sortDesc: '...',
  sort: '...',
  expand: '...',
  menu: '...',
  subgroup: '...',
  dropdown: '...',
  radioOn: '...',
  radioOff: '...',
  edit: '...',
  ratingEmpty: '...',
  ratingFull: '...',
  ratingHalf: '...',
  loading: '...',
  first: '...',
  last: '...',
  unfold: '...',
  file: '...',
  plus: '...',
  minus: '...',
  calendar:  '...',
}

const custom: IconSet = {
  component: (props: IconProps) => h(...),
}

export { aliases, custom }

import { createVuetify } from 'vuetify'
import { aliases, custom } from '../iconsets/custom'

export default createVuetify({
  icons: {
    defaultSet: 'custom',
    aliases,
    sets: {
      custom,
    },
  },
})