5.3.0 • Published 4 months ago

react-icons v5.3.0

Weekly downloads
681,366
License
MIT
Repository
github
Last release
4 months ago

React Icons

npm

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)

yarn add react-icons
# or
npm install react-icons --save

example usage

import { FaBeer } from "react-icons/fa";

function Question() {
  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';

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.

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

example usage

import { FaBeer } from "@react-icons/all-files/fa/FaBeer";

function Question() {
  return (
    <h3>
      Lets go for a <FaBeer />?
    </h3>
  );
}

Icons

Icon LibraryLicenseVersionCount
Circum IconsMPL-2.0 license1.0.0288
Font Awesome 5CC BY 4.0 License5.15.4-3-gafecf2a1612
Font Awesome 6CC BY 4.0 License6.5.22045
Ionicons 4MIT4.6.3696
Ionicons 5MIT5.5.41332
Material Design iconsApache License Version 2.04.0.0-98-g9beae745bb4341
TypiconsCC BY-SA 3.02.1.2336
Github Octicons iconsMIT18.3.0264
FeatherMIT4.29.1287
LucideISCv5.1.0-6-g438f572e1215
Game IconsCC BY 3.012920d6565588f0512542a3cb0cdfd36a497f9104040
Weather IconsSIL OFL 1.12.0.12219
DeviconsMIT1.8.0192
Ant Design IconsMIT4.4.2831
Bootstrap IconsMIT1.11.32716
Remix IconApache License Version 2.04.2.02860
Flat Color IconsMIT1.0.2329
Grommet-IconsApache License Version 2.04.12.1635
HeroiconsMIT1.0.6460
Heroicons 2MIT2.1.3888
Simple IconsCC0 1.0 Universal12.14.03209
Simple Line IconsMIT2.5.5189
IcoMoon FreeCC BY 4.0 Licensed006795ede82361e1bac1ee76f215cf1dc51e4ca491
BoxIconsMIT2.1.41634
css.ggMIT2.1.1704
VS Code IconsCC BY 4.00.0.35461
Tabler IconsMIT3.2.05237
Themify IconsMITv0.1.2-2-g9600186352
Radix IconsMIT@radix-ui/react-icons@1.3.0-1-g94b3fcf318
Phosphor IconsMIT2.1.19072
Icons8 Line AwesomeMIT1.3.11544

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.

import { IconContext } from "react-icons";

<IconContext.Provider value={{ color: "blue", className: "global-class-name" }}>
  <div>
    <FaFolder />
  </div>
</IconContext.Provider>;
KeyDefaultNotes
colorundefined (inherit)
size1em
classNameundefined
styleundefinedCan overwrite size and color
attrundefinedOverwritten by other attributes
titleundefinedIcon description for accessibility

Migrating from version 2 -> 3

Change import style

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.

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

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

Global className Styling

Component

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

CSS

.react-icons {
  vertical-align: middle;
}

TypeScript native support

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

Yarn

yarn remove @types/react-icons

NPM

npm remove @types/react-icons

Contributing

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

Development

yarn
cd packages/react-icons
yarn fetch  # fetch icon sources
yarn 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.

cd packages/react-icons
yarn fetch
yarn build

cd ../preview-astro
yarn start

Demo

The 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 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

Licence

MIT

  • Icons are taken from the other projects so please check each project licences accordingly.
visual-react-uivite-test-libchatlist@isaaczafuta/ui@asmel/panda-ui@caravinci/arranger-components@banditbadgod/react@moai/core@pubngo-stack/reservation-api-browser@pubngo-stack/property-module-browser@pubngo-stack/icons@pubngo-stack/messenger-api-browser@stattrack/widget_remove-me@nbundle/react@jvfmatos/templatecomponent@revizio/ui@dafunda-ui-testing/react-icon@dafunda-ui-alpha/react-icon@fanbase-sdk/dex-widget@visibly/vui@vjbhang/shared-componentsclamav-desktopcreate-xpress-templateatx-filemanager@contiago/toolbar@borderfreefinancial/local-react-chat@borderfreefinancial/prod-react-chat@borderfreefinancial/qa-react-chat@borderfreefinancial/dev-react-chat@do-killer/dodo-wallet2darkonium-widgetsdemocensadependency-builderdependency-builder-betadependency-builder-sprinklrcodemirror_editor_publishcodemirror_idedafunda-ui-reactdashboardcomponentsperfiosdashbuilderbullseye-storiesjk-crowdin-libtest-npm-programerika@andromeda-ui/button@andromeda-ui/input@andromeda-ui/paginate@andromeda-ui/popover@andromeda-ui/tooltipreact-awesome-custom-carouselgatsby-developer-themebootflex2resource-centerreact-employee-dropdown1react-img-pickerreact-highlight-searchbox@lintondev/ui-kit@rowsncolumns/spreadsheetdiva-auth-reactugrowth-dash-uiugrowth-ui@lucasbarcelos/gatsby-theme-mercadolibre-store-custom@chatboss.development/webchatreact-chat-elements-alejoisnoisno-components@cangir/gatsby-blog-coretarnet-jumbo-reactnghia-test-package@smartassdesign/gatsby-theme-themifyfiremind-react-datatablesgatsby-theme-sky-lite-mastersebrae-react-scripts@aliasliao/pat-common@njradford/libs@insync-stageplayer/uidokkiperfecttense-editor-developvsnodetribe-react-ui@one-builder/gatsby-theme-ob-masterhercules-design-system@sadorlovsky/currency-convertergatsby-theme-ob-masterastrid-apptenzir-ui-componentsdelivery-flow-chartmaterial-rely@invisible/ui@valearna/graphical-curationjsn_web2gatsby-theme-ghost-reloadedbootstrap-multiselect-boxcrm-apprah_image_classification_prototypereact-jinke-music-player-no-mobilestate-designer-docspaku-chatsanity-plugin-schema-chodesccaulle-uigatsby-universal
5.3.0

4 months ago

5.2.1

7 months ago

5.2.0

7 months ago

5.1.0

8 months ago

5.0.1

11 months ago

5.0.0

11 months ago

4.12.0

1 year ago

4.9.0

2 years ago

4.10.1

1 year ago

4.10.0

1 year ago

4.11.0

1 year ago

4.8.1-snapshot.0

2 years ago

4.8.1-snapshot.1

2 years ago

4.8.1-snapshot.2

2 years ago

4.8.0

2 years ago

4.7.1

2 years ago

4.6.0

2 years ago

4.4.0

3 years ago

4.3.1

3 years ago

4.3.0

3 years ago

4.2.0

4 years ago

4.1.0

4 years ago

4.0.0

4 years ago

3.11.0

4 years ago

3.10.0

5 years ago

3.9.0

5 years ago

3.8.0

5 years ago

3.7.0

6 years ago

3.6.1

6 years ago

3.6.0

6 years ago

3.6.0-beta2

6 years ago

3.6.0-beta1

6 years ago

3.5.0

6 years ago

3.4.0

6 years ago

3.3.0

6 years ago

3.2.2

6 years ago

3.2.1

6 years ago

3.2.0

6 years ago

3.1.0

6 years ago

3.1.0-beta.1

6 years ago

3.0.5

6 years ago

3.0.4

6 years ago

3.0.3

6 years ago

3.0.2

6 years ago

3.0.1

6 years ago

3.0.0

6 years ago

3.0.0-beta.5

6 years ago

3.0.0-beta.4

6 years ago

3.0.0-beta.3

6 years ago

3.0.0-beta.2

6 years ago

3.0.0-beta.1

6 years ago

2.2.7

7 years ago

2.2.6

7 years ago

2.2.5

8 years ago

2.2.4

8 years ago

2.2.3

8 years ago

2.2.2

8 years ago

2.2.1

8 years ago

2.2.0

8 years ago

2.1.0

9 years ago

2.0.1

9 years ago

2.0.0

9 years ago

1.0.6

9 years ago

1.0.5

9 years ago

1.0.3

9 years ago

1.0.2

9 years ago

1.0.1

9 years ago

1.0.0

9 years ago

0.3.1

9 years ago

0.3.0

9 years ago

0.2.2

9 years ago

0.2.1

9 years ago

0.2.0

9 years ago

0.1.5

9 years ago

0.1.4

9 years ago

0.1.3

9 years ago

0.1.2

9 years ago

0.1.0

9 years ago

0.0.4

9 years ago

0.0.3

9 years ago

0.0.2

9 years ago

0.0.1

9 years ago