use-scroll-animate 3.9.0 → 4.0.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 (132) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +16 -14
  3. package/README_ja.md +10 -11
  4. package/README_zh.md +11 -12
  5. package/dist/chunks/{base-Dm6ee5ug.cjs → base-CXx7jZ-o.cjs} +1 -11
  6. package/dist/chunks/{base-Dm6ee5ug.cjs.map → base-CXx7jZ-o.cjs.map} +1 -1
  7. package/dist/chunks/{base-BRIPyPtX.js → base-ZARFccur.js} +2 -11
  8. package/dist/chunks/{base-BRIPyPtX.js.map → base-ZARFccur.js.map} +1 -1
  9. package/dist/chunks/core-Co-6AL0h.js +218 -0
  10. package/dist/chunks/core-Co-6AL0h.js.map +1 -0
  11. package/dist/chunks/{core-CYozf_E-.js → core-DKY-fVzR.js} +2 -2
  12. package/dist/chunks/{core-CYozf_E-.js.map → core-DKY-fVzR.js.map} +1 -1
  13. package/dist/chunks/core-DXqZm5Il.cjs +222 -0
  14. package/dist/chunks/core-DXqZm5Il.cjs.map +1 -0
  15. package/dist/chunks/{core-CHAtivHV.cjs → core-IaorbTdu.cjs} +2 -2
  16. package/dist/chunks/{core-CHAtivHV.cjs.map → core-IaorbTdu.cjs.map} +1 -1
  17. package/dist/chunks/{index-tags-BmQR17Sb.js → index-tags-43Xtd01A.js} +2 -2
  18. package/dist/chunks/index-tags-43Xtd01A.js.map +1 -0
  19. package/dist/chunks/{index-tags-DYYsgbba.cjs → index-tags-BQh_uGqH.cjs} +2 -2
  20. package/dist/chunks/index-tags-BQh_uGqH.cjs.map +1 -0
  21. package/dist/chunks/{spring-Dp5BllPB.cjs → spring-2OTnYCzm.cjs} +2 -2
  22. package/dist/chunks/{spring-Dp5BllPB.cjs.map → spring-2OTnYCzm.cjs.map} +1 -1
  23. package/dist/chunks/{spring-UBPhrh1X.js → spring-E2ickYNI.js} +2 -2
  24. package/dist/chunks/{spring-UBPhrh1X.js.map → spring-E2ickYNI.js.map} +1 -1
  25. package/dist/chunks/{variants-_dC-ey6R.cjs → variants-BNIrn4ch.cjs} +2 -2
  26. package/dist/chunks/{variants-_dC-ey6R.cjs.map → variants-BNIrn4ch.cjs.map} +1 -1
  27. package/dist/chunks/{variants-DTypaOH3.js → variants-DvnxvRCM.js} +2 -2
  28. package/dist/chunks/{variants-DTypaOH3.js.map → variants-DvnxvRCM.js.map} +1 -1
  29. package/dist/components/angular.cjs +6 -5
  30. package/dist/components/angular.cjs.map +1 -1
  31. package/dist/components/angular.d.cts +4 -17
  32. package/dist/components/angular.d.ts +4 -17
  33. package/dist/components/angular.js +6 -5
  34. package/dist/components/angular.js.map +1 -1
  35. package/dist/components/background.cjs +2 -2
  36. package/dist/components/background.js +3 -3
  37. package/dist/components/cards.cjs +2 -2
  38. package/dist/components/cards.js +3 -3
  39. package/dist/components/click.cjs +2 -2
  40. package/dist/components/click.js +3 -3
  41. package/dist/components/depth.cjs +3 -3
  42. package/dist/components/depth.js +4 -4
  43. package/dist/components/feedback.cjs +1 -1
  44. package/dist/components/feedback.js +2 -2
  45. package/dist/components/gesture.cjs +3 -3
  46. package/dist/components/gesture.js +5 -5
  47. package/dist/components/interaction.cjs +1 -1
  48. package/dist/components/interaction.js +2 -2
  49. package/dist/components/jsx.d.cts +1 -1
  50. package/dist/components/jsx.d.ts +1 -1
  51. package/dist/components/layout.cjs +1 -1
  52. package/dist/components/layout.js +2 -2
  53. package/dist/components/lazy.cjs +1 -1
  54. package/dist/components/lazy.d.cts +1 -1
  55. package/dist/components/lazy.d.ts +1 -1
  56. package/dist/components/lazy.js +1 -1
  57. package/dist/components/packs.cjs +1 -1
  58. package/dist/components/packs.js +2 -2
  59. package/dist/components/page.cjs +2 -2
  60. package/dist/components/page.js +3 -3
  61. package/dist/components/physics.cjs +2 -2
  62. package/dist/components/physics.js +4 -4
  63. package/dist/components/react.cjs +2 -2
  64. package/dist/components/react.cjs.map +1 -1
  65. package/dist/components/react.d.cts +1 -1
  66. package/dist/components/react.d.ts +1 -1
  67. package/dist/components/react.js +2 -2
  68. package/dist/components/react.js.map +1 -1
  69. package/dist/components/reveal.cjs +1 -1
  70. package/dist/components/reveal.js +2 -2
  71. package/dist/components/solid.cjs +6 -5
  72. package/dist/components/solid.cjs.map +1 -1
  73. package/dist/components/solid.d.cts +4 -17
  74. package/dist/components/solid.d.ts +4 -17
  75. package/dist/components/solid.js +6 -5
  76. package/dist/components/solid.js.map +1 -1
  77. package/dist/components/svelte.cjs +6 -5
  78. package/dist/components/svelte.cjs.map +1 -1
  79. package/dist/components/svelte.d.cts +4 -17
  80. package/dist/components/svelte.d.ts +4 -17
  81. package/dist/components/svelte.js +6 -5
  82. package/dist/components/svelte.js.map +1 -1
  83. package/dist/components/svg.cjs +1 -1
  84. package/dist/components/svg.js +2 -2
  85. package/dist/components/text.cjs +1 -1
  86. package/dist/components/text.js +2 -2
  87. package/dist/components/timeline.cjs +7 -220
  88. package/dist/components/timeline.cjs.map +1 -1
  89. package/dist/components/timeline.js +5 -217
  90. package/dist/components/timeline.js.map +1 -1
  91. package/dist/components/transitions.cjs +8 -125
  92. package/dist/components/transitions.cjs.map +1 -1
  93. package/dist/components/transitions.css +0 -1
  94. package/dist/components/transitions.d.cts +5 -34
  95. package/dist/components/transitions.d.ts +5 -34
  96. package/dist/components/transitions.js +10 -125
  97. package/dist/components/transitions.js.map +1 -1
  98. package/dist/components/ui.cjs +3 -3
  99. package/dist/components/ui.js +5 -5
  100. package/dist/components/vue.cjs +6 -5
  101. package/dist/components/vue.cjs.map +1 -1
  102. package/dist/components/vue.d.cts +4 -17
  103. package/dist/components/vue.d.ts +4 -17
  104. package/dist/components/vue.js +6 -5
  105. package/dist/components/vue.js.map +1 -1
  106. package/dist/components/webgl.cjs +1 -1
  107. package/dist/components/webgl.js +2 -2
  108. package/dist/components.cjs +12 -13
  109. package/dist/components.cjs.map +1 -1
  110. package/dist/components.css +0 -1
  111. package/dist/components.d.cts +6 -35
  112. package/dist/components.d.ts +6 -35
  113. package/dist/components.js +10 -9
  114. package/dist/components.js.map +1 -1
  115. package/dist/components.umd.js +2 -2
  116. package/dist/components.umd.js.map +1 -1
  117. package/dist/index.cjs +5 -109
  118. package/dist/index.cjs.map +1 -1
  119. package/dist/index.d.cts +72 -32
  120. package/dist/index.d.ts +72 -32
  121. package/dist/index.js +4 -110
  122. package/dist/index.js.map +1 -1
  123. package/dist/index.umd.js +2 -2
  124. package/dist/index.umd.js.map +1 -1
  125. package/docs/API.md +6 -6
  126. package/docs/ROADMAP.md +14 -0
  127. package/docs/components.md +3 -5
  128. package/docs/migration-from-aos.md +1 -1
  129. package/docs/migration-from-gsap-scrolltrigger.md +6 -6
  130. package/package.json +1 -1
  131. package/dist/chunks/index-tags-BmQR17Sb.js.map +0 -1
  132. package/dist/chunks/index-tags-DYYsgbba.cjs.map +0 -1
@@ -27,7 +27,7 @@ No stylesheet is needed: animations run through the Web Animations API (or opt i
27
27
  | `data-aos-once="true"` | `data-sa-once` (default) |
28
28
  | `data-aos-mirror="true"` (animate out when scrolling past) | `data-sa-exit` |
29
29
  | `data-aos-anchor-placement="top-center"` | `data-sa-threshold="0.5"` or `data-sa-root-margin="0px 0px -50% 0px"` |
30
- | `data-aos-anchor=".other"` | `sequence([...], { trigger: '.other' })` |
30
+ | `data-aos-anchor=".other"` | `timeline()` played when `.other` enters (or `<usa-timeline>` around it) |
31
31
 
32
32
  ## 3. Animation names
33
33
 
@@ -35,14 +35,14 @@ GSAP + ScrollTrigger is a full animation platform; `use-scroll-animate` covers t
35
35
  - tl.from('.title', { opacity: 0, y: 40 })
36
36
  - .from('.subtitle', { opacity: 0 }, '-=0.2')
37
37
  - .from('.cta', { scale: 0.8, opacity: 0 }, 1.2);
38
- + sequence([
39
- + { target: '.title', animation: 'fade-in-up' },
40
- + { target: '.subtitle', animation: 'fade-in', gap: -200 },
41
- + { target: '.cta', animation: 'zoom-in', at: 1200 },
42
- + ], { trigger: '.hero' });
38
+ + const tl = timeline()
39
+ + .to('.title', 'fade-up')
40
+ + .to('.subtitle', 'fade', { at: '-=200' })
41
+ + .to('.cta', 'scale', { at: 1200 });
42
+ + tl.scrub(document.querySelector('.hero')); // or tl.play() when it enters
43
43
  ```
44
44
 
45
- `play()` returns a Promise; `cancel()` stops it and leaves content visible.
45
+ `play()` / `reverse()` return Promises; `seek()`, `progress()`, labels and `scrub()` work like GSAP's timeline controls.
46
46
 
47
47
  ## Scrub (progress-linked) animations
48
48
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "use-scroll-animate",
3
- "version": "3.9.0",
3
+ "version": "4.0.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",
@@ -1 +0,0 @@
1
- {"version":3,"file":"index-tags-BmQR17Sb.js","sources":["../../src/components/index-tags.ts"],"sourcesContent":["// The component categories and their default tags (no imports: safe for lazy loaders).\n/** The component categories and their default tags. */\nexport const COMPONENT_CATEGORIES = {\n reveal: ['usa-reveal', 'usa-stagger', 'usa-scroll-progress', 'usa-scrolly'],\n text: ['usa-typewriter', 'usa-split-text', 'usa-scramble', 'usa-counter', 'usa-shimmer-text', 'usa-text-rotate', 'usa-wave-text', 'usa-glitch', 'usa-gradient-text', 'usa-handwriting', 'usa-scroll-highlight'],\n interaction: ['usa-ripple', 'usa-magnetic', 'usa-tilt', 'usa-spotlight', 'usa-press', 'usa-toggle'],\n feedback: ['usa-spinner', 'usa-skeleton', 'usa-progress', 'usa-toaster', 'usa-check'],\n background: ['usa-aurora', 'usa-particles', 'usa-grain', 'usa-marquee', 'usa-acrylic', 'usa-grid-glow', 'usa-blobs', 'usa-water-ripple', 'usa-dot-network'],\n transitions: ['usa-dialog', 'usa-accordion', 'usa-flip-list', 'usa-view-switch'],\n physics: ['usa-spring', 'usa-draggable', 'usa-overscroll'],\n cards: ['usa-card', 'usa-card-stack', 'usa-sticky-stack', 'usa-carousel-3d'],\n click: ['usa-click', 'usa-button', 'usa-icon-morph', 'usa-like', 'usa-hold', 'usa-double-tap', 'usa-checkbox'],\n ui: ['usa-tabs', 'usa-drawer', 'usa-bottom-sheet', 'usa-pull-refresh', 'usa-fab', 'usa-navbar', 'usa-slider', 'usa-rating', 'usa-tooltip', 'usa-popover', 'usa-badge', 'usa-avatar-stack'],\n page: ['usa-cursor', 'usa-fullpage', 'usa-loading-bar', 'usa-back-to-top', 'usa-ambient', 'usa-splash', 'usa-auto-skeleton', 'usa-motion-switch'],\n timeline: ['usa-timeline'],\n gesture: ['usa-swipeable', 'usa-pinch-zoom'],\n svg: ['usa-draw', 'usa-morph', 'usa-mask-reveal', 'usa-anim-icon'],\n webgl: ['usa-shader', 'usa-distort', 'usa-liquid'],\n depth: ['usa-cube', 'usa-depth'],\n layout: ['usa-auto-animate', 'usa-masonry'],\n packs: ['usa-pack'],\n} as const;\n\nexport type ComponentCategory = keyof typeof COMPONENT_CATEGORIES;\n"],"names":[],"mappings":"AAAA;AACA;AACO,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,aAAa,CAAC;IAC3E,IAAI,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,YAAY,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAsB,CAAC;AAC/M,IAAA,WAAW,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,CAAC;IACnG,QAAQ,EAAE,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,CAAC;AACrF,IAAA,UAAU,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;IAC3J,WAAW,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,iBAAiB,CAAC;AAChF,IAAA,OAAO,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,gBAAgB,CAAC;IAC1D,KAAK,EAAE,CAAC,UAAU,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;AAC5E,IAAA,KAAK,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,CAAC;IAC9G,EAAE,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,kBAAkB,CAAC;AAC1L,IAAA,IAAI,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;IACjJ,QAAQ,EAAE,CAAC,cAAc,CAAC;AAC1B,IAAA,OAAO,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC5C,GAAG,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,eAAe,CAAC;AAClE,IAAA,KAAK,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC;AAClD,IAAA,KAAK,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC;AAChC,IAAA,MAAM,EAAE,CAAC,kBAAkB,EAAE,aAAa,CAAC;IAC3C,KAAK,EAAE,CAAC,UAAU,CAAC;;;;;"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index-tags-DYYsgbba.cjs","sources":["../../src/components/index-tags.ts"],"sourcesContent":["// The component categories and their default tags (no imports: safe for lazy loaders).\n/** The component categories and their default tags. */\nexport const COMPONENT_CATEGORIES = {\n reveal: ['usa-reveal', 'usa-stagger', 'usa-scroll-progress', 'usa-scrolly'],\n text: ['usa-typewriter', 'usa-split-text', 'usa-scramble', 'usa-counter', 'usa-shimmer-text', 'usa-text-rotate', 'usa-wave-text', 'usa-glitch', 'usa-gradient-text', 'usa-handwriting', 'usa-scroll-highlight'],\n interaction: ['usa-ripple', 'usa-magnetic', 'usa-tilt', 'usa-spotlight', 'usa-press', 'usa-toggle'],\n feedback: ['usa-spinner', 'usa-skeleton', 'usa-progress', 'usa-toaster', 'usa-check'],\n background: ['usa-aurora', 'usa-particles', 'usa-grain', 'usa-marquee', 'usa-acrylic', 'usa-grid-glow', 'usa-blobs', 'usa-water-ripple', 'usa-dot-network'],\n transitions: ['usa-dialog', 'usa-accordion', 'usa-flip-list', 'usa-view-switch'],\n physics: ['usa-spring', 'usa-draggable', 'usa-overscroll'],\n cards: ['usa-card', 'usa-card-stack', 'usa-sticky-stack', 'usa-carousel-3d'],\n click: ['usa-click', 'usa-button', 'usa-icon-morph', 'usa-like', 'usa-hold', 'usa-double-tap', 'usa-checkbox'],\n ui: ['usa-tabs', 'usa-drawer', 'usa-bottom-sheet', 'usa-pull-refresh', 'usa-fab', 'usa-navbar', 'usa-slider', 'usa-rating', 'usa-tooltip', 'usa-popover', 'usa-badge', 'usa-avatar-stack'],\n page: ['usa-cursor', 'usa-fullpage', 'usa-loading-bar', 'usa-back-to-top', 'usa-ambient', 'usa-splash', 'usa-auto-skeleton', 'usa-motion-switch'],\n timeline: ['usa-timeline'],\n gesture: ['usa-swipeable', 'usa-pinch-zoom'],\n svg: ['usa-draw', 'usa-morph', 'usa-mask-reveal', 'usa-anim-icon'],\n webgl: ['usa-shader', 'usa-distort', 'usa-liquid'],\n depth: ['usa-cube', 'usa-depth'],\n layout: ['usa-auto-animate', 'usa-masonry'],\n packs: ['usa-pack'],\n} as const;\n\nexport type ComponentCategory = keyof typeof COMPONENT_CATEGORIES;\n"],"names":[],"mappings":";;AAAA;AACA;AACO,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,aAAa,CAAC;IAC3E,IAAI,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,YAAY,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAsB,CAAC;AAC/M,IAAA,WAAW,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,WAAW,EAAE,YAAY,CAAC;IACnG,QAAQ,EAAE,CAAC,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,CAAC;AACrF,IAAA,UAAU,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,WAAW,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;IAC3J,WAAW,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,iBAAiB,CAAC;AAChF,IAAA,OAAO,EAAE,CAAC,YAAY,EAAE,eAAe,EAAE,gBAAgB,CAAC;IAC1D,KAAK,EAAE,CAAC,UAAU,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,CAAC;AAC5E,IAAA,KAAK,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,CAAC;IAC9G,EAAE,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,kBAAkB,CAAC;AAC1L,IAAA,IAAI,EAAE,CAAC,YAAY,EAAE,cAAc,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,aAAa,EAAE,YAAY,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;IACjJ,QAAQ,EAAE,CAAC,cAAc,CAAC;AAC1B,IAAA,OAAO,EAAE,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC5C,GAAG,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,eAAe,CAAC;AAClE,IAAA,KAAK,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC;AAClD,IAAA,KAAK,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC;AAChC,IAAA,MAAM,EAAE,CAAC,kBAAkB,EAAE,aAAa,CAAC;IAC3C,KAAK,EAAE,CAAC,UAAU,CAAC;;;;;"}