@featherk/icons 0.14.0 → 0.14.1
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.
- package/docs/ICONS.md +1 -1
- package/docs/fontawesome/FontAwesome.md +5 -4
- package/package.json +3 -3
package/docs/ICONS.md
CHANGED
|
@@ -7,7 +7,7 @@ Once UX/Design has supplied the approved manifest, Dev owns source installation,
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
9
9
|
1. UX/Design selects and approves each exact icon variant and records it in the [manifest](CreateFontAwesomeManifest.md); the license owner confirms Pro entitlement and approved release coverage.
|
|
10
|
-
2. Dev installs `@featherk/icons` with the Font Awesome Vite entry point and ensures compatible Vite 7.x is available using [Install the Vite Integration](#install-the-vite-integration).
|
|
10
|
+
2. Dev installs `@featherk/icons` with the Font Awesome Vite entry point and ensures compatible Vite 7.x or 8.x is available using [Install the Vite Integration](#install-the-vite-integration).
|
|
11
11
|
3. Dev confirms access and availability for each manifest `package` and exact `version`, configures authorized registry access when required, then installs those matching pinned npm packages using [Install Source Packages](#install-source-packages). For Pro, follow [Pro token setup](LICENSING.md#dev-setup-quick-start) before installation.
|
|
12
12
|
4. Dev configures the Vite plugin to use the approved manifest and validates the installed selections in [Vite Setup](#vite-setup).
|
|
13
13
|
5. Dev renders the selected descriptors through the virtual module using the [rendering example](#render-the-selected-key).
|
|
@@ -66,10 +66,11 @@ const houseIcon = getFaIcon("pro-house-light");
|
|
|
66
66
|
|
|
67
67
|
## Install the Vite Integration
|
|
68
68
|
|
|
69
|
-
The Dev integration requires `@featherk/icons` to export `@featherk/icons/fontawesome/vite`. Its Vite peer dependency
|
|
69
|
+
The Dev integration requires `@featherk/icons` to export `@featherk/icons/fontawesome/vite`. Its optional Vite peer dependency supports `^7.0.0` and `^8.0.0`. Install `@featherk/icons` and the Vite major already used by the application as development dependencies if they are not already available:
|
|
70
70
|
|
|
71
71
|
```sh
|
|
72
72
|
npm install --save-dev @featherk/icons vite@^7.0.0
|
|
73
|
+
# For Vite 8, use vite@^8.0.0 instead.
|
|
73
74
|
```
|
|
74
75
|
|
|
75
76
|
## Install Source Packages
|
|
@@ -102,7 +103,7 @@ import type { FontAwesomeSelection } from "@featherk/icons/fontawesome";
|
|
|
102
103
|
import manifest from "./fontawesome.icons.json";
|
|
103
104
|
|
|
104
105
|
// Step 1: Use the UX-approved manifest and verify required entitlement.
|
|
105
|
-
// Step 2: Ensure @featherk/icons and Vite 7 are available.
|
|
106
|
+
// Step 2: Ensure @featherk/icons and Vite 7 or 8 are available.
|
|
106
107
|
// Step 3: Install the npm packages matching each manifest package and version before Vite starts.
|
|
107
108
|
export default defineConfig({
|
|
108
109
|
// Step 4: Use the selections from the manifest approved and installed above.
|
|
@@ -133,7 +134,7 @@ const accountIcon = getFaIcon("account");
|
|
|
133
134
|
</script>
|
|
134
135
|
```
|
|
135
136
|
|
|
136
|
-
The plugin requires Vite 7. It writes `src/featherk-fontawesome.d.ts` on startup by default; include that file in TypeScript and ignore it in version control. `virtualTypesFile` selects another project-local `.d.ts` file or disables writing with `false`. Startup is too late for a type checker invoked before Vite, so retain the explicit CLI preparation step in that build order.
|
|
137
|
+
The plugin requires Vite 7 or 8. It writes `src/featherk-fontawesome.d.ts` on startup by default; include that file in TypeScript and ignore it in version control. `virtualTypesFile` selects another project-local `.d.ts` file or disables writing with `false`. Startup is too late for a type checker invoked before Vite, so retain the explicit CLI preparation step in that build order.
|
|
137
138
|
|
|
138
139
|
### Preserve License Notices
|
|
139
140
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@featherk/icons",
|
|
3
|
-
"version": "0.14.
|
|
3
|
+
"version": "0.14.1",
|
|
4
4
|
"main": "dist/featherk-icons.umd.js",
|
|
5
5
|
"module": "dist/featherk-icons.es.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"featherk-fontawesome": "scripts/fontawesome.mjs"
|
|
37
37
|
},
|
|
38
38
|
"peerDependencies": {
|
|
39
|
-
"vite": "^7.0.0"
|
|
39
|
+
"vite": "^7.0.0 || ^8.0.0"
|
|
40
40
|
},
|
|
41
41
|
"peerDependenciesMeta": {
|
|
42
42
|
"vite": {
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"@types/node": "^24.5.2",
|
|
61
61
|
"@vitejs/plugin-vue": "^6.0.1",
|
|
62
62
|
"typescript": "~5.8.3",
|
|
63
|
-
"vite": "^7.1.7"
|
|
63
|
+
"vite": "^7.1.7 || ^8.0.0"
|
|
64
64
|
},
|
|
65
65
|
"publishConfig": {
|
|
66
66
|
"access": "public"
|