npmpackage.info

react-icons

svg react icons of popular icon packs

5.3.0

11,688

NOASSERTION

TypeScript

2.21 kB

343,361,789 2.8

Installations

npm install react-icons

Pull Requests

Open

37

Total

311

Closed

107

Merged

167

Issues

Open

165

Total

591

Closed

426

Releases

v5.3.0

Published on 13 Aug 2024

v5.2.1

Published on 02 May 2024

v5.2.0

Published on 01 May 2024

v5.1.0

Published on 15 Apr 2024

v5.0.1

Published on 11 Jan 2024

v5.0.0

Published on 10 Jan 2024

View all 50 releases

Developer

react-icons

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

18.14.2

NPM Version

9.5.0 Statistics

11,688 Stars

678 Commits

754 Forks

53 Watching

13 Branches

108 Contributors

Updated on 27 Nov 2024

Bundle Size

7.61 kB

Minified

2.21 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (61.7%)

JavaScript (13.5%)

SCSS (10.15%)

Astro (9.56%)

HTML (3.13%)

CSS (1.39%)

Shell (0.57%)

Total Downloads

Cumulative downloads

Total Downloads

343,361,789

Last day

-1.4%

482,610

Compared to previous day

Last week

3.8%

2,621,354

Compared to previous week

Last month

10.3%

10,836,386

Compared to previous month

Last year

31.6%

109,128,062

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

react

Versions

React Icons

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.

Installation (for standard modern project)

1yarn add react-icons
2# or
3npm install react-icons --save

example usage

1import { FaBeer } from "react-icons/fa";
2
3function Question() {
4  return (
5    <h3>
6      Lets go for a <FaBeer />?
7    </h3>
8  );
9}

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';

Installation (for meteorjs, gatsbyjs, etc)

Note This option has not had a new release for some time. More info https://github.com/react-icons/react-icons/issues/593

If your project grows in size, this option is available. This method has the trade-off that it takes a long time to install the package.

1yarn add @react-icons/all-files
2# or
3npm install @react-icons/all-files --save

example usage

1import { FaBeer } from "@react-icons/all-files/fa/FaBeer";
2
3function Question() {
4  return (
5    <h3>
6      Lets go for a <FaBeer />?
7    </h3>
8  );
9}

Icons

Icon Library	License	Version	Count
Circum Icons	MPL-2.0 license	1.0.0	288
Font Awesome 5	CC BY 4.0 License	5.15.4-3-gafecf2a	1612
Font Awesome 6	CC BY 4.0 License	6.5.2	2045
Ionicons 4	MIT	4.6.3	696
Ionicons 5	MIT	5.5.4	1332
Material Design icons	Apache License Version 2.0	4.0.0-98-g9beae745bb	4341
Typicons	CC BY-SA 3.0	2.1.2	336
Github Octicons icons	MIT	18.3.0	264
Feather	MIT	4.29.1	287
Lucide	ISC	v5.1.0-6-g438f572e	1215
Game Icons	CC BY 3.0	12920d6565588f0512542a3cb0cdfd36a497f910	4040
Weather Icons	SIL OFL 1.1	2.0.12	219
Devicons	MIT	1.8.0	192
Ant Design Icons	MIT	4.4.2	831
Bootstrap Icons	MIT	1.11.3	2716
Remix Icon	Apache License Version 2.0	4.2.0	2860
Flat Color Icons	MIT	1.0.2	329
Grommet-Icons	Apache License Version 2.0	4.12.1	635
Heroicons	MIT	1.0.6	460
Heroicons 2	MIT	2.1.3	888
Simple Icons	CC0 1.0 Universal	12.14.0	3209
Simple Line Icons	MIT	2.5.5	189
IcoMoon Free	CC BY 4.0 License	d006795ede82361e1bac1ee76f215cf1dc51e4ca	491
BoxIcons	MIT	2.1.4	1634
css.gg	MIT	2.1.1	704
VS Code Icons	CC BY 4.0	0.0.35	461
Tabler Icons	MIT	3.2.0	5237
Themify Icons	MIT	v0.1.2-2-g9600186	352
Radix Icons	MIT	@radix-ui/react-icons@1.3.0-1-g94b3fcf	318
Phosphor Icons	MIT	2.1.1	9072
Icons8 Line Awesome	MIT	1.3.1	1544

You can add more icons by submitting pull requests or creating issues.

Configuration

You can configure react-icons props using React Context API.

Requires React 16.3 or higher.

1import { IconContext } from "react-icons";
2
3<IconContext.Provider value={{ color: "blue", className: "global-class-name" }}>
4  <div>
5    <FaFolder />
6  </div>
7</IconContext.Provider>;

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

Migrating from version 2 -> 3

Change import style

Import path has changed. You need to rewrite from the old style.

1// OLD IMPORT STYLE
2import FaBeer from "react-icons/lib/fa/beer";
3
4function Question() {
5  return (
6    <h3>
7      Lets go for a <FaBeer />?
8    </h3>
9  );
10}

1// NEW IMPORT STYLE
2import { FaBeer } from "react-icons/fa";
3
4function Question() {
5  return (
6    <h3>
7      Lets go for a <FaBeer />?
8    </h3>
9  );
10}

Ending up with a large JS bundle? Check out this issue.

Adjustment CSS

From version 3, vertical-align: middle is not automatically given. Please use IconContext to specify className or specify an inline style.

Global Inline Styling

1<IconContext.Provider value={{ style: { verticalAlign: 'middle' } }}>

Global `className` Styling

Component

1<IconContext.Provider value={{ className: 'react-icons' }}>

CSS

1.react-icons {
2  vertical-align: middle;
3}

TypeScript native support

Dependencies on @types/react-icons can be deleted.

Yarn

1yarn remove @types/react-icons

NPM

1npm remove @types/react-icons

Contributing

./build-script.sh will build the whole project. See also CI scripts for more information.

Development

1yarn
2cd packages/react-icons
3yarn fetch  # fetch icon sources
4yarn build

Add/Update icon set

First, check the discussion to see if anyone would like to add an icon set.

https://github.com/react-icons/react-icons/discussions/categories/new-icon-set

The SVG files to be fetched are managed in this file. Edit this file and run yarn fetch && yarn check && yarn build.

https://github.com/react-icons/react-icons/blob/master/packages/react-icons/src/icons/index.ts

Preview

Note The project is not actively accepting PR for the preview site at this time.

The preview site is the react-icons website, built in Astro+React.

1cd packages/react-icons
2yarn fetch
3yarn build
4
5cd ../preview-astro
6yarn start

Demo

The demo is a Create React App boilerplate with react-icons added as a dependency for easy testing.

1cd packages/react-icons
2yarn fetch
3yarn build
4
5cd ../demo
6yarn start

Why React SVG components instead of fonts?

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.

Related Projects

react-svg-morph

Licence

MIT

Icons are taken from the other projects so please check each project licences accordingly.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

2

Maintained

Determines if the project is "actively maintained".

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-icons

@volvo-cars/react-icons

1.1.0

React Icons

@react-icons/all-files

4.1.0

SVG React icons of popular icon packs using ES6 imports

react-icon-base

2.1.2

base element for react-icons

react-icons-kit

2.0.0

React Icons Kit using various Svg Icon set

react-icons

Installations

Pull Requests

37

311

107

167

Issues

165

591

426

Releases

Developer

Developer Guide

CommonJS, ESM

Yes

18.14.2

9.5.0

Statistics

Bundle Size

7.61 kB

2.21 kB

Languages

Total Downloads

343,361,789

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

React Icons

Installation (for standard modern project)

Installation (for meteorjs, gatsbyjs, etc)

Icons

Configuration

Migrating from version 2 -> 3

Change import style

Adjustment CSS

Global Inline Styling

Global className Styling

TypeScript native support

Yarn

NPM

Contributing

Development

Add/Update icon set

Preview

Demo

Why React SVG components instead of fonts?

Related Projects

Licence

10

10

9

2

1

0

0

0

0

0

0

0

0

2.8

/10

Other packages similar to react-icons

Global `className` Styling