Include popular icons in your React projects easily with react-icons, which utilizes ES6 imports that allows you to include only the icons that your project is using.
This repository is an accessibility focused version of the original react-icons library. It is a fork of the original react-icons library with the following changes:
- All icons are exported as
<svg>elements with a<title>tag which defaults to "Icon" if no title is provided by the developer. - Build scripts have been added and modified to streamline setup and contribution.
yarn add @accessitech/react-icons
# or
npm install @accessitech/react-icons --saveimport { IconContext } from "@accessitech/react-icons";
import { FaBeer } from "@accessitech/react-icons/fa";
function Question() {
return (
<IconContext.Provider>
<h3>
Lets go for a <FaBeer />?
</h3>
</IconContext.Provider>
);
}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';
Icon components are named by their camelCase equivalent and have the same props as the original react-icons library.
interface IconBaseProps extends React.SVGAttributes<SVGElement> {
children?: React.ReactNode;
size?: string | number;
color?: string;
title?: string;
}| Key | Default | Notes |
|---|---|---|
color |
undefined (inherit) |
|
size |
1em |
|
className |
undefined |
|
style |
undefined |
Can overwrite size and color |
attr |
undefined |
Overwritten by other attributes |
title |
undefined |
Icon description for accessibility |
The IconContext.Provider component allows you to easily customize the props of all child icon components usingReact Context API, and has the same props as the original react-icons library.
interface IconContext {
color?: string;
size?: string;
className?: string;
style?: React.CSSProperties;
attr?: React.SVGAttributes<SVGElement>;
}| Key | Default | Notes |
|---|---|---|
color |
undefined (inherit) |
|
size |
1em |
|
className |
undefined |
|
style |
undefined |
Can overwrite size and color |
attr |
undefined |
Overwritten by other attributes |
You can add more icons by submitting pull requests or creating issues.
./build-script.sh will build the whole project. See also CI scripts for more information.
yarn
cd packages/react-icons
yarn fetch # fetch icon sources
yarn buildThe preview site is the react-icons website, built in NextJS.
cd packages/react-icons
yarn fetch
yarn build
cd ../preview
yarn startThe demo is a Create React App boilerplate with react-icons added as a dependency for easy testing.
cd packages/react-icons
yarn fetch
yarn build
cd ../demo
yarn startTo build everything, run ./build-script.sh or yarn build.
SVG 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.
Import path has changed. You need to rewrite from the old style.
// OLD IMPORT STYLE
import FaBeer from "react-icons/lib/fa/beer";
function Question() {
return (
<h3>
Lets go for a <FaBeer />?
</h3>
);
}// NEW IMPORT STYLE
import { FaBeer } from "react-icons/fa";
function Question() {
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 specify an inline style.
<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>Component
<IconContext.Provider value={{ className: 'react-icons' }}>CSS
.react-icons {
vertical-align: middle;
}Dependencies on @types/react-icons can be deleted.
yarn remove @types/react-iconsnpm remove @types/react-iconsMIT
- Icons are taken from the other projects so please check each project licences accordingly.