# react-fontawesome
[](https://www.npmjs.com/package/@fortawesome/react-fontawesome)
> Font Awesome 5 React component using SVG with JS
- [Introduction](#introduction)
+ [Upgrading Font Awesome?](#upgrading-font-awesome)
+ [Get started](#get-started)
+ [Learn about our new SVG implementation](#learn-about-our-new-svg-implementation)
+ [Going from 0.0.x to 0.1.0](#going-from-00x-to-010)
- [Installation](#installation)
- [Add more styles or Pro icons](#add-more-styles-or-pro-icons)
- [Usage](#usage)
* [Explicit Import](#explicit-import)
* [Build a Library to Reference Icons Throughout Your App More Conveniently](#build-a-library-to-reference-icons-throughout-your-app-more-conveniently)
* [Unit Testing](#unit-testing)
* [Processing i elements into svg using Font Awesome](#processing-i-elements-into-svg-using-font-awesome)
- [Features](#features)
* [Basic](#basic)
* [Advanced](#advanced)
* [TypeScript](#typescript)
- [Frequent questions](#frequent-questions)
* [How do I import the same icon from two different styles?](#how-do-i-import-the-same-icon-from-two-different-styles)
* [I don't think tree-shaking is working; got any advice?](#i-dont-think-tree-shaking-is-working-got-any-advice)
- [How to Help](#how-to-help)
- [Contributors](#contributors)
- [Releasing this project (only project owners can do this)](#releasing-this-project-only-project-owners-can-do-this)
## Introduction
Hey there! We're glad you're here...
#### Upgrading Font Awesome?
If you've used Font Awesome in the past (version 4 or older) there are some
things that you should learn before you dive in.
> https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4
#### Get started
This package is for integrating with React. If you aren't using React then it's
not going to help you. Head over to our "Get Started" page for some guidance.
> https://fontawesome.com/how-to-use/on-the-web/setup/getting-started
#### Learn about our new SVG implementation
This package, under the hood, uses SVG with JS and the `@fortawesome/fontawesome-svg-core` library. This implementation differs drastically from
the web fonts implementation that was used in version 4 and older of Font Awesome. You might head over there to learn about how it works.
> https://fontawesome.com/how-to-use/on-the-web/advanced/svg-javascript-core
#### Going from 0.0.x to 0.1.0
See [UPGRADING.md](./UPGRADING.md).
You might also be interested in the larger umbrella project [UPGRADING.md](https://github.com/FortAwesome/Font-Awesome/blob/master/UPGRADING.md)
## Installation
Using NPM:
```
$ npm i --save @fortawesome/fontawesome-svg-core
$ npm i --save @fortawesome/free-solid-svg-icons
$ npm i --save @fortawesome/react-fontawesome
```
Or with Yarn:
```
$ yarn add @fortawesome/fontawesome-svg-core
$ yarn add @fortawesome/free-solid-svg-icons
$ yarn add @fortawesome/react-fontawesome
```
## Add more styles or Pro icons
Brands are separated into their own style and for customers upgrading from
version 4 to 5 we have a limited number of Regular icons available.
**Visit [fontawesome.com/icons](https://fontawesome.com/icons) to search for free and Pro icons**
```
$ npm i --save @fortawesome/free-brands-svg-icons
$ npm i --save @fortawesome/free-regular-svg-icons
```
If you are a [Font Awesome Pro](https://fontawesome.com/pro) subscriber you can install Pro packages; this requires [additional configuration](https://fontawesome.com/how-to-use/on-the-web/setup/using-package-managers).
```
$ npm i --save @fortawesome/pro-solid-svg-icons
$ npm i --save @fortawesome/pro-regular-svg-icons
$ npm i --save @fortawesome/pro-light-svg-icons
$ npm i --save @fortawesome/pro-duotone-svg-icons
```
## Usage
You can use Font Awesome icons in your React components as simply as this:
```javascript
```
That simple usage is made possible when you add the `"coffee"` icon, to the
_library_.
This is one of the two ways you can use Font Awesome 5 with React. We'll
summarize both ways briefly and then get into the details of each below.
1. **Explicit Import**
Allows icons to be subsetted, optimizing your final bundle. Only the icons
you import are included in the bundle. However, explicitly importing icons
into each of many components in your app might become tedious, so you may
want to build a library.
2. **Build a Library**
Explicitly import icons just once in some init module. Then add them to the
library. Then reference any of them by icon name as a string from any
component. No need to import the icons into each component once they're in
the library.
### Explicit Import
For this example, we'll also reference the `@fortawesome/free-solid-svg-icons`
module, so make sure you've added it to the project as well:
```
$ npm i --save @fortawesome/free-solid-svg-icons
```
or
```
$ yarn add @fortawesome/free-solid-svg-icons
```
Now, a simple React component might look like this:
```javascript
import ReactDOM from 'react-dom'
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
import { faCoffee } from '@fortawesome/free-solid-svg-icons'
const element =
ReactDOM.render(element, document.body)
```
Notice that the `faCoffee` icon is imported from
`@fortawesome/free-solid-svg-icons` as an object and then provided to the
`icon` prop as an object.
Explicitly importing icons like this allows us to subset Font Awesome's
thousands of icons to include only those you use in your final bundled file.
### Build a Library to Reference Icons Throughout Your App More Conveniently
You probably want to use our icons in more than one component in your app,
right?
But with explicit importing, it could become tedious to import into each of
your app's components every icon you want to reference in that component.
So, add them to the _library_. Do this setup once in some initializing module
of your app, adding all of the icons you'll use in your app's React components.
Suppose `App.js` initializes my app, including the library. For this example,
we'll add two individual icons, `faCheckSquare` and `faCoffee`. We also add all
of the brands in `@fortawesome/free-brands-svg-icons`. This example would
illustrate the benefits of building a library even more clearly if it involved
fifty or a hundred icons, but we'll keep the example brief and leave it to your
imagination as to how this might scale up with lots of icons.
Don't forget to add `@fortawesome/free-brands-svg-icons`:
```
$ npm i --save @fortawesome/free-brands-svg-icons
```
or
```
$ yarn add @fortawesome/free-brands-svg-icons
```
In `App.js`, where our app is initialized:
```javascript
import ReactDOM from 'react-dom'
import { library } from '@fortawesome/fontawesome-svg-core'
import { fab } from '@fortawesome/free-brands-svg-icons'
import { faCheckSquare, faCoffee } from '@fortawesome/free-solid-svg-icons'
library.add(fab, faCheckSquare, faCoffee)
```
OK, so what's happening here?
In our call to `library.add()` we're passing
- `fab`: which represents _all_ of the brand icons in
`@fortawesome/free-brands-svg-icons`.
So any of the brand icons in that package may be referenced by icon name
as a string anywhere else in our app.
For example: `"apple"`, `"microsoft"`, or `"google"`.
- `faCheckSquare` and `faCoffee`: Adding each of these icons individually
allows us to refer to them throughout our app by their icon string names,
`"check-square"` and `"coffee"`, respectively.
Now, suppose you also have React components `Beverage` and `Gadget` in your app.
You don't have to re-import your icons into them. Just import the `FontAwesomeIcon`
component, and when you use it, supply the icon prop an icon name as a string.
We'll make `Beverage.js` a functional component:
```javascript
import React from 'react'
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
export const Beverage = () => (
Favorite beverage:
)
```
There's one another piece of magic that's happening in the background when
providing icon names as strings like this: the `fas` prefix (for Font Awesome
Solid) is being inferred as the default. Later, we'll look at what that means
and how we can do something different than the default.
Now suppose `Gadget.js` looks like this:
```javascript
import React from 'react'
import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
export const Gadget = () => (
Popular gadgets come from vendors like:
)
```
Notice:
- We used the `"check-square"` icon name again in this component, though we
didn't have to explicitly import it into this component. With one explicit import of
that icon in `App.js`, and adding it to the library, we've managed to use
it by name in multiple components.
- We used the `"apple"`, `"microsoft"`, and `"google"` brand icons, which were
never explicitly _individually_ imported, but they're available to us by
name as strings because `fab` was added to our library in `App.js`, and
`fab` includes all of those icons.
- We added the `fab` prefix to reference those brand icons.
Adding a prefix—and the syntax we used to do it—are new. So what's
going on here?
First, recall when we introduced `` and learned
that a prefix of `fas` was being added to `"coffee"` by default.
The `"check-square"` icon is getting a default prefix of `fas` here too, which
is what we want, because that icon also lives in the
`@fortawesome/free-solid-svg-icons` package.
However, the `"apple"`, `"microsoft"`, and `"google"` brand icons live in the
package `@fortawesome/free-brands-svg-icons`. So we need to specify a
different prefix for them—not the default `fas`, but `fab`, for Font Awesome
_Brand_.
When specifying a prefix with an icon name, both are given as strings.
Now, what about that syntax?
The `icon` prop expects a single object:
- It could be an icon object, like `{faCoffee}`.
- It could a string object, like `"coffee"`.
(The curly braces around a string object supplied to a prop are optional,
so we've omitted them.)
- Or it could be an `Array` of strings, where the first element is a prefix,
and the second element is the icon name: `{["fab", "apple"]}`
### Unit Testing
When testing components, you'll want to make sure that any icons referenced in those components are available for testing purposes. You have a couple choices here:
1. If you want to test a child component on its own, you can [import its icons explicitly](#explicit-import).
2. If you've built a library instead, and your test doesn't include your root component that defines your library of icons, you may see errors like this:
`Could not find icon { prefix: 'fas', iconName: 'chevron-right' }`
If this happens, and the icon isn't important to the particular test, you can mock FontAwesomeIcon like this:
```js
import React from 'react'
export function FontAwesomeIcon(props) {
return
}
```
With [create-react-app](https://github.com/facebook/create-react-app), you can put this code in `src/__mocks__/@fortawesome/react-fontawesome.js` to automatically include it in any tests, and alleviate errors.
### Processing i elements into svg using Font Awesome
Our hope and intention is that React users will use this package (`react-fontawesome`)
when using Font Awesome. This component leverages React's architecture and philosophy.
However, **if you cannot use these components everywhere in your app and still
have `` tags on your page that need to be converted to `
