Skip to content

Commit 1098fd2

Browse files
igorlsigorls
committed
Update docs and schema for Font Awesome 7 support
Added documentation for Pro+ Icons and Kit Packages in README, updated compatibility table, and provided import example for Kit Packages. Changed default FontAwesome version to 7 and expanded icon style options in ng-add schema. Updated packageManager to yarn@4.9.2 in package.json.
1 parent 6a4b883 commit 1098fd2

File tree

4 files changed

+44
-24
lines changed

4 files changed

+44
-24
lines changed

‎README.md‎

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ Official Angular component for Font Awesome 5+
1212

1313
If you have [FontAwesome Pro](https://fontawesome.com/plans) subscription, make sure to [configure access](https://fontawesome.com/docs/web/setup/packages#_1-configure-access) before following the installation instructions.
1414

15+
> **Note:** Pro+ Icons are only available in Kit Packages
16+
> 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.
17+
> [Read more](https://docs.fontawesome.com/web/setup/use-kit#using-kit-packages).
18+
19+
1520
Using `ng add`:
1621

1722
```
@@ -35,24 +40,25 @@ $ npm install @fortawesome/angular-fontawesome@<version>
3540

3641
### Compatibility table
3742

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-
| 0.11.x | 14.x | 5.x && 6.x | supported |
50-
| 0.12.x | 15.x | 5.x && 6.x | supported |
51-
| 0.13.x | 16.x | 5.x && 6.x | supported |
52-
| 0.14.x | 17.x | 5.x && 6.x | supported |
53-
| 0.15.x | 18.x | 5.x && 6.x | supported |
54-
| 1.x | 19.x | 5.x && 6.x | supported |
55-
| 2.x | 20.x | 5.x && 6.x | supported |
43+
| @fortawesome/angular-fontawesome | Angular | Font Awesome | ng-add |
44+
|----------------------------------|------------|-------------------|---------------|
45+
| 0.1.x | 5.x | 5.x | not supported |
46+
| 0.2.x | 6.x | 5.x | not supported |
47+
| 0.3.x | 6.x && 7.x | 5.x | not supported |
48+
| 0.4.x, 0.5.x | 8.x | 5.x | not supported |
49+
| 0.6.x | 9.x | 5.x | supported |
50+
| 0.7.x | 10.x | 5.x | supported |
51+
| 0.8.x | 11.x | 5.x | supported |
52+
| 0.9.x | 12.x | 5.x | supported |
53+
| 0.10.x | 13.x | 5.x && 6.x | supported |
54+
| 0.11.x | 14.x | 5.x && 6.x | supported |
55+
| 0.12.x | 15.x | 5.x && 6.x | supported |
56+
| 0.13.x | 16.x | 5.x && 6.x | supported |
57+
| 0.14.x | 17.x | 5.x && 6.x | supported |
58+
| 0.15.x | 18.x | 5.x && 6.x | supported |
59+
| 1.x | 19.x | 5.x && 6.x | supported |
60+
| 2.x | 20.x | 5.x && 6.x | supported |
61+
| 2.1.x | 20.x | 5.x && 6.x && 7.x | supported |
5662

5763
## Usage
5864

@@ -66,6 +72,10 @@ To get up and running using Font Awesome with Angular follow the below steps:
6672
import { FontAwesomeModule } from '@fortawesome/angular-fontawesome';
6773
import { faCoffee } from '@fortawesome/free-solid-svg-icons';
6874

75+
// Import from Kit Packages (Pro+ Icons)
76+
// import {faCloud} from "@awesome.me/kit-<KIT_ID>/icons/slab/regular";
77+
78+
6979
@Component({
7080
selector: 'app-root',
7181
imports: [FontAwesomeModule], // alternatively, individual components can be imported

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,5 +93,5 @@
9393
"@angular/core": "^20.0.0"
9494
},
9595
"schematics": "./schematics/collection.json",
96-
"packageManager": "yarn@4.5.1"
96+
"packageManager": "yarn@4.9.2"
9797
}

‎projects/schematics/src/ng-add/schema.json‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"version": {
1515
"description": "The FontAwesome version to install.",
1616
"type": "string",
17-
"default": "6",
17+
"default": "7",
1818
"x-prompt": {
1919
"message": "Choose Font Awesome version you would like to use:",
2020
"type": "list",
@@ -46,9 +46,19 @@
4646
"pro-solid",
4747
"pro-regular",
4848
"pro-light",
49-
"pro-duotone",
5049
"pro-thin",
51-
"sharp-solid"
50+
"pro-duotone",
51+
"duotone-regular",
52+
"duotone-light",
53+
"duotone-thin",
54+
"sharp-solid",
55+
"sharp-regular",
56+
"sharp-light",
57+
"sharp-thin",
58+
"sharp-duotone-solid",
59+
"sharp-duotone-regular",
60+
"sharp-duotone-light",
61+
"sharp-duotone-thin"
5262
]
5363
},
5464
"default": ["free-solid"],

‎yarn.lock‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12933,11 +12933,11 @@ __metadata:
1293312933

1293412934
"typescript@patch:typescript@npm%3A~5.8.3#optional!builtin<compat/typescript>":
1293512935
version: 5.8.3
12936-
resolution: "typescript@patch:typescript@npm%3A5.8.3#optional!builtin<compat/typescript>::version=5.8.3&hash=cef18b"
12936+
resolution: "typescript@patch:typescript@npm%3A5.8.3#optional!builtin<compat/typescript>::version=5.8.3&hash=5786d5"
1293712937
bin:
1293812938
tsc: bin/tsc
1293912939
tsserver: bin/tsserver
12940-
checksum: 10c0/92ea03509e06598948559ddcdd8a4ae5a7ab475766d5589f1b796f5731b3d631a4c7ddfb86a3bd44d58d10102b132cd4b4994dda9b63e6273c66d77d6a271dbd
12940+
checksum: 10c0/39117e346ff8ebd87ae1510b3a77d5d92dae5a89bde588c747d25da5c146603a99c8ee588c7ef80faaf123d89ed46f6dbd918d534d641083177d5fac38b8a1cb
1294112941
languageName: node
1294212942
linkType: hard
1294312943

0 commit comments

Comments
 (0)