@vuecs/icons-font-awesome 1.1.1 → 1.1.2
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/README.md +40 -3
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,13 +1,23 @@
|
|
|
1
1
|
# @vuecs/icons-font-awesome
|
|
2
2
|
|
|
3
|
-
[
|
|
3
|
+
[](https://www.npmjs.com/package/@vuecs/icons-font-awesome)
|
|
4
|
+
[](https://github.com/Tada5hi/vuecs/actions/workflows/main.yml)
|
|
5
|
+
[](./LICENSE)
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
**[Font Awesome](https://fontawesome.com) icon preset for [vuecs](https://github.com/tada5hi/vuecs).** One `icons: [fontAwesome()]` entry fills every semantic icon slot in the framework (pagination first/prev/next/last, submit-button create/update, chevrons, close glyphs, …) with Font Awesome 6 Solid names rendered through `<VCIcon>`.
|
|
8
|
+
|
|
9
|
+
## ✨ How it works
|
|
10
|
+
|
|
11
|
+
Icon presets are **pure configuration** — a function returning behavioral defaults keyed by component. No icon fonts, no CSS, no bundled SVG data. The preset's names resolve through Iconify at render time, and your own `defaults:` / per-instance props always win over the preset.
|
|
12
|
+
|
|
13
|
+
## 📦 Installation
|
|
6
14
|
|
|
7
15
|
```bash
|
|
8
16
|
npm install @vuecs/icons-font-awesome
|
|
9
17
|
```
|
|
10
18
|
|
|
19
|
+
## ⚡ Usage
|
|
20
|
+
|
|
11
21
|
```ts
|
|
12
22
|
import { createApp } from 'vue';
|
|
13
23
|
import vuecs from '@vuecs/core';
|
|
@@ -16,4 +26,31 @@ import fontAwesome from '@vuecs/icons-font-awesome';
|
|
|
16
26
|
createApp(App).use(vuecs, { icons: [fontAwesome()] });
|
|
17
27
|
```
|
|
18
28
|
|
|
19
|
-
|
|
29
|
+
You also need an Iconify **delivery** mechanism (the preset only supplies names):
|
|
30
|
+
|
|
31
|
+
- **Nuxt** — [`@nuxt/icon`](https://nuxt.com/modules/icon)
|
|
32
|
+
- **Vite / SPA** — `addCollection()` from `@iconify/vue` + `@iconify-json/fa6-solid` for offline bundling
|
|
33
|
+
- **Zero-config** — Iconify's runtime CDN (default fallback)
|
|
34
|
+
|
|
35
|
+
## 🔄 Migrating from `@vuecs/theme-font-awesome`
|
|
36
|
+
|
|
37
|
+
Same Font Awesome visuals, now driven through `<VCIcon>` (Iconify) instead of CSS-class injection:
|
|
38
|
+
|
|
39
|
+
```diff
|
|
40
|
+
- import fa from '@vuecs/theme-font-awesome';
|
|
41
|
+
- app.use(vuecs, { themes: [fa()] });
|
|
42
|
+
+ import fa from '@vuecs/icons-font-awesome';
|
|
43
|
+
+ app.use(vuecs, { icons: [fa()] });
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
…then install `@iconify-json/fa6-solid` (or use `@nuxt/icon`).
|
|
47
|
+
|
|
48
|
+
## 📚 Documentation
|
|
49
|
+
|
|
50
|
+
Setup recipes per stack: **[vuecs.dev/getting-started/icons](https://vuecs.dev/getting-started/icons)**
|
|
51
|
+
|
|
52
|
+
## License
|
|
53
|
+
|
|
54
|
+
Made with 💚
|
|
55
|
+
|
|
56
|
+
Published under [Apache 2.0 License](./LICENSE).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vuecs/icons-font-awesome",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Font Awesome icon preset for vuecs — maps semantic-slot defaults (pagination prev/next/first/last, submit-button create/update, ...) to Font Awesome 6 Solid Iconify names. Successor to @vuecs/theme-font-awesome.",
|
|
6
6
|
"exports": {
|
|
@@ -39,10 +39,10 @@
|
|
|
39
39
|
"build": "rimraf dist && npm run build:js && npm run build:types"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@vuecs/core": "^3.2.
|
|
42
|
+
"@vuecs/core": "^3.2.1"
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {
|
|
45
|
-
"@vuecs/core": "^3.2.
|
|
45
|
+
"@vuecs/core": "^3.2.1"
|
|
46
46
|
},
|
|
47
47
|
"engines": {
|
|
48
48
|
"node": ">=22.0.0"
|