Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/refactoringui/heroicons
A set of free MIT-licensed high-quality SVG icons for UI development.
https://github.com/refactoringui/heroicons
Last synced: 3 months ago
JSON representation
A set of free MIT-licensed high-quality SVG icons for UI development.
- Host: GitHub
- URL: https://github.com/refactoringui/heroicons
- Owner: tailwindlabs
- License: mit
- Created: 2020-02-24T14:16:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T20:09:47.000Z (8 months ago)
- Last Synced: 2024-04-23T09:47:31.601Z (6 months ago)
- Language: JavaScript
- Homepage: https://heroicons.com
- Size: 2.7 MB
- Stars: 20,667
- Watchers: 163
- Forks: 1,256
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-icons - Heroicons - A set of free high-quality SVG icons for you to use in your web projects. ([Website](https://heroicons.dev)) (General)
README
Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.
Available as basic SVG icons and via first-party React and Vue libraries.
## Basic Usage
The quickest way to use these icons is to simply copy the source for the icon you need from [heroicons.com](https://heroicons.com) and inline it directly into your HTML:
```html
```
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](https://tailwindcss.com).
## React
First, install `@heroicons/react` from npm:
```sh
npm install @heroicons/react
```
Now each icon can be imported individually as a React component:
```js
import { BeakerIcon } from '@heroicons/react/24/solid'
function MyComponent() {
return (
...
)
}
```
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 →](https://unpkg.com/browse/@heroicons/react/24/outline/)
## Vue
First, install `@heroicons/vue` from npm:
```sh
npm install @heroicons/vue
```
Now each icon can be imported individually as a Vue component:
```vue
...
import { BeakerIcon } from '@heroicons/vue/24/solid'
```
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 →](https://unpkg.com/browse/@heroicons/vue/24/outline/)
## 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.