@zakkster/lite-ui-fx 1.0.0 → 1.0.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 +13 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,11 +45,11 @@ All visual effects live in the GitHub repo as **recipes**.
|
|
|
45
45
|
|
|
46
46
|
📁 **Recipe Collections:**
|
|
47
47
|
- Vol. 1 (10 recipes):
|
|
48
|
-
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/UIFXRecipes.js
|
|
48
|
+
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/recipes/UIFXRecipes.js
|
|
49
49
|
- Vol. 2 (20 recipes):
|
|
50
|
-
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/UIFXRecipes2.js
|
|
50
|
+
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/recipes/UIFXRecipes2.js
|
|
51
51
|
- Vol. 3 (20 recipes):
|
|
52
|
-
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/UIFXRecipes3.js
|
|
52
|
+
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/recipes/UIFXRecipes3.js
|
|
53
53
|
|
|
54
54
|
📘 **How to write your own:**
|
|
55
55
|
https://github.com/PeshoVurtoleta/lite-ui-fx/blob/main/UIFX-RECIPE-GUIDE.md
|
|
@@ -184,7 +184,7 @@ Returns `{ el, canvas, wrapper, state, destroy() }`.
|
|
|
184
184
|
| Framer Motion | ~45 KB | React HOC | 0 | Via React | `npm i framer-motion` |
|
|
185
185
|
| GSAP | ~25 KB | Timeline | 0 | Manual | `npm i gsap` |
|
|
186
186
|
| Lottie | ~55 KB | JSON animation | After Effects | Manual | `npm i lottie-web` |
|
|
187
|
-
| **lite-ui-fx** | **< 5 KB** | **Canvas hijack** |
|
|
187
|
+
| **lite-ui-fx** | **< 5 KB** | **Canvas hijack** | *50 built-in** | **Native + visual** | **`npm i @zakkster/lite-ui-fx`** |
|
|
188
188
|
|
|
189
189
|
## 🎨 Writing Custom Recipes
|
|
190
190
|
|
|
@@ -214,13 +214,16 @@ export function MyButton() {
|
|
|
214
214
|
|
|
215
215
|
## 📦 TypeScript
|
|
216
216
|
|
|
217
|
-
Full declarations
|
|
217
|
+
Full TypeScript declarations are included for:
|
|
218
|
+
|
|
219
|
+
- `mountUIFX`
|
|
220
|
+
- `UIType`
|
|
221
|
+
- `UIFXState`
|
|
222
|
+
- `UIFXPointer`
|
|
223
|
+
- `UIFXRecipe`
|
|
224
|
+
|
|
225
|
+
(Recipes are not part of the npm package, so their types are not included.)
|
|
218
226
|
|
|
219
|
-
```
|
|
220
|
-
UIFXController.d.ts — mountUIFX, UIType, UIFXState, UIFXPointer, UIFXRecipe
|
|
221
|
-
UIFXRecipes.d.ts — 10 recipe factories (Vol. 1)
|
|
222
|
-
UIFXRecipes2.d.ts — 20 recipe factories (Vol. 2)
|
|
223
|
-
UIFXRecipes3.d.ts — 20 recipe factories (Vol. 3)
|
|
224
227
|
```
|
|
225
228
|
|
|
226
229
|
## 📚 LLM-Friendly Documentation
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zakkster/lite-ui-fx",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Canvas-hijacked UI components with a pluggable recipe system. 30 built-in recipes across toggles, buttons, sliders, knobs, loaders, checkboxes, counters, and ratings.",
|
|
5
5
|
"author": "Zahary Shinikchiev <shinikchiev@yahoo.com>",
|
|
6
6
|
"license": "MIT",
|