react-flaticons
v1.1.5
Published
A React component library that provides easy access to free vector icons from the Flaticon website.
Downloads
1,215
Maintainers
Readme
React Flaticons
🎉 Icon fonts for any project, big or small!
React Flaticons is a React library that allows you to easily add free vector icons from the Uicons website to your React projects. With over 1000 icons (and growing to more than 13,000), you're sure to find the perfect icon for your project.
🎨 Customize your icons!
With React Flaticons, you can easily customize your icons to match your project's design. Change the color and size of your icons with just a few lines of code.
💻 Use with React Context!
React Flaticons also supports React Context, allowing you to customize the settings for all of your icons at once.
🆕 Always adding more icons!
We're always adding new icons to React Flaticons, so you can stay up to date with the latest trends and design styles.
👨💻 Made for developers, by developers!
React Flaticons was designed with developers in mind, making it easy to use and integrate into your existing projects.
🤝 Join our community!
Join our community of developers on GitHub and contribute to the ongoing development of React Flaticons.
Installation
You can install react-flaticons via npm:
npm install react-flaticons
Usage
To use a Flaticon icon in your React component, import the desired icon from the react-flaticons package and use it like this:
import { ShoppingCart } from 'react-flaticons';
function MyComponent() {
return <ShoppingCart />;
}
You can also customize the size and color of the icon by passing in color
and size
props:
import { ShoppingCart } from 'react-flaticons';
function MyComponent() {
return <ShoppingCart color='red' size='32px' />;
}
Additionally, you can use the IconContext
component from react-flaticons to set custom icon styles for all icons in your app:
import { IconContext } from 'react-flaticons';
function App() {
return (
<IconContext.Provider value={{ color: 'red', size: '32px' }}>
<div>
<ShoppingCart />
<OtherComponent />
</div>
</IconContext.Provider>
);
}
Available Icons
react-flaticons currently includes all the free Uicons Regular Rounded icons, which you can browse and search on the Uicons website. Simply search for the icon you want, click on it to view its details page, and copy the icon name (e.g. "Shopping Cart") to use it in your React component.
We're planning to add support for other Uicons weights soon, as well as additional icon sets in the future. This project is constantly evolving and we appreciate your feedback and contributions.
License
react-flaticons is licensed under the MIT License.
Contributing
If you find a bug or have a feature request, please create an issue on GitHub. Pull requests are also welcome!
Credits
This library is based on the excellent Flaticon website, which provides a wide variety of free vector icons. Thank you to Flaticon and its contributors for making these icons available to the public.