Skip to content

Commit

Permalink
docs: update Font Awesome Pro integration notes
Browse files Browse the repository at this point in the history
  • Loading branch information
javier-godoy authored and paodb committed Feb 9, 2022
1 parent 9be31f5 commit d6d3a3e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Integration of FontAwesome and iron-icon for Vaadin 10+
- **Version 1.0.4** (based on FontAwesome 5.11.2) is compatible with Vaadin 10-13 and Vaadin 14 in bower mode
- **Version 2.0.4** (based on FontAwesome 5.13.0) is compatible with Vaadin 14+ in npm mode.
- **Version 2.2.x** (based on the latest version of FontAwesome 5) is compatible with Vaadin 14+ in npm mode.
- **Version 3.0.0** (snapshot, based on FontAwesome 6) is compatible with Vaadin 14+ in npm mode.

For details on which version of FontAwesome is used by each release of this addon, see the [Release Notes](https://github.com/FlowingCode/FontAwesomeIronIconset/releases)

Expand Down Expand Up @@ -101,7 +102,7 @@ This process will:
The JAR created in this way will include a copy of the Font Awesome Pro icons, thus it will be subject to the Font Awesome Pro restrictions. You'll need to install it locally or make it available from your internal artifact repository.

1. Checkout a copy of this project: `git clone [email protected]:FlowingCode/FontAwesomeIronIconset.git`
2. Download Font Awesome Pro SVG sprites into `src/main/sprites`
2. Download Font Awesome Pro SVG sprites into `src/main/sprites` OR Font Awesome Pro SVG icons into `/src/main/icons` (`/src/main/icons/solid`, `/src/main/icons/regular`, etc.)
3. Modify the groupId, artifactId and version in the `pom.xml` file.
4. Modify the following properties in the `pom.xml` file:
```
Expand All @@ -118,3 +119,7 @@ If you want to import the JS iconset from a Polymer Template when using the inte

[Duotone styling](https://blog.fontawesome.com/introducing-duotone) is based on CSS variables (`--fa-primary-color`, `--fa-primary-opacity`, `--fa-secondary-color`, and `--fa-secondary-opacity`) that are applied to the `<duotone-icon>`. When importing the iconset from a Polymer Template, you'll also need `@vaadin/flow-frontend/font-awesome-duotone/duotone.js` in addition to `@vaadin/flow-frontend/font-awesome-iron-iconset/fad.js`.

When compiling icons for FontAwesome Pro 6 you need to need to use at least JDK 15. This is because a [limitation](https://bugs.openjdk.java.net/browse/JDK-8241798) in the maximum number of constants allowed in an enum compiled by javac with earlier JDKs.
This only affects the generated bytecode: the compatibility level remains 1.8 so that the library is still compatible with Java 8.


0 comments on commit d6d3a3e

Please sign in to comment.