use-scroll-animate 3.0.0 → 3.2.0

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 (66) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +2 -0
  3. package/README_ja.md +2 -0
  4. package/README_zh.md +2 -0
  5. package/dist/chunks/{base-Co98Z2iM.js → base-Cu-86Z31.js} +2 -2
  6. package/dist/chunks/{base-Co98Z2iM.js.map → base-Cu-86Z31.js.map} +1 -1
  7. package/dist/chunks/{index-tags-BEM98giN.cjs → index-tags-DCTX4F9b.cjs} +3 -1
  8. package/dist/chunks/{index-tags-BEM98giN.cjs.map → index-tags-DCTX4F9b.cjs.map} +1 -1
  9. package/dist/chunks/{index-tags-f37txHmb.js → index-tags-DZ-gjMZc.js} +3 -1
  10. package/dist/chunks/{index-tags-f37txHmb.js.map → index-tags-DZ-gjMZc.js.map} +1 -1
  11. package/dist/chunks/{spring-YNUpez2g.js → spring-BV-cpTHC.js} +2 -2
  12. package/dist/chunks/{spring-YNUpez2g.js.map → spring-BV-cpTHC.js.map} +1 -1
  13. package/dist/chunks/{variants-Dp_5lJ_J.js → variants-BQ3gCb5L.js} +2 -2
  14. package/dist/chunks/{variants-Dp_5lJ_J.js.map → variants-BQ3gCb5L.js.map} +1 -1
  15. package/dist/components/background.js +3 -3
  16. package/dist/components/cards.js +3 -3
  17. package/dist/components/click.js +3 -3
  18. package/dist/components/feedback.js +2 -2
  19. package/dist/components/gesture.cjs +387 -0
  20. package/dist/components/gesture.cjs.map +1 -0
  21. package/dist/components/gesture.css +3 -0
  22. package/dist/components/gesture.d.cts +169 -0
  23. package/dist/components/gesture.d.ts +169 -0
  24. package/dist/components/gesture.js +379 -0
  25. package/dist/components/gesture.js.map +1 -0
  26. package/dist/components/interaction.js +2 -2
  27. package/dist/components/jsx.d.cts +2 -0
  28. package/dist/components/jsx.d.ts +2 -0
  29. package/dist/components/lazy.cjs +3 -1
  30. package/dist/components/lazy.cjs.map +1 -1
  31. package/dist/components/lazy.d.cts +2 -0
  32. package/dist/components/lazy.d.ts +2 -0
  33. package/dist/components/lazy.js +3 -1
  34. package/dist/components/lazy.js.map +1 -1
  35. package/dist/components/page.js +3 -3
  36. package/dist/components/physics.js +4 -4
  37. package/dist/components/react.cjs +1 -1
  38. package/dist/components/react.js +1 -1
  39. package/dist/components/reveal.js +2 -2
  40. package/dist/components/text.js +2 -2
  41. package/dist/components/timeline.cjs +303 -0
  42. package/dist/components/timeline.cjs.map +1 -0
  43. package/dist/components/timeline.css +3 -0
  44. package/dist/components/timeline.d.cts +164 -0
  45. package/dist/components/timeline.d.ts +164 -0
  46. package/dist/components/timeline.js +296 -0
  47. package/dist/components/timeline.js.map +1 -0
  48. package/dist/components/transitions.js +2 -2
  49. package/dist/components/ui.js +5 -5
  50. package/dist/components/vue.cjs +3 -1
  51. package/dist/components/vue.cjs.map +1 -1
  52. package/dist/components/vue.d.cts +135 -0
  53. package/dist/components/vue.d.ts +135 -0
  54. package/dist/components/vue.js +6 -4
  55. package/dist/components/vue.js.map +1 -1
  56. package/dist/components.cjs +16 -1
  57. package/dist/components.cjs.map +1 -1
  58. package/dist/components.css +2 -0
  59. package/dist/components.d.cts +243 -2
  60. package/dist/components.d.ts +243 -2
  61. package/dist/components.js +13 -7
  62. package/dist/components.js.map +1 -1
  63. package/dist/components.umd.js +2 -2
  64. package/dist/components.umd.js.map +1 -1
  65. package/docs/components.md +17 -0
  66. package/package.json +24 -2
@@ -231,6 +231,23 @@ Every component reads these CSS custom properties (set them on `:root`, any ance
231
231
 
232
232
  See [frameworks-ssr.md](./frameworks-ssr.md) and [accessibility.md](./accessibility.md).
233
233
 
234
+ ### v3.1 Timeline & choreography (`components/timeline`)
235
+
236
+ | Element / API | What it does | Key options |
237
+ |---|---|---|
238
+ | `timeline(opts)` | One playhead for many animations | `.to(target, frames \| preset, { at, duration, easing, stagger })`, `.label()`, `.call()`, `play()`, `reverse()`, `seek()`, `progress()`, `scrub(el, { smooth })` |
239
+ | `<usa-timeline>` | `data-tl` children become steps | `trigger` (`view` · `click` · `manual`), `scrub`, `overlap`, `duration`, `stagger`, `repeat`; child `data-at`, `data-duration`, `data-label` |
240
+
241
+ Positions: `'>'` chain (default) · `'<'` with previous · `'-=200'` overlap · `'+=100'` gap · `'<+=50'` · `'label+=100'` · ms.
242
+
243
+ ### v3.2 Gestures (`components/gesture`)
244
+
245
+ | Element / API | What it does | Key options |
246
+ |---|---|---|
247
+ | `gesture(el, handlers, opts)` | Pan · swipe · pinch · long-press · tap · double-tap | `onPan({ dx, dy, vx, vy, first, last })`, `onSwipe({ direction, velocity })`, `onPinch({ scale })`, `onLongPress`, `onTap`, `onDoubleTap`; `axis`, `threshold`, `swipeDistance`, `swipeVelocity`, `longPress`, `wheelPinch` |
248
+ | `<usa-swipeable>` | Swipe to dismiss, spring home | `axis`, `distance` (120), `preset`, `dismiss`; `usa:swipe`, `usa:dismiss`; `swipe(dir)`, `reset()` |
249
+ | `<usa-pinch-zoom>` | Pinch / Ctrl+wheel zoom + pan | `min` (1), `max` (4), `double-tap` (2), `preset`; `zoomTo(k)`, `usa:zoom` |
250
+
234
251
  ## Frameworks
235
252
 
236
253
  Custom elements work in every framework. Register once (e.g. in your entry file), then use the tags.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "use-scroll-animate",
3
- "version": "3.0.0",
3
+ "version": "3.2.0",
4
4
  "description": "A lightweight, high-performance, dependency-free scroll animation library and animated UI components (Web Components) for the web and Windows web-view apps.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -188,6 +188,26 @@
188
188
  "default": "./dist/components/page.cjs"
189
189
  }
190
190
  },
191
+ "./components/timeline": {
192
+ "import": {
193
+ "types": "./dist/components/timeline.d.ts",
194
+ "default": "./dist/components/timeline.js"
195
+ },
196
+ "require": {
197
+ "types": "./dist/components/timeline.d.cts",
198
+ "default": "./dist/components/timeline.cjs"
199
+ }
200
+ },
201
+ "./components/gesture": {
202
+ "import": {
203
+ "types": "./dist/components/gesture.d.ts",
204
+ "default": "./dist/components/gesture.js"
205
+ },
206
+ "require": {
207
+ "types": "./dist/components/gesture.d.cts",
208
+ "default": "./dist/components/gesture.cjs"
209
+ }
210
+ },
191
211
  "./components/react": {
192
212
  "import": {
193
213
  "types": "./dist/components/react.d.ts",
@@ -240,6 +260,8 @@
240
260
  "./components/click.css": "./dist/components/click.css",
241
261
  "./components/ui.css": "./dist/components/ui.css",
242
262
  "./components/page.css": "./dist/components/page.css",
263
+ "./components/timeline.css": "./dist/components/timeline.css",
264
+ "./components/gesture.css": "./dist/components/gesture.css",
243
265
  "./package.json": "./package.json"
244
266
  },
245
267
  "files": [
@@ -260,7 +282,7 @@
260
282
  "typecheck": "tsc --noEmit -p .",
261
283
  "test": "vitest run",
262
284
  "check:exports": "node scripts/check-exports.mjs",
263
- "lint:package": "publint && attw --pack . --profile node16 --exclude-entrypoints ./components.css ./components/reveal.css ./components/text.css ./components/interaction.css ./components/feedback.css ./components/background.css ./components/transitions.css ./components/physics.css ./components/cards.css ./components/click.css ./components/ui.css ./components/page.css",
285
+ "lint:package": "publint && attw --pack . --profile node16 --exclude-entrypoints ./components.css ./components/reveal.css ./components/text.css ./components/interaction.css ./components/feedback.css ./components/background.css ./components/transitions.css ./components/physics.css ./components/cards.css ./components/click.css ./components/ui.css ./components/page.css ./components/timeline.css ./components/gesture.css",
264
286
  "size": "node scripts/size.mjs",
265
287
  "prepublishOnly": "npm run typecheck && npm test && npm run build && npm run check:exports",
266
288
  "size:check": "node scripts/size.mjs --check",