1 | <a href="https://fontawesome.com">
|
2 | <img align="right" width="100" height="100" alt="Official Javascript Component" src="https://img.fortawesome.com/349cfdf6/official-javascript-component.svg">
|
3 | </a>
|
4 |
|
5 | # angular-fontawesome
|
6 |
|
7 | [![npm](https://img.shields.io/npm/v/@fortawesome/angular-fontawesome.svg?style=flat-square)](https://www.npmjs.com/package/@fortawesome/angular-fontawesome)
|
8 |
|
9 | Official Angular component for Font Awesome 5+
|
10 |
|
11 | ## Installation
|
12 |
|
13 | Using `ng add`:
|
14 |
|
15 | ```
|
16 | # See Compatibility table below to choose a correct version
|
17 | $ ng add @fortawesome/angular-fontawesome@<version>
|
18 | ```
|
19 |
|
20 | Using [Yarn](https://yarnpkg.com)
|
21 | ```
|
22 | $ yarn add @fortawesome/fontawesome-svg-core
|
23 | $ yarn add @fortawesome/free-solid-svg-icons
|
24 | # See Compatibility table below to choose a correct version
|
25 | $ yarn add @fortawesome/angular-fontawesome@<version>
|
26 | ```
|
27 |
|
28 | Using [NPM](https://www.npmjs.com/)
|
29 | ```
|
30 | $ npm install @fortawesome/fontawesome-svg-core
|
31 | $ npm install @fortawesome/free-solid-svg-icons
|
32 | # See Compatibility table below to choose a correct version
|
33 | $ npm install @fortawesome/angular-fontawesome@<version>
|
34 | ```
|
35 |
|
36 | ### Compatibility table
|
37 |
|
38 | |@fortawesome/angular-fontawesome|Angular|Font Awesome|ng-add|
|
39 | |-|-|-|-|
|
40 | |0.1.x|5.x|5.x|not supported|
|
41 | |0.2.x|6.x|5.x|not supported|
|
42 | |0.3.x|6.x && 7.x|5.x|not supported|
|
43 | |0.4.x, 0.5.x|8.x|5.x|not supported|
|
44 | |0.6.x|9.x|5.x|supported|
|
45 | |0.7.x|10.x|5.x|supported|
|
46 | |0.8.x|11.x|5.x|supported|
|
47 | |0.9.x|12.x|5.x|supported|
|
48 | |0.10.x|13.x|5.x && 6.x|supported|
|
49 |
|
50 | ## Usage
|
51 | To get up and running using Font Awesome with Angular follow below steps:
|
52 |
|
53 | 1. Add `FontAwesomeModule` to `imports` in
|
54 | `src/app/app.module.ts`:
|
55 |
|
56 | ```typescript
|
57 | import { BrowserModule } from '@angular/platform-browser';
|
58 | import { NgModule } from '@angular/core';
|
59 |
|
60 | import { AppComponent } from './app.component';
|
61 | import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
|
62 |
|
63 | @NgModule({
|
64 | imports: [
|
65 | BrowserModule,
|
66 | FontAwesomeModule
|
67 | ],
|
68 | declarations: [AppComponent],
|
69 | bootstrap: [AppComponent]
|
70 | })
|
71 | export class AppModule { }
|
72 | ```
|
73 |
|
74 | 2. Tie the icon to the property in your component
|
75 | `src/app/app.component.ts`:
|
76 |
|
77 | ```typescript
|
78 | import { Component } from '@angular/core';
|
79 | import { faCoffee } from '@fortawesome/free-solid-svg-icons';
|
80 |
|
81 | @Component({
|
82 | selector: 'app-root',
|
83 | templateUrl: './app.component.html'
|
84 | })
|
85 | export class AppComponent {
|
86 | faCoffee = faCoffee;
|
87 | }
|
88 | ```
|
89 |
|
90 | 3. Use the icon in the template
|
91 | `src/app/app.component.html`:
|
92 |
|
93 | ```html
|
94 | <fa-icon [icon]="faCoffee"></fa-icon>
|
95 | ```
|
96 |
|
97 | ## Documentation
|
98 |
|
99 | * [In-depth usage guide](./docs/usage.md)
|
100 | * [Using other styles](./docs/usage/using-other-styles.md)
|
101 | * [Full feature list](./docs/usage/features.md)
|
102 | * [Upgrading instructions](UPGRADING.md)
|
103 |
|
104 | ## Examples
|
105 |
|
106 | ### Stackblitz
|
107 | 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).
|
108 |
|
109 |
|
110 | ### Demo application
|
111 | 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.
|
112 |
|
113 | ## Contributing
|
114 | `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.
|
115 |
|
116 | ## Contributors
|
117 |
|
118 | The following contributors have either helped to start this project, have contributed
|
119 | code, are actively maintaining it (including documentation), or in other ways
|
120 | being awesome contributors to this project. **We'd like to take a moment to recognize them.**
|
121 |
|
122 | [<img src="https://github.com/devoto13.png?size=72" alt="devoto13" width="72">](https://github.com/devoto13)
|
123 | [<img src="https://github.com/zeevkatz.png?size=72" alt="zeevkatz" width="72">](https://github.com/zeevkatz)
|
124 | [<img src="https://github.com/scttcper.png?size=72" alt="scttcper" width="72">](https://github.com/scttcper)
|
125 | [<img src="https://github.com/DavidePastore.png?size=72" alt="DavidePastore" width="72">](https://github.com/DavidePastore)
|
126 | [<img src="https://github.com/donmckenna.png?size=72" alt="donmckenna" width="72">](https://github.com/donmckenna)
|
127 | [<img src="https://github.com/paustint.png?size=72" alt="paustint" width="72">](https://github.com/paustint)
|
128 | [<img src="https://github.com/mzellho.png?size=72" alt="mzellho" width="72">](https://github.com/mzellho)
|
129 | [<img src="https://github.com/elebitzero.png?size=72" alt="elebitzero" width="72">](https://github.com/elebitzero)
|
130 | [<img src="https://github.com/mcenkar.png?size=72" alt="mcenkar" width="72">](https://github.com/mcenkar)
|
131 | [<img src="https://github.com/SiddAjmera.png?size=72" alt="SiddAjmera" width="72">](https://github.com/SiddAjmera)
|
132 | [<img src="https://github.com/stephaniepurvis.png?size=72" alt="stephaniepurvis" width="72">](https://github.com/stephaniepurvis)
|
133 | [<img src="https://github.com/loicgasser.png?size=72" alt="loicgasser" width="72">](https://github.com/loicgasser)
|
134 | [<img src="https://github.com/damienwebdev.png?size=72" alt="damienwebdev" width="72">](https://github.com/damienwebdev)
|
135 | [<img src="https://github.com/ronniebarker.png?size=72" alt="ronniebarker" width="72">](https://github.com/ronniebarker)
|
136 | [<img src="https://github.com/bhanuhiteshi.png?size=72" alt="bhanuhiteshi" width="72">](https://github.com/bhanuhiteshi)
|
137 | [<img src="https://github.com/MrSuttonmann.png?size=72" alt="MrSuttonmann" width="72">](https://github.com/MrSuttonmann)
|
138 | [<img src="https://github.com/ej2.png?size=72" alt="ej2" width="72">](https://github.com/ej2)
|
139 | [<img src="https://github.com/peterblazejewicz.png?size=72" alt="peterblazejewicz" width="72">](https://github.com/peterblazejewicz)
|
140 | [<img src="https://github.com/arjenbrandenburgh.png?size=72" alt="arjenbrandenburgh" width="72">](https://github.com/arjenbrandenburgh)
|
141 | [<img src="https://github.com/athisun.png?size=72" alt="athisun" width="72">](https://github.com/athisun)
|
142 | [<img src="https://github.com/madebyjeffrey.png?size=72" alt="madebyjeffrey" width="72">](https://github.com/madebyjeffrey)
|
143 | [<img src="https://github.com/benjamincharity.png?size=72" alt="benjamincharity" width="72">](https://github.com/benjamincharity)
|
144 |
|
145 | If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
|
146 |
|
147 | The Font Awesome team:
|
148 |
|
149 | [<img src="https://github.com/mlwilkerson.png?size=72" alt="mlwilkerson" width="72">](https://github.com/mlwilkerson)
|
150 | [<img src="https://github.com/supercodepoet.png?size=72" alt="supercodepoet" width="72">](https://github.com/supercodepoet)
|
151 | [<img src="https://github.com/robmadole.png?size=72" alt="robmadole" width="72">](https://github.com/robmadole)
|
152 | [<img src="https://github.com/talbs.png?size=72" alt="talbs" width="72">](https://github.com/talbs)
|