MCPcopy Index your code
hub / github.com/FortAwesome/angular-fontawesome

github.com/FortAwesome/angular-fontawesome @5.1.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release 5.1.0 ↗ · + Follow
100 symbols 225 edges 54 files 3 documented · 3% 11 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Official Javascript Component

angular-fontawesome

npm

Official Angular component for Font Awesome 5+

Installation

If you have FontAwesome Pro subscription, make sure to 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.

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
5.x 22.x 5.x && 6.x && 7.x
4.x 21.x 5.x && 6.x && 7.x
3.x 20.x 5.x && 6.x && 7.x

See the compatibility page 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 <fa-icon [icon]="faCoffee" />

Documentation

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.

devoto13 zeevkatz scttcper DavidePastore donmckenna paustint mzellho elebitzero mcenkar SiddAjmera stephaniepurvis loicgasser damienwebdev ronniebarker bhanuhiteshi MrSuttonmann ej2 peterblazejewicz arjenbrandenburgh athisun madebyjeffrey benjamincharity NayeBeckham Nosfistis bleistift-zwei igorls jasonlundien Font Awesome Team pankajparkar medbenmakhlouf Stoffel-KT Ionaru KristofGilis cheng93

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

Extension points exported contracts — how you extend this code

FaIconLibraryInterface (Interface)
(no doc) [4 implementers]
src/lib/icon-library.ts
IconLookup (Interface)
(no doc)
src/lib/types.ts
IconDefinition (Interface)
(no doc)
src/lib/types.ts
IconPack (Interface)
(no doc)
src/lib/types.ts
FaProps (Interface)
(no doc)
src/lib/shared/models/props.model.ts

Core symbols most depended-on inside this repo

queryByCss
called by 47
src/testing/helpers.ts
addIcons
called by 29
src/lib/icon-library.ts
getIconDefinition
called by 12
src/lib/icon-library.ts
faClassList
called by 6
src/lib/shared/utils/classlist.util.ts
ensureCss
called by 4
src/lib/shared/utils/css.ts
forRoot
called by 4
testing/src/testing.module.ts
getBrowserState
called by 3
projects/demo/e2e/tests/utils.ts
isKnownRotateValue
called by 3
src/lib/shared/utils/classlist.util.ts

Shape

Class 52
Method 29
Function 14
Interface 5

Languages

TypeScript100%

Modules by API surface

src/lib/icon-library.ts9 symbols
testing/src/icon/mock-icon-library.service.ts5 symbols
src/lib/layers/layers-text.component.ts5 symbols
src/lib/layers/layers-counter.component.ts5 symbols
src/lib/icon/icon.component.ts5 symbols
src/lib/icon/duotone-icon.component.ts4 symbols
projects/demo/src/app/app.component.ts4 symbols
testing/src/testing.module.ts3 symbols
src/lib/types.ts3 symbols
src/lib/layers/layers.component.ts3 symbols
src/lib/icon/icon.component.spec.ts3 symbols
src/lib/icon/duotone-icon.component.spec.ts3 symbols

For agents

$ claude mcp add angular-fontawesome \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page