Font Awesome 5 with Angular

JeB picture JeB · Dec 29, 2017 · Viewed 66.7k times · Source

How do I use font-awesome 5 with Angular (2+)?

I've tried adding this inside a component:

import {faChevronLeft, faChevronRight} from '@fortawesome/fontawesome-free-solid';
import fontawesome from '@fortawesome/fontawesome';
...
constructor(){
   fontawesome.library.add(faChevronLeft, faChevronRight);
}

and then in HTML:

<span class="fa" [class.fa-chevron-left]="direction==='left'" [class.fa-chevron-right]="direction==='right'"></span>

But this gives me a blinking question mark in a circle.

Answer

JeB picture JeB · Dec 29, 2017

You have two options:


1. Use angular-fontawesome library

Just follow the instructions on their github page.


2. Use fontawesome 5 directly

Make sure you have installed all the relevant npm packages.
For Pro packages check out this.

  1. Import relevant icons:

    import {faChevronLeft, faChevronRight} from '@fortawesome/fontawesome-free-solid';
    import fontawesome from '@fortawesome/fontawesome';
    
  2. Add the icons to fontawesome library in global scope (not inside the component's constructor):

    fontawesome.library.add(faChevronLeft, faChevronRight);
    
  3. Use it in html:

    <span class="fas" [class.fa-chevron-left]="direction==='left'" [class.fa-chevron-right]="direction==='right'"></span>
    
  4. Mind the prefixes in html:

    • fas for fontawesome-free-solid icons (works also with fa)

      <span class="fas fa-chevron-left"></span>
      
    • fab for fontawesome-free-brands icons

      <span class="fab fa-bitcoin"></span>
      
    • far for fontawesome-free-regular icons

      <span class="far fa-chevron-left"></span>
      
    • fal for fontawesome-free-light icons (pro)

      <span class="fal fa-chevron-left"></span>
      

Important note:

It's fine to use variables to define fontawesome classes as soon as it is done only once (at initialization). However, if the variable changes its value it won't be reflected in html. Consider this example:

<span class="fas fa-chevron-{{direction}}"></span>

This will put the right icon at the initialization time, but if the direction changes afterwards it won't be reflected.
The reason for this is that fontawesome 5 replaces the elements classed with fa ... with appropriate svg and once it is replaced no variable affects this.
If you want the above html to reflect runtime changes you have to change it like this:

<span *ngIf="direction==='right'"><span class="fas fa-chevron-right"></span></span>
<span *ngIf="direction==='left'"><span class="fas fa-chevron-left"></span></span>

The outer span is necessary as the inner span is replaced with svg so you can't put *ngIf on it.

Further reading: