@heroicons/react
Advanced tools
Package description
@heroicons/react is a React library that provides a set of free, MIT-licensed high-quality SVG icons. These icons are designed to be used in web applications and are available in both outline and solid styles.
Outline Icons
This feature allows you to use outline style icons in your React application. The code sample demonstrates how to import and use the `BeakerIcon` from the `@heroicons/react/outline` package.
import { BeakerIcon } from '@heroicons/react/outline';
function Example() {
return <BeakerIcon className="h-6 w-6 text-blue-500" />;
}Solid Icons
This feature allows you to use solid style icons in your React application. The code sample demonstrates how to import and use the `BeakerIcon` from the `@heroicons/react/solid` package.
import { BeakerIcon } from '@heroicons/react/solid';
function Example() {
return <BeakerIcon className="h-6 w-6 text-blue-500" />;
}Customizable Icons
This feature allows you to customize the size and color of the icons. The code sample demonstrates how to change the size and color of the `BeakerIcon`.
import { BeakerIcon } from '@heroicons/react/outline';
function Example() {
return <BeakerIcon className="h-8 w-8 text-red-500" />;
}react-icons provides a comprehensive set of icons from various icon libraries such as Font Awesome, Material Design, and more. It offers a wider variety of icons compared to @heroicons/react but may not have the same design consistency.
material-ui/icons is a package that provides Material Design icons for use with Material-UI. It offers a large set of icons that are consistent with the Material Design guidelines, making it a good choice for applications that follow this design language.
fontawesome is a popular icon library that offers a vast collection of icons in different styles (solid, regular, light, duotone, and brands). It provides more variety and customization options compared to @heroicons/react but requires a subscription for access to all features.
Readme
Beautiful hand-crafted SVG icons, by the makers of Tailwind CSS.
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 →
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.
This library is MIT licensed.
FAQs
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/heroicons/HEAD/.github/logo-dark.svg"> <source media="(pref
The npm package @heroicons/react receives a total of 785,113 weekly downloads. As such, @heroicons/react popularity was classified as popular.
We found that @heroicons/react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.