@heroicons/vue

What is @heroicons/vue?

@heroicons/vue is a Vue.js library that provides a collection of free, high-quality SVG icons. These icons are designed to be simple and easy to use in Vue.js applications. The package includes both outline and solid icons, making it versatile for different design needs.

What are @heroicons/vue's main functionalities?

Outline Icons

This feature allows you to use outline icons in your Vue.js application. The example demonstrates how to import and use an outline icon named 'academic-cap'.

<template>
  <div>
    <HeroIcon name="academic-cap" outline />
  </div>
</template>

<script>
import { HeroIcon } from '@heroicons/vue/outline';

export default {
  components: {
    HeroIcon
  }
};
</script>

Solid Icons

This feature allows you to use solid icons in your Vue.js application. The example demonstrates how to import and use a solid icon named 'academic-cap'.

<template>
  <div>
    <HeroIcon name="academic-cap" solid />
  </div>
</template>

<script>
import { HeroIcon } from '@heroicons/vue/solid';

export default {
  components: {
    HeroIcon
  }
};
</script>

Customizable Icons

This feature allows you to customize the size and color of the icons. The example demonstrates how to apply custom classes to an outline icon to change its size and color.

<template>
  <div>
    <HeroIcon name="academic-cap" outline class="w-6 h-6 text-blue-500" />
  </div>
</template>

<script>
import { HeroIcon } from '@heroicons/vue/outline';

export default {
  components: {
    HeroIcon
  }
};
</script>

Other packages similar to @heroicons/vue

vue-feather-icons

vue-feather-icons is a Vue.js library that provides a collection of simple and elegant icons. Similar to @heroicons/vue, it offers a variety of icons that can be easily integrated into Vue.js applications. However, the design style of Feather Icons is more minimalistic compared to Heroicons.

vue-fontawesome

vue-fontawesome is a Vue.js library that allows you to use Font Awesome icons in your Vue.js applications. It offers a much larger collection of icons compared to @heroicons/vue, including both free and premium icons. Font Awesome icons are more detailed and come in various styles such as solid, regular, and brands.

vue-material-design-icons

vue-material-design-icons is a Vue.js library that provides a collection of Material Design icons. These icons follow Google's Material Design guidelines and offer a different aesthetic compared to Heroicons. The library is extensive and includes icons for a wide range of use cases.

README

Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.

Browse at Heroicons.com →

Basic Usage

First, install @heroicons/vue from npm:

npm install @heroicons/vue

Now each icon can be imported individually as a Vue component:

<template>
  <div>
    <BeakerIcon class="size-6 text-blue-500" />
    <p>...</p>
  </div>
</template>

<script setup>
import { BeakerIcon } from '@heroicons/vue/24/solid'
</script>

The 24x24 outline icons can be imported from @heroicons/vue/24/outline, the 24x24 solid icons can be imported from @heroicons/vue/24/solid, the 20x20 solid icons can be imported from @heroicons/vue/20/solid, and the 16x16 solid icons can be imported from @heroicons/vue/16/solid.

Icons use an upper camel case naming convention and are always suffixed with the word Icon.

Browse the full list of icon names on UNPKG →

Contributing

While we absolutely appreciate anyone's willingness to try and improve the project, we're currently only interested in contributions that fix bugs, for example things like incorrect TypeScript types, or fixing an icon that's been exported with a fill instead of a stroke, etc.

We're not accepting contributions for new icons or adding support for other frameworks like Svelte or SolidJS. Instead we encourage you to release your own icons in your own library, and create your own packages for any other frameworks you'd like to see supported.

License

This library is MIT licensed.

Changelog

[2.2.0] - 2024-11-18

Added

• Add React 19 support (#1247)

Fixed

• Removed unnecessary clipping path from solid/arrow-left-circle (#1211)