Heroicons

A set of free MIT-licensed high-quality SVG icons for UI development.

README

Heroicons Heroicons

Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.
Available as basic SVG icons and via first-party React and Vue libraries.

Browse at Heroicons.com →

Latest Release License



Basic Usage


The quickest way to use these icons is to simply copy the source for the icon you need from heroicons.com and inline it directly into your HTML:

  1. ``` html
  2. <svg class="h-6 w-6 text-gray-500" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2">
  3.   <path
  4.     stroke-linecap="round"
  5.     stroke-linejoin="round"
  6.     d="M12 8v4l3 3m6-3a9 9 0 11-18 0 9 9 0 0118 0z"
  7.   />
  8. </svg>
  9. ```

Both icon styles are preconfigured to be stylable by setting the color CSS property, either manually or using utility classes like text-gray-500 in a framework like Tailwind CSS.

React


First, install @heroicons/react from npm:

  1. ```sh
  2. npm install @heroicons/react
  3. ```

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

  1. ``` js
  2. import { BeakerIcon } from '@heroicons/react/24/solid'

  3. function MyComponent() {
  4.   return (
  5.     <div>
  6.       <BeakerIcon className="h-6 w-6 text-blue-500"/>
  7.       <p>...</p>
  8.     </div>
  9.   )
  10. }
  11. ```

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

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



Vue


Note that this library currently only supports Vue 3.

First, install @heroicons/vue from npm:

  1. ```sh
  2. npm install @heroicons/vue
  3. ```

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

  1. ```vue
  2. <template>
  3.   <div>
  4.     <BeakerIcon class="h-6 w-6 text-blue-500"/>
  5.     <p>...</p>
  6.   </div>
  7. </template>
  8. <script>
  9. import { BeakerIcon } from '@heroicons/vue/24/solid'

  10. export default {
  11.   components: { BeakerIcon }
  12. }
  13. </script>
  14. ```

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

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


License


This library is MIT licensed.