Include popular icons in your React projects easly with react-icons, which utilizes ES6 imports that allows you to include only the icons that your project is using.
npm install react-icons --saveimport { FaBeer } from 'react-icons/fa';
class Question extends React.Component {
render() {
return <h3> Lets go for a <FaBeer />? </h3>
}
}View the documentation for further usage examples and how to use icons from other packages. NOTE: each Icon package has it's own subfolder under react-icons you import from.
For example, to use an icon from Material Design, your import would be: import { ICON_NAME } from 'react-icons/md';
- Font Awesome License: CC BY 4.0 License
- Ionicons License: MIT
- Material Design icons License: Apache License Version 2.0
- Typicons License: CC BY-SA 3.0
- Github Octicons icons License: MIT
- Feather License: MIT
- Game Icons License: CC BY 3.0
- Weather Icons License: SIL OFL 1.1
You can add more icons by submitting pull requests or creating issues.
You can configure react-icons props using React context API.
requirement React 16.3 or higher.
import { IconContext } from "react-icons";
<IconContext.Provider value={{ color: "blue", className: "global-class-name" }}>
<div>
<FaFolder />
</div>
</IconContext.Provider>| key | default | memo |
|---|---|---|
| color | undefined(inherit) | |
| size | 1em | |
| className | undefined | |
| style | undefined | can overwrite size and color |
| attr | undefined | overwritten by other attributes |
Import path has changed. You need to rewrite from the old style.
// OLD IMPORT STYLE
import FaBeer from 'react-icons/lib/fa/beer';
class Question extends React.Component {
render() {
return <h3> Lets go for a <FaBeer />? </h3>
}
}// NEW IMPORT STYLE
import { FaBeer } from 'react-icons/fa';
class Question extends React.Component {
render() {
return <h3> Lets go for a <FaBeer />? </h3>
}
}Ending up with a large JS bundle? Check out this issue.
From version 3, vertical-align: middle is not automatically given.
Please use IconContext to specify className or style.
example for global styling
<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>example for give global className
// app.tsx
<IconContext.Provider value={{ className: 'react-icons' }}>
// app.css
.react-icons {
vertical-align: middle;
}Dependencies on @types/react-icons can be deleted.
npm remove @types/react-iconsdevelopment
yarn
yarn submodule # fetch icon sources
cd packages/react-icons
yarn buildscripts for run demo
cd packages/react-icons
yarn build
cd ../demo
yarn startrun preview site
cd packages/react-icons
yarn build
cd ../preview
yarn startSvg is supported by all major browsers.
With react-icons, you can serve only the needed icons instead of one big font file to the users, helping you to recognize which icons are used in your project.
MIT
- Icons are taken from the other projects so please check each project licences accordingly.