heroicons README

The project's README from github.com/tailwindlabs/heroicons. As one markdown file: README.md.

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:

<svg
  class="size-6 text-gray-500"
  fill="none"
  viewBox="0 0 24 24"
  stroke="currentColor"
  stroke-width="2"
>
  <path
    stroke-linecap="round"
    stroke-linejoin="round"
    d="M12 8v4l3 3m6-3a9 9 0 11-18 0 9 9 0 0118 0z"
  />
</svg>

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:

npm install @heroicons/react

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

import { BeakerIcon } from '@heroicons/react/24/solid'

function MyComponent() {
  return (
    <div>
      <BeakerIcon className="size-6 text-blue-500" />
      <p>...</p>
    </div>
  )
}

The 24x24 outline icons can be imported from @heroicons/react/24/outline, the 24x24 solid icons can be imported from @heroicons/react/24/solid, the 20x20 solid icons can be imported from @heroicons/react/20/solid, and 16x16 solid icons can be imported from @heroicons/react/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 →

Vue

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.

heroicons (tailwindlabs/heroicons)

Searching Database…

23.9K ·GitHub
Heroicons
Что это такое?Heroicons — это набор бесплатных, вручную нарисованных SVG-иконок под лицензией MIT для разработки интерфейсов. Его создали авторы Tailwind CSS. Иконки доступны как обычные SVG-файлы или как библиотеки компонентов для React и Vue, которые выпускают сами авторы.
Это UI-фреймворк или просто набор иконок?Это только библиотека иконок, а не UI-фреймворк: обычные SVG-файлы и пакеты компонентов для React и Vue. Стиль иконок вы задаёте сами, устанавливая свойство CSS color, при желании с помощью утилитарных классов Tailwind.
Как добавить эти иконки в проект?Для React или Vue выполните npm install @heroicons/react (или @heroicons/vue) и импортируйте каждую иконку как компонент, например из @heroicons/react/24/outline. Для обычного HTML просто скопируйте SVG-код нужной иконки с heroicons.com и вставьте его прямо в страницу.
Можно ли добавить новые иконки или поддержку других фреймворков, например Svelte?Нет. Мейнтейнеры принимают только вклады, которые исправляют ошибки, например неверные типы TypeScript или иконку, экспортированную с fill вместо stroke. Новые иконки и поддержка таких фреймворков, как Svelte или SolidJS, не принимаются; для этого нужно публиковать собственную библиотеку.
Какие размеры и стили иконок есть в Heroicons?Есть четыре варианта: контурные 24x24, сплошные 24x24, сплошные 20x20 и сплошные 16x16. Каждый импортируется из своего подпути, например @heroicons/react/24/outline.
Как называются компоненты иконок?Названия записываются в UpperCamelCase и всегда заканчиваются словом «Icon», например BeakerIcon.
Где посмотреть все доступные названия иконок?Полный список названий можно просмотреть на UNPKG или визуально на heroicons.com.
What are similar projects?tabler-icons, Font-Awesome, simple-icons, react-icons, material-design-icons, MaterialDesign, css.gg, drawably
Which topics is it in?svg-icons, icon-pack, icons, svg, tailwindcss, component-library, design, vue, ui-components, css, ui, react
Creator
tailwindlabs
Size
2.6 MB
Stars
23.9K
Updated
CommitMay 12Releasev2.2.0Nov 18
Age
6y
Commits · 90 Days