# angular-fontawesome
[](https://www.npmjs.com/package/@fortawesome/angular-fontawesome)
Official Angular component for Font Awesome 5
## Installation
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/fontawesome-svg-core
$ 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/fontawesome-svg-core
$ 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|ng-add|
|-|-|-|
|0.1.x|5.x|not supported|
|0.2.x|6.x|not supported|
|0.3.x|6.x && 7.x|not supported|
|0.4.x, 0.5.x|8.x|not supported|
|0.6.x|9.x|supported|
|0.7.x|10.x|supported|
|0.8.x|11.x|supported|
## Usage
To get up and running using Font Awesome with Angular follow below steps:
1. Add `FontAwesomeModule` to `imports` in
`src/app/app.module.ts`:
```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
@NgModule({
imports: [
BrowserModule,
FontAwesomeModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
```
2. Tie the icon to the property in your component
`src/app/app.component.ts`:
```typescript
import { Component } from '@angular/core';
import { faCoffee } from '@fortawesome/free-solid-svg-icons';
@Component({
selector: 'app-root',
templateUrl: './app.component.html'
})
export class AppComponent {
faCoffee = faCoffee;
}
```
3. 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)
## Examples
### Stackblitz
Here's a [StackBlitz Starter Sample](https://stackblitz.com/edit/angular-fontawesome-sample?file=src%2Fapp%2Fapp.module.ts) 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/plinkpaste)
[
](https://github.com/ej2)
[
](https://github.com/peterblazejewicz)
[
](https://github.com/arjenbrandenburgh)
[
](https://github.com/athisun)
[
](https://github.com/madebyjeffrey)
[
](https://github.com/benjamincharity)
If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
The Font Awesome team:
[
](https://github.com/mlwilkerson)
[
](https://github.com/supercodepoet)
[
](https://github.com/robmadole)
[
](https://github.com/talbs)