angular-fontawesome

Official Angular component for Font Awesome 5+

Installation

If you have FontAwesome Pro subscription, make sure to configure access before following the installation instructions.

Using ng add:

# See Compatibility table below to choose a correct version
$ ng add @fortawesome/angular-fontawesome@<version>

Using Yarn

$ yarn add @fortawesome/free-solid-svg-icons
# See Compatibility table below to choose a correct version
$ yarn add @fortawesome/angular-fontawesome@<version>

Using NPM

$ npm install @fortawesome/free-solid-svg-icons
# See Compatibility table below to choose a correct version
$ npm install @fortawesome/angular-fontawesome@<version>

Compatibility table

| @fortawesome/angular-fontawesome | Angular | Font Awesome | ng-add | |----------------------------------|------------|--------------|---------------| | 0.1.x | 5.x | 5.x | not supported | | 0.2.x | 6.x | 5.x | not supported | | 0.3.x | 6.x && 7.x | 5.x | not supported | | 0.4.x, 0.5.x | 8.x | 5.x | not supported | | 0.6.x | 9.x | 5.x | supported | | 0.7.x | 10.x | 5.x | supported | | 0.8.x | 11.x | 5.x | supported | | 0.9.x | 12.x | 5.x | supported | | 0.10.x | 13.x | 5.x && 6.x | supported | | 0.11.x | 14.x | 5.x && 6.x | supported | | 0.12.x | 15.x | 5.x && 6.x | supported | | 0.13.x | 16.x | 5.x && 6.x | supported | | 0.14.x | 17.x | 5.x && 6.x | supported | | 0.15.x | 18.x | 5.x && 6.x | supported | | 1.x | 19.x | 5.x && 6.x | supported |

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:

   import { Component } from '@angular/core';
   import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
   import { faCoffee } from '@fortawesome/free-solid-svg-icons';
      
   @Component({
     selector: 'app-root',
     imports: [FontAwesomeModule], // alternatively, individual components can be imported
     templateUrl: './app.component.html'
   })
   export class AppComponent {
     faCoffee = faCoffee;
   }

2. Use the icon in the template src/app/app.component.html:

   <fa-icon [icon]="faCoffee"></fa-icon>

Documentation

• In-depth usage guide
• Using other styles
• Full feature list
• Upgrading instructions
• Frequency asked questions

Examples

Stackblitz

Here's a StackBlitz Starter Sample on how to display Solid, Regular, and Brand icons 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 on your own machine.

Contributing

angular-fontawesome is a product of the community, you can take a look at the developer docs 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.

If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.