@fortawesome/vue-fontawesome 3.0.1 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +41 -11
  2. package/README.md +13 -5
  3. package/index.d.ts +32 -24
  4. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,15 +1,45 @@
1
1
  # Change Log
2
+
2
3
  All notable changes to this project will be documented in this file.
3
4
 
4
5
  The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
5
6
 
6
7
  ---
7
8
 
9
+ ## [3.0.3](https://github.com/FortAwesome/vue-fontawesome/releases/tag/3.0.3) - 2023-01-24
10
+
11
+ ### Changed
12
+
13
+ - NPM download `@fortawesome/vue-fontawesome-latest` is now set to Vue 3; to download the Vue 2 package you will have to use `@fortawesome/vue-fontawesome-latest-2`, which is described in our [Vue setup docs](https://fontawesome.com/docs/web/use-with/vue/#_3-add-the-vue-component)
14
+ - CI workflow updated for testing
15
+ - README.md and package.json updated for new contributor
16
+
17
+ ### Added
18
+
19
+ - Missing TypeScript animations added (github issue #[428](https://github.com/FortAwesome/vue-fontawesome/issues/428))
20
+ - Missing TypeScript sizes added (github issue #[415](https://github.com/FortAwesome/vue-fontawesome/issues/415))
21
+
22
+ ---
23
+
24
+ ## [3.0.2](https://github.com/FortAwesome/vue-fontawesome/releases/tag/3.0.2) - 2022-11-07
25
+
26
+ ### Changed
27
+
28
+ - Vue 3 Composition API TypeScript support (github issue #[276](https://github.com/FortAwesome/vue-fontawesome/issues/276))
29
+ - Updated README.md with a spelling correction, linter fixes, and new contributor
30
+ - Updated icon example in App.vue to use `fixed-width` rather than `full-width`
31
+
32
+ ### Added
33
+
34
+ - Missing tests
35
+
36
+ ---
37
+
8
38
  ## [3.0.1](https://github.com/FortAwesome/vue-fontawesome/releases/tag/3.0.1) - 2022-06-17
9
39
 
10
40
  ### Changed
11
41
 
12
- * README.md Documentation now points to https://fontawesome.com/docs/web/use-with/vue/
42
+ - README.md Documentation now points to https://fontawesome.com/docs/web/use-with/vue/
13
43
 
14
44
  ---
15
45
 
@@ -17,14 +47,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
17
47
 
18
48
  ### Added
19
49
 
20
- * New animations for bounce and shake
21
- * Feature to call icons using a string format
50
+ - New animations for bounce and shake
51
+ - Feature to call icons using a string format
22
52
 
23
53
  ### Fixed
24
54
 
25
- * Animations for beat, fade, beat-fade, flash, spin-pulse, and spin-reverse
26
- * Tee-shirt sizes to include 2xs, lg, xl, and 2xl
27
- * Flip animation when used by itself
55
+ - Animations for beat, fade, beat-fade, flash, spin-pulse, and spin-reverse
56
+ - Tee-shirt sizes to include 2xs, lg, xl, and 2xl
57
+ - Flip animation when used by itself
28
58
 
29
59
  ---
30
60
 
@@ -32,7 +62,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
32
62
 
33
63
  ### Fixed
34
64
 
35
- * Include 1.3.0-beta versions in peer dependencies
65
+ - Include 1.3.0-beta versions in peer dependencies
36
66
 
37
67
  ---
38
68
 
@@ -40,7 +70,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
40
70
 
41
71
  ### Fixed
42
72
 
43
- * Fix reactivity #297
73
+ - Fix reactivity #297
44
74
 
45
75
  ---
46
76
 
@@ -48,7 +78,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
48
78
 
49
79
  ### Fixed
50
80
 
51
- * Allow for non-RC releases of Vue 3
81
+ - Allow for non-RC releases of Vue 3
52
82
 
53
83
  ---
54
84
 
@@ -56,7 +86,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
56
86
 
57
87
  ### Fixed
58
88
 
59
- * Make Vue as an external dependency #258 #260
89
+ - Make Vue as an external dependency #258 #260
60
90
 
61
91
  ---
62
92
 
@@ -64,7 +94,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
64
94
 
65
95
  ### Added
66
96
 
67
- * Support for Vue 3.x RC's and betas #246 #249
97
+ - Support for Vue 3.x RC's and betas #246 #249
68
98
 
69
99
  ---
70
100
 
package/README.md CHANGED
@@ -22,22 +22,28 @@
22
22
 
23
23
  ## Documentation
24
24
 
25
- Official documentation is hosted at fontawesome.com: [Check it out here](https://fontawesome.com/docs/web/use-with/vue/)
25
+ Official documentation is hosted at fontawesome.com
26
+
27
+ Helpful Vue links:
28
+ - [Add Icons with Vue](https://fontawesome.com/docs/web/use-with/vue/add-icons)
29
+ - [Adding Icon Styling with Vue](https://fontawesome.com/docs/web/use-with/vue/style)
30
+
31
+ To find the Vue setup, go to our [Web docs](https://fontawesome.com/docs/web) and click the ***"Set Up with Vue"*** (left hand side menu).
26
32
 
27
33
  ## How to Help
28
34
 
29
35
  Review the following docs before diving in:
30
36
 
31
- * [CONTRIBUTING.md](CONTRIBUTING.md)
32
- * [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
37
+ - [CONTRIBUTING.md](CONTRIBUTING.md)
38
+ - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
33
39
 
34
40
  And then:
35
41
 
36
- * Check the existing [issues](https://github.com/FortAwesome/vue-fontawesome/issues) and see if you can help!
42
+ - Check the existing [issues](https://github.com/FortAwesome/vue-fontawesome/issues) and see if you can help!
37
43
 
38
44
  ## Contributors
39
45
 
40
- The following contributors have either hepled to start this project, have contributed
46
+ The following contributors have either helped to start this project, have contributed
41
47
  code, are actively maintaining it (including documentation), or in other ways
42
48
  being awesome contributors to this project. **We'd like to take a moment to recognize them.**
43
49
 
@@ -53,6 +59,8 @@ being awesome contributors to this project. **We'd like to take a moment to reco
53
59
  | <img src="https://github.com/rigma.png?size=72" /> | Romain Failla | [@rigma](https://github.com/rigma) |
54
60
  | <img src="https://github.com/viniciuslrangel.png?size=72" /> | Vinicius Rangel | [@viniciuslrangel](https://github.com/viniciuslrangel) |
55
61
  | <img src="https://github.com/otijhuis.png?size=72" /> | Okke Tijhuis | [@otijhuis](https://github.com/otijhuis) |
62
+ | <img src="https://github.com/parkeyparker.png?size=72" /> | Aaron Parker | [@parkeyparker](https://github.com/parkeyparker) |
63
+ | <img src="https://github.com/brandon-mork.png?size=72" /> | Brandon Mork | [@brandon-mork](https://github.com/brandon-mork) |
56
64
 
57
65
  If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
58
66
 
package/index.d.ts CHANGED
@@ -1,35 +1,43 @@
1
- import { ComponentPublicInstance } from 'vue'
1
+ import { IconDefinition } from '@fortawesome/fontawesome-svg-core';
2
+ import { DefineComponent } from 'vue'
2
3
 
3
4
  interface FontAwesomeIconProps {
4
- border: boolean
5
- fixedWidth: boolean
6
- flip: boolean | 'horizontal' | 'vertical' | 'both'
7
- icon: object | Array<string> | string
8
- mask: object | Array<string> | string | null
9
- listItem: boolean
10
- pull: 'right' | 'left' | null
11
- pulse: boolean
12
- rotation: 90 | 180 | 270 | '90' | '180' | '270' | null
13
- swapOpacity: boolean
14
- size: 'lg' | 'xs' | 'sm' | '1x' | '2x' | '3x' | '4x' | '5x' | '6x' | '7x' | '8x' | '9x' | '10x' | null
15
- spin: boolean
16
- transform: object | string | null
17
- symbol: boolean | string
18
- title: string | null
19
- inverse: boolean
5
+ border?: boolean
6
+ fixedWidth?: boolean
7
+ flip?: 'horizontal' | 'vertical' | 'both'
8
+ icon: object | Array<string> | string | IconDefinition
9
+ mask?: object | Array<string> | string
10
+ listItem?: boolean
11
+ pull?: 'right' | 'left'
12
+ pulse?: boolean
13
+ rotation?: 90 | 180 | 270 | '90' | '180' | '270'
14
+ swapOpacity?: boolean
15
+ size?: '2xs' | 'xs' | 'sm' | 'lg' | 'xl' | '2xl' | '1x' | '2x' | '3x' | '4x' | '5x' | '6x' | '7x' | '8x' | '9x' | '10x'
16
+ spin?: boolean
17
+ transform?: object | string
18
+ symbol?: boolean | string
19
+ title?: string
20
+ inverse?: boolean
21
+ bounce?: boolean
22
+ shake?: boolean
23
+ beat?: boolean
24
+ fade?: boolean
25
+ beatFade?: boolean
26
+ spinPulse?: boolean
27
+ spinReverse?: boolean
20
28
  }
21
29
 
22
30
  interface FontAwesomeLayersProps {
23
- fixedWidth: boolean
31
+ fixedWidth?: boolean
24
32
  }
25
33
 
26
34
  interface FontAwesomeLayersTextProps {
27
35
  value: string | number
28
- transform: object | string | null
29
- counter: boolean
30
- position: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right' | null
36
+ transform?: object | string
37
+ counter?: boolean
38
+ position?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right'
31
39
  }
32
40
 
33
- declare const FontAwesomeIcon: ComponentPublicInstance<FontAwesomeIconProps>
34
- declare const FontAwesomeLayers: ComponentPublicInstance<FontAwesomeLayersProps>
35
- declare const FontAwesomeLayersText: ComponentPublicInstance<FontAwesomeLayersTextProps>
41
+ declare const FontAwesomeIcon: DefineComponent<FontAwesomeIconProps>
42
+ declare const FontAwesomeLayers: DefineComponent<FontAwesomeLayersProps>
43
+ declare const FontAwesomeLayersText: DefineComponent<FontAwesomeLayersTextProps>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@fortawesome/vue-fontawesome",
3
3
  "description": "Official Vue component for Font Awesome 6",
4
- "version": "3.0.1",
4
+ "version": "3.0.3",
5
5
  "main": "index.js",
6
6
  "files": [
7
7
  "README.md",
@@ -36,15 +36,15 @@
36
36
  "David Driscoll <github.com/david-driscoll>",
37
37
  "Tyranteon <github.com/tyranteon>",
38
38
  "Vinicius Rangel <github.com/viniciuslrangel>",
39
- "Okke Tijhuis <github.com/otijhuis>"
39
+ "Okke Tijhuis <github.com/otijhuis>",
40
+ "Aaron Parker <github.com/parkeyparker>",
41
+ "Brandon Mork <github.com/brandon-mork>"
40
42
  ],
41
43
  "license": "MIT",
42
44
  "scripts": {
43
45
  "build": "rollup -c rollup.config.js",
44
46
  "dist": "cross-env NODE_ENV=production npm run build",
45
- "test": "npm run test.5 && npm run test.6",
46
- "test.5": "npm --no-save install @fortawesome/fontawesome-svg-core@1.2.x @fortawesome/free-solid-svg-icons@5.x && jest --silent",
47
- "test.6": "npm --no-save install @fortawesome/fontawesome-svg-core@6.x @fortawesome/free-solid-svg-icons@6.x && jest --silent",
47
+ "test": "jest --silent",
48
48
  "prepack": "npm run dist"
49
49
  },
50
50
  "lint-staged": {