Set Up with React

When using Font Awesome with React, we recommend using our official react-fontawesome component to make everything work just right.

Before You Get Started

Make sure you have the following in place:

• A project using React 16.3 or later
• Access configured to use Font Awesome Pro packages
• You are using React and not React Native (that’s a different component)

For Pro+ Icons, Use a Kit Package!

If you’re planning to use Pro+ icons, you’ll need an active Pro+ Plan and a Version 7 Kit with Package Installation enabled. (Kits work great for Pro icons too!)

In this doc, we’ll cover the basics of installing core utility packages, icon installation, and installing the React component, so that you can make awesome stuff your way!

1. Add the React Component

First things first. Let’s install the react-fontawesome component into your project.

React 16.3 and Above!

Our react-fontawesome component is developed to officially support React 16.3 and above. If you’re using an earlier version of React, we can’t guarantee that all aspects of the component are compatible or will function as expected.

npm

npm i --save @fortawesome/react-fontawesome@latest

yarn

yarn add @fortawesome/react-fontawesome@latest

2. Add SVG Core

Next you’ll need to use npm or yarn to install the core package which is a dependency that includes all the utilities to make the icons work.

npm

npm i --save @fortawesome/fontawesome-svg-core

yarn

yarn add @fortawesome/fontawesome-svg-core

More about what's in the SVG Core

3. Add Icon Packages

Lastly, you’ll need to install the icons you want to use.

• If you’re just using Free icons, skip ahead to the Free package instructions.
• If you’re using Pro+ icons, you’ll need to use a Kit package.
• If you’re using Pro icons, there are you can use a Kit package or the SVG packages by style.

Pick the method that works for your project, and continue on for details on how to get the icons into your project.

Using a Kit Package (Recommended)

This is the simplest way to get started if you’re using any Pro icons. It is also the only way to use Pro+ icons via a package manager.

Before installing your Kit package, you’ll need to complete the following steps:

1. Set up a Kit
2. Enable Package Installation for that Kit
3. Configure access to your Kit’s package

Once you’ve completed both steps above, install your Kit package:

npm

npm install @awesome.me/kit-KIT_CODE@latest

yarn

yarn add @awesome.me/kit-KIT_CODE@latest

Watch that TypeScript config

If you use @awesome.me/kit-KIT_CODE and have import errors, read about configuring moduleResolution with TypeScript

Using SVG Icon Packages (Alternate)

Alternatively, you can install individual Free or Pro icon packages for each style you want to use.

Free Icon Packages

Free icons can be installed without any additional configuration and include the following styles.

npm

npm i --save @fortawesome/free-solid-svg-icons
npm i --save @fortawesome/free-regular-svg-icons
npm i --save @fortawesome/free-brands-svg-icons

yarn

yarn add @fortawesome/free-solid-svg-icons
yarn add @fortawesome/free-regular-svg-icons
yarn add @fortawesome/free-brands-svg-icons

Pro Icon Packages

Pro icons require an active subscription to a Pro Plan. You’ll also need to configure access to these Pro Packages before you can install and use them.

Configure Pro Package Access

After configuration is complete, you can install any of the individual styles as packages, but use caution when installing full styles as they are big packages that include a lot of icons! (Using a Kit is more effcient.)

npm

npm install @fortawesome/pro-solid-svg-icons
npm install @fortawesome/pro-regular-svg-icons
npm install @fortawesome/pro-light-svg-icons
npm install @fortawesome/pro-thin-svg-icons
npm install @fortawesome/pro-duotone-svg-icons
npm install @fortawesome/duotone-regular-svg-icons
npm install @fortawesome/duotone-light-svg-icons
npm install @fortawesome/duotone-thin-svg-icons
npm install @fortawesome/sharp-solid-svg-icons
npm install @fortawesome/sharp-regular-svg-icons
npm install @fortawesome/sharp-light-svg-icons
npm install @fortawesome/sharp-thin-svg-icons
npm install @fortawesome/sharp-duotone-solid-svg-icons
npm install @fortawesome/sharp-duotone-regular-svg-icons
npm install @fortawesome/sharp-duotone-light-svg-icons
npm install @fortawesome/sharp-duotone-thin-svg-icons

yarn

yarn add @fortawesome/pro-solid-svg-icons
yarn add @fortawesome/pro-regular-svg-icons
yarn add @fortawesome/pro-light-svg-icons
yarn add @fortawesome/pro-thin-svg-icons
yarn add @fortawesome/pro-duotone-svg-icons
yarn add @fortawesome/duotone-regular-svg-icons
yarn add @fortawesome/duotone-light-svg-icons
yarn add @fortawesome/duotone-thin-svg-icons
yarn add @fortawesome/sharp-solid-svg-icons
yarn add @fortawesome/sharp-regular-svg-icons
yarn add @fortawesome/sharp-light-svg-icons
yarn add @fortawesome/sharp-thin-svg-icons
yarn add @fortawesome/sharp-duotone-solid-svg-icons
yarn add @fortawesome/sharp-duotone-regular-svg-icons
yarn add @fortawesome/sharp-duotone-light-svg-icons
yarn add @fortawesome/sharp-duotone-thin-svg-icons

Pro+ Icons are only available in Kit Packages!

Along with a Pro+ Plan, you'll need to install a downloaded Kit package to use any of our Pro+ Icons — they are not available in any other packages.