Skip to content

Commit e893dd1

Browse files
committed
Release 0.5.0
1 parent 3d24846 commit e893dd1

File tree

5 files changed

+72
-3
lines changed

5 files changed

+72
-3
lines changed

CHANGELOG.md

+42
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,48 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
55

66
---
77

8+
## [0.5.0](https://github.com/FortAwesome/angular-fontawesome/releases/tag/0.5.0) - 2019-08-12
9+
10+
Make sure to check [upgrade instructions](https://github.com/FortAwesome/angular-fontawesome/blob/master/UPGRADING.md).
11+
12+
### Added
13+
14+
* Added `fa-stack` component to stack [two icons together](https://fontawesome.com/how-to-use/on-the-web/styling/stacking-icons):
15+
16+
```html
17+
<fa-stack>
18+
<fa-icon [icon]="faCircle" stackItemSize="2x"></fa-icon>
19+
<fa-icon [icon]="faFlag" [inverse]="true" stackItemSize="1x"></fa-icon>
20+
</fa-stack>
21+
```
22+
* Added `fa-duotone-icon` component to work with [duotone icons](https://fontawesome.com/how-to-use/on-the-web/styling/duotone-icons):
23+
24+
```html
25+
<fa-duotone-icon [icon]="['fad', 'coffee']" primaryColor="red" secondaryColor="blue"></fa-duotone-icon>
26+
```
27+
* Added [an official method](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/usage/features.md#programmatic-api) to update `FaIconComponent` and `FaDuotoneIconComponent` programmatically.
28+
* Added `FaIconLibray` class to replace deprecated global icon library from `@fortawesome/fontawesome-svg-core` package.
29+
* Added `a11yRole` input for `fa-icon` and `fa-duotone-icon` components to support customizing `role` attribute of the rendered SVG icon.
30+
* Added `FaConfig` class to globally configure `angular-fontawesome`.
31+
* Added a table in README.md to document compatibility with major Angular versions.
32+
* Added instructions on how to install library with NPM.
33+
34+
### Changed
35+
36+
* Restructured documentation to make it easier to navigate and extend.
37+
* Changed semantics of the `FaIconComponent.icon` property. It used to have type `Icon` - rendered icon object and is now changed into component input to specify icon definition with type `IconProp`.
38+
39+
### Deprecated
40+
41+
* `FaIconComponent.iconProp` is deprecated. Use `FaIconComponent.icon` instead.
42+
* Warning when `FaIconComponent.icon` is not set or specified icon definition is missing in the icon library is deprecated. It will throw a hard error in the next version.
43+
* `FaIconComponent.listItem` is deprecated. Use `FaIconComponent.fixedWidth` + custom CSS to render icons as list markers.
44+
* `FaIconService` is deprecated in favour of `FaConfig`.
45+
46+
### Fixed
47+
48+
* Fixed title-tooltip not being displayed in IE 11 in some cases.
49+
850
## [0.4.0](https://github.com/FortAwesome/angular-fontawesome/releases/tag/0.4.0) - 2019-03-28
951

1052
### Added

DEVELOPER.md

+2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ Command | Purpose
3636

3737
1. Bump version in `package.json`
3838
1. Add contributors to `package.json` and `README.md`
39+
1. Update Compatibility table in `README.md`
3940
1. Update the `CHANGELOG.md`
41+
1. Update the `UPGRADING.md` if necessary
4042
1. `yarn build`
4143
1. `cd dist/angular-fontawesome`
4244
1. `npm publish`

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ $ npm install @fortawesome/angular-fontawesome@<version>
3333
|0.1.x|5.x|
3434
|0.2.x|6.x|
3535
|0.3.x|6.x && 7.x|
36-
|0.4.x|8.x|
36+
|0.4.x, 0.5.x|8.x|
3737

3838
## Usage
3939
To get up and running using Font Awesome with Angular follow below steps:
@@ -120,6 +120,8 @@ being awesome contributors to this project. **We'd like to take a moment to reco
120120
[<img src="https://github.com/stephaniepurvis.png?size=72" alt="stephaniepurvis" width="72">](https://github.com/stephaniepurvis)
121121
[<img src="https://github.com/loicgasser.png?size=72" alt="loicgasser" width="72">](https://github.com/loicgasser)
122122
[<img src="https://github.com/damienwebdev.png?size=72" alt="damienwebdev" width="72">](https://github.com/damienwebdev)
123+
[<img src="https://github.com/ronniebarker.png?size=72" alt="ronniebarker" width="72">](https://github.com/ronniebarker)
124+
[<img src="https://github.com/bhanuhiteshi.png?size=72" alt="bhanuhiteshi" width="72">](https://github.com/bhanuhiteshi)
123125

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

docs/upgrading/0.4.0-0.5.0.md

+21
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,24 @@ export class AppModule {
3131
```
3232

3333
You can also use `FaConfig.globalLibrary` property to change the warning into the hard error or suppress warnings altogether (not recommended).
34+
35+
## Changed semantics of FaIconComponent.icon property
36+
37+
`FaIconComponent.icon` property used to have type `Icon` (rendered icon object), which was changed to `IconProp` as it is now an input property to specify the icon definition. No replacement is provided.
38+
39+
If you were working with `FaIconComponent` programmatically you should switch from setting `FaIconComponent.iconProp` to `FaIconComponent.icon` as former is deprecated.
40+
41+
## FaIconComponent.listItem is deprecated
42+
43+
The input was not working and we don't want to support this pattern in angular-fontawesome.
44+
45+
You can use `fixedWidth=true` and custom CSS to achieve similar behavior:
46+
47+
```css
48+
ul {
49+
list-style-type: none;
50+
padding-left: 20px;
51+
}
52+
```
53+
54+
Demo: https://stackblitz.com/edit/angular-z8v4ux-o2yduf

package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "./node_modules/ng-packagr/package.schema.json",
33
"name": "@fortawesome/angular-fontawesome",
4-
"version": "0.4.0",
4+
"version": "0.5.0",
55
"description": "Angular Fontawesome, an Angular library",
66
"scripts": {
77
"test": "ng test angular-fontawesome --watch=false --browsers=ChromeCI",
@@ -31,7 +31,9 @@
3131
"Siddharth Ajmera <[email protected]>",
3232
"Stephanie Purvis <[email protected]>",
3333
"Gasser Loïc <[email protected]>",
34-
"Damien Retzinger <[email protected]>"
34+
"Damien Retzinger <[email protected]>",
35+
"Ronnie Barker <[email protected]>",
36+
"bhanuhiteshi <[email protected]>"
3537
],
3638
"license": "MIT",
3739
"bugs": {

0 commit comments

Comments
 (0)