# angular-fontawesome
[](https://www.npmjs.com/package/@fortawesome/angular-fontawesome)
Official Angular component for Font Awesome 5+
## Installation
If you have [FontAwesome Pro](https://fontawesome.com/plans) subscription, make sure to [configure access](https://fontawesome.com/docs/web/setup/packages#_1-configure-access) before following the installation instructions.
> **Note:** 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.
> [Read more](https://docs.fontawesome.com/web/setup/use-kit#using-kit-packages).
Using `ng add`:
```
# See Compatibility table below to choose a correct version
$ ng add @fortawesome/angular-fontawesome@
```
Using [Yarn](https://yarnpkg.com)
```
$ yarn add @fortawesome/free-solid-svg-icons
# See Compatibility table below to choose a correct version
$ yarn add @fortawesome/angular-fontawesome@
```
Using [NPM](https://www.npmjs.com/)
```
$ npm install @fortawesome/free-solid-svg-icons
# See Compatibility table below to choose a correct version
$ npm install @fortawesome/angular-fontawesome@
```
### Compatibility table
| @fortawesome/angular-fontawesome | Angular | Font Awesome |
|----------------------------------|---------|-------------------|
| 4.x | 21.x | 5.x && 6.x && 7.x |
| 3.x | 20.x | 5.x && 6.x && 7.x |
| 2.x | 20.x | 5.x && 6.x |
See [the compatibility page](./docs/guide/compatibility.md) for older versions.
## Usage
To get up and running using Font Awesome with Angular follow the below steps:
1. Add `FontAwesomeModule` to the `imports` and tie the icon to the property in your component
`src/app/app.component.ts`:
```typescript
import { Component } from '@angular/core';
import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
import { faCoffee } from '@fortawesome/free-solid-svg-icons';
// Import from Kit Packages (Pro+ Icons)
// import {faCloud} from "@awesome.me/kit-/icons/slab/regular";
@Component({
selector: 'app-root',
imports: [FontAwesomeModule], // alternatively, individual components can be imported
templateUrl: './app.component.html'
})
export class AppComponent {
faCoffee = faCoffee;
}
```
1. Use the icon in the template
`src/app/app.component.html`:
```html
```
## Documentation
* [In-depth usage guide](./docs/usage.md)
* [Using other styles](./docs/usage/using-other-styles.md)
* [Full feature list](./docs/usage/features.md)
* [Upgrading instructions](UPGRADING.md)
* [Frequency asked questions](./docs/faq.md)
## Examples
### Stackblitz
Here's a [StackBlitz Starter Sample](https://stackblitz.com/edit/angular-ivy-7jrcne) on how to display Solid, Regular, and Brand icons [using the Icon Library](./docs/usage/icon-library.md#using-the-icon-library).
### Demo application
You can find examples in the `projects/demo` directory. You can follow [the docs to run the demo app](./DEVELOPER.md#setting-up-the-local-environment) on your own machine.
## Contributing
`angular-fontawesome` is a product of the community, you can take a look at the [developer docs](./DEVELOPER.md) to find about more on how to contribute back to the project.
## Contributors
The following contributors have either helped to start this project, have contributed
code, are actively maintaining it (including documentation), or in other ways
being awesome contributors to this project. **We'd like to take a moment to recognize them.**
[
](https://github.com/devoto13)
[
](https://github.com/zeevkatz)
[
](https://github.com/scttcper)
[
](https://github.com/DavidePastore)
[
](https://github.com/donmckenna)
[
](https://github.com/paustint)
[
](https://github.com/mzellho)
[
](https://github.com/elebitzero)
[
](https://github.com/mcenkar)
[
](https://github.com/SiddAjmera)
[
](https://github.com/stephaniepurvis)
[
](https://github.com/loicgasser)
[
](https://github.com/damienwebdev)
[
](https://github.com/ronniebarker)
[
](https://github.com/bhanuhiteshi)
[
](https://github.com/MrSuttonmann)
[
](https://github.com/ej2)
[
](https://github.com/peterblazejewicz)
[
](https://github.com/arjenbrandenburgh)
[
](https://github.com/athisun)
[
](https://github.com/madebyjeffrey)
[
](https://github.com/benjamincharity)
[
](https://github.com/NayeBeckham)
[
](https://github.com/Nosfistis)
[
](https://github.com/bleistift-zwei)
[
](https://github.com/igorls)
[
](https://github.com/jasonlundien)
[
](https://github.com/orgs/FortAwesome/people)
[
](https://github.com/pankajparkar)
[
](https://github.com/medbenmakhlouf)
[
](https://github.com/Stoffel-KT)
[
](https://github.com/Ionaru)
If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.