@vysmo/text 0.1.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 (65) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +429 -0
  3. package/dist/animate.d.ts +28 -0
  4. package/dist/animate.d.ts.map +1 -0
  5. package/dist/animate.js +418 -0
  6. package/dist/animate.js.map +1 -0
  7. package/dist/index.d.ts +8 -0
  8. package/dist/index.d.ts.map +1 -0
  9. package/dist/index.js +6 -0
  10. package/dist/index.js.map +1 -0
  11. package/dist/presets/emphasis.d.ts +11 -0
  12. package/dist/presets/emphasis.d.ts.map +1 -0
  13. package/dist/presets/emphasis.js +54 -0
  14. package/dist/presets/emphasis.js.map +1 -0
  15. package/dist/presets/enter.d.ts +8 -0
  16. package/dist/presets/enter.d.ts.map +1 -0
  17. package/dist/presets/enter.js +58 -0
  18. package/dist/presets/enter.js.map +1 -0
  19. package/dist/presets/exit.d.ts +5 -0
  20. package/dist/presets/exit.d.ts.map +1 -0
  21. package/dist/presets/exit.js +30 -0
  22. package/dist/presets/exit.js.map +1 -0
  23. package/dist/presets/generated.d.ts +240 -0
  24. package/dist/presets/generated.d.ts.map +1 -0
  25. package/dist/presets/generated.js +3084 -0
  26. package/dist/presets/generated.js.map +1 -0
  27. package/dist/presets/index.d.ts +15 -0
  28. package/dist/presets/index.d.ts.map +1 -0
  29. package/dist/presets/index.js +43 -0
  30. package/dist/presets/index.js.map +1 -0
  31. package/dist/properties.d.ts +10 -0
  32. package/dist/properties.d.ts.map +1 -0
  33. package/dist/properties.js +80 -0
  34. package/dist/properties.js.map +1 -0
  35. package/dist/split.d.ts +21 -0
  36. package/dist/split.d.ts.map +1 -0
  37. package/dist/split.js +171 -0
  38. package/dist/split.js.map +1 -0
  39. package/dist/stagger.d.ts +13 -0
  40. package/dist/stagger.d.ts.map +1 -0
  41. package/dist/stagger.js +53 -0
  42. package/dist/stagger.js.map +1 -0
  43. package/dist/types.d.ts +204 -0
  44. package/dist/types.d.ts.map +1 -0
  45. package/dist/types.js +2 -0
  46. package/dist/types.js.map +1 -0
  47. package/package.json +56 -0
  48. package/src/__tests__/animate.test.ts +638 -0
  49. package/src/__tests__/presets.test.ts +87 -0
  50. package/src/__tests__/properties.test.ts +62 -0
  51. package/src/__tests__/split.test.ts +140 -0
  52. package/src/__tests__/ssr.test.ts +48 -0
  53. package/src/__tests__/stagger.test.ts +47 -0
  54. package/src/__tests__/types-check.ts +80 -0
  55. package/src/animate.ts +469 -0
  56. package/src/index.ts +38 -0
  57. package/src/presets/emphasis.ts +60 -0
  58. package/src/presets/enter.ts +64 -0
  59. package/src/presets/exit.ts +33 -0
  60. package/src/presets/generated.ts +3315 -0
  61. package/src/presets/index.ts +62 -0
  62. package/src/properties.ts +78 -0
  63. package/src/split.ts +180 -0
  64. package/src/stagger.ts +55 -0
  65. package/src/types.ts +245 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Maesto LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,429 @@
1
+ # @vysmo/text
2
+
3
+ Multi-property choreographed text animation. Grapheme-safe splitting via `Intl.Segmenter`; per-slice stagger / jitter / range; JSON-serializable preset format (string easings, normalized origins).
4
+
5
+ [Live preset browser + Studio](https://vysmo.com/text) · [Source](https://github.com/vysmodev)
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ pnpm add @vysmo/text
11
+ ```
12
+
13
+ ## Quick start
14
+
15
+ ### Use a preset
16
+
17
+ ```ts
18
+ import { animateText } from "@vysmo/text";
19
+
20
+ const el = document.querySelector<HTMLElement>(".headline")!;
21
+ const handle = animateText(el, { preset: "enter/fade-up" });
22
+ await handle.finished;
23
+ ```
24
+
25
+ ### Use a preset by import (better tree-shaking)
26
+
27
+ ```ts
28
+ import { animateText, fadeUp } from "@vysmo/text";
29
+
30
+ animateText(el, { preset: fadeUp });
31
+ ```
32
+
33
+ ### Choreograph from scratch
34
+
35
+ ```ts
36
+ import { animateText } from "@vysmo/text";
37
+
38
+ animateText(el, {
39
+ split: "character",
40
+ stagger: 30,
41
+ animations: [
42
+ { prop: "opacity", from: 0, to: 1, duration: 500, ease: "power2.out" },
43
+ { prop: "translateY", from: 20, to: 0, duration: 500, ease: "power2.out" },
44
+ ],
45
+ });
46
+ ```
47
+
48
+ `animateText` returns a handle: `.play() / .pause() / .stop() / .seek(0..1)` plus `.finished` (Promise).
49
+
50
+ ## Catalog
51
+
52
+ <!-- catalog:start -->
53
+
54
+ Every preset with its split mode, stagger, and the props it animates. Mirror of the catalog at [vysmo.com/text/docs#catalog](https://vysmo.com/text/docs#catalog) — generated from `listPresets()` so the README, the docs page, and the Studio share one source of truth.
55
+
56
+ ### Enter · 120
57
+
58
+ | Name | Split | Stagger | Animates |
59
+ |---|---|---|---|
60
+ | `enter/bloom-scatter` | character | 25ms | `opacity` · `translateZ` · `scale` · `blur` · `translateX` |
61
+ | `enter/blur-in` | word | 60ms | `opacity` · `blur` |
62
+ | `enter/blur-rise-snap` | character | 25ms | `opacity` · `blur` |
63
+ | `enter/compress-y-scatter` | character | 60ms | `opacity` · `scaleY` |
64
+ | `enter/depth-zoom` | character | 35ms | `opacity` · `translateZ` |
65
+ | `enter/drop-scatter-bounce-word` | word | 45ms | `opacity` · `skewX` · `blur` · `scaleY` · `translateY` |
66
+ | `enter/elastic-rise` | character | 40ms | `opacity` · `translateY` |
67
+ | `enter/expand-scatter` | character | 20ms | `opacity` · `translateX` · `scale` · `blur` |
68
+ | `enter/expand-scatter-loose` | character | 30ms | `opacity` · `translateX` · `scale` · `translateZ` · `translateY` |
69
+ | `enter/expand-scatter-trail` | character | 40ms | `opacity` · `translateY` · `scale` |
70
+ | `enter/expand-snap` | character | 35ms | `opacity` · `translateX` · `scale` |
71
+ | `enter/extend-x-curl` | character | 55ms | `opacity` · `scaleX` · `translateY` · `scaleY` · `skewX` |
72
+ | `enter/extend-x-snap` | word | 45ms | `opacity` · `scaleX` · `translateX` · `blur` |
73
+ | `enter/extend-x-snap-word` | word | 50ms | `opacity` · `scaleX` · `translateY` · `translateZ` |
74
+ | `enter/extend-y-curl` | character | 60ms | `opacity` · `scale` · `translateZ` · `scaleY` |
75
+ | `enter/extend-y-scatter` | character | 35ms | `opacity` · `translateX` · `scaleY` · `translateY` |
76
+ | `enter/extend-y-scatter-curl` | character | 45ms | `opacity` · `blur` · `translateY` · `scaleY` · `scale` |
77
+ | `enter/extend-y-scatter-word` | word | 40ms | `opacity` · `skewX` · `translateY` · `scaleY` |
78
+ | `enter/fade-up` | character | 30ms | `opacity` · `translateY` |
79
+ | `enter/flip-up-scatter-bounce` | character | 55ms | `opacity` · `rotateY` · `rotateX` |
80
+ | `enter/flip-up-scatter-curl` | character | 40ms | `opacity` · `scaleY` · `scale` · `translateX` · `rotateX` · `skewX` |
81
+ | `enter/flip-up-scatter-word` | word | 45ms | `opacity` · `rotateX` · `rotateY` · `skewX` · `blur` |
82
+ | `enter/flip-up-spring` | character | 50ms | `opacity` · `rotateY` · `rotateX` |
83
+ | `enter/flip-x` | character | 40ms | `opacity` · `rotateX` |
84
+ | `enter/fold-in-curl` | character | 60ms | `opacity` · `rotateX` · `skewX` · `blur` · `scaleY` · `scale` · `rotate` |
85
+ | `enter/fold-in-scatter-bounce` | character | 30ms | `opacity` · `scaleY` · `translateY` · `scale` · `skewX` · `rotateY` · `rotateX` |
86
+ | `enter/fold-in-scatter-curl` | character | 20ms | `opacity` · `translateZ` · `scaleY` · `rotateX` · `translateY` · `translateX` |
87
+ | `enter/fold-in-scatter-snap` | character | 55ms | `opacity` · `rotateX` · `scale` · `translateX` · `scaleY` · `rotate` |
88
+ | `enter/glide-outward` | character | 55ms | `opacity` · `translateX` · `skewX` |
89
+ | `enter/glide-scatter` | word | 35ms | `opacity` · `translateX` |
90
+ | `enter/grow-scatter` | character | 50ms | `opacity` · `blur` · `scale` · `skewX` · `translateX` |
91
+ | `enter/grow-spring` | character | 25ms | `opacity` · `scale` |
92
+ | `enter/haze-outward` | character | 50ms | `opacity` · `blur` |
93
+ | `enter/haze-scatter` | character | 20ms | `opacity` · `rotateY` · `blur` · `scaleY` |
94
+ | `enter/haze-scatter-2` | character | 55ms | `opacity` · `blur` · `translateX` · `scaleX` · `scaleY` |
95
+ | `enter/haze-scatter-3` | character | 60ms | `opacity` · `blur` · `scale` · `scaleY` |
96
+ | `enter/haze-scatter-spring` | character | 20ms | `opacity` · `translateY` · `blur` |
97
+ | `enter/haze-snap` | character | 60ms | `opacity` · `blur` · `translateZ` |
98
+ | `enter/lean-in-scatter-curl` | character | 20ms | `opacity` · `translateZ` · `rotate` |
99
+ | `enter/lean-in-scatter-spring` | character | 40ms | `opacity` · `scaleX` · `skewX` · `translateZ` · `rotate` · `translateY` |
100
+ | `enter/lean-in-spring` | character | 40ms | `opacity` · `translateZ` · `rotate` · `scaleX` |
101
+ | `enter/lean-scatter` | character | 45ms | `opacity` · `skewX` · `blur` |
102
+ | `enter/lift-spring` | character | 55ms | `opacity` · `translateY` |
103
+ | `enter/loom` | character | 50ms | `opacity` · `translateY` · `translateZ` |
104
+ | `enter/pinwheel-scatter` | character | 20ms | `opacity` · `blur` · `scaleY` · `skewX` · `translateX` · `rotate` |
105
+ | `enter/pivot-curl` | character | 55ms | `opacity` · `scaleY` · `rotateY` · `blur` · `translateY` |
106
+ | `enter/pivot-scatter` | character | 55ms | `opacity` · `rotateY` · `scale` · `translateZ` · `translateY` |
107
+ | `enter/pivot-scatter-2` | character | 40ms | `opacity` · `translateZ` · `rotate` · `scaleX` · `blur` · `translateY` |
108
+ | `enter/rise-y-scatter` | word | 40ms | `opacity` · `blur` · `skewX` · `scaleY` |
109
+ | `enter/rise-y-scatter-curl` | character | 25ms | `opacity` · `scale` · `scaleY` · `skewX` · `translateX` · `blur` |
110
+ | `enter/rise-y-scatter-loose` | character | 15ms | `opacity` · `scaleY` · `blur` · `skewX` · `scale` |
111
+ | `enter/rotate-y-in-deep` | character | 30ms | `opacity` · `rotate` · `rotateY` |
112
+ | `enter/rotate-y-in-inward` | character | 30ms | `opacity` · `blur` · `rotateY` |
113
+ | `enter/rotate-y-in-scatter-curl` | character | 60ms | `opacity` · `translateZ` · `rotateY` · `scale` · `scaleY` · `translateX` · `rotate` |
114
+ | `enter/rotate-y-in-scatter-spring` | character | 40ms | `opacity` · `rotate` · `rotateY` · `blur` · `translateZ` · `scaleX` |
115
+ | `enter/scale-in` | character | 35ms | `opacity` · `scale` |
116
+ | `enter/settle-scatter` | character | 35ms | `opacity` · `blur` · `translateY` · `scale` |
117
+ | `enter/slant-scatter` | character | 20ms | `opacity` · `blur` · `rotate` · `skewX` |
118
+ | `enter/slant-scatter-bounce` | character | 15ms | `opacity` · `translateX` · `blur` · `skewX` · `scaleY` · `rotateX` · `scaleX` |
119
+ | `enter/slant-scatter-spring` | character | 15ms | `opacity` · `translateY` · `rotate` · `translateX` · `blur` |
120
+ | `enter/slant-scatter-spring-word` | word | 15ms | `opacity` · `scaleX` · `translateZ` · `blur` · `skewX` |
121
+ | `enter/slant-scatter-word` | word | 20ms | `opacity` · `scale` · `translateX` · `skewX` · `blur` |
122
+ | `enter/slide-bounce` | character | 40ms | `opacity` · `translateX` |
123
+ | `enter/slide-scatter` | character | 50ms | `opacity` · `translateX` · `skewX` |
124
+ | `enter/soar-bounce` | word | 45ms | `opacity` · `translateY` |
125
+ | `enter/soar-swarm` | character | 55ms | `opacity` · `translateY` · `blur` |
126
+ | `enter/spin-scatter` | character | 40ms | `opacity` · `scaleY` · `rotateY` · `translateY` |
127
+ | `enter/spread-x-scatter-curl` | character | 50ms | `opacity` · `scaleY` · `scaleX` · `skewX` · `blur` |
128
+ | `enter/stretch-x-bounce` | character | 25ms | `opacity` · `scaleX` · `blur` · `translateX` |
129
+ | `enter/stretch-x-kick` | character | 50ms | `opacity` · `scaleX` · `translateY` |
130
+ | `enter/stretch-x-scatter` | character | 20ms | `opacity` · `scaleX` · `translateY` |
131
+ | `enter/stretch-y-scatter` | character | 60ms | `opacity` · `blur` · `translateX` · `scaleY` · `skewX` |
132
+ | `enter/swipe-scatter` | character | 20ms | `opacity` · `translateX` · `blur` |
133
+ | `enter/swipe-spring` | character | 55ms | `opacity` · `translateX` |
134
+ | `enter/swirl-loose` | word | 50ms | `opacity` · `rotate` · `translateX` |
135
+ | `enter/swirl-scatter` | character | 35ms | `opacity` · `scale` · `rotate` · `scaleY` |
136
+ | `enter/swivel-scatter-deep` | character | 55ms | `opacity` · `translateZ` · `scale` · `rotateY` · `scaleY` · `rotate` |
137
+ | `enter/swivel-scatter-inward` | character | 30ms | `opacity` · `translateY` · `rotateY` · `blur` · `translateZ` |
138
+ | `enter/swivel-scatter-loose` | character | 30ms | `opacity` · `rotate` · `rotateY` · `skewX` |
139
+ | `enter/tilt-in-bounce` | character | 60ms | `opacity` · `scaleY` · `rotate` |
140
+ | `enter/tilt-in-inward` | word | 55ms | `opacity` · `blur` · `rotate` |
141
+ | `enter/tilt-in-scatter` | character | 20ms | `opacity` · `rotate` · `blur` · `scale` |
142
+ | `enter/tilt-in-scatter-curl` | character | 60ms | `opacity` · `blur` · `translateX` · `scaleY` · `scale` · `scaleX` · `rotate` |
143
+ | `enter/tilt-in-scatter-word` | word | 40ms | `opacity` · `rotate` · `translateX` |
144
+ | `enter/tilt-in-spring` | word | 30ms | `opacity` · `rotate` |
145
+ | `enter/tip-in-scatter` | character | 45ms | `opacity` · `rotate` · `skewX` · `blur` |
146
+ | `enter/tip-in-scatter-curl` | character | 50ms | `opacity` · `blur` · `rotate` · `scaleY` · `scale` · `skewX` |
147
+ | `enter/tip-in-scatter-snap` | character | 20ms | `opacity` · `rotate` · `translateY` · `translateZ` · `skewX` |
148
+ | `enter/topple` | character | 50ms | `opacity` · `rotateX` |
149
+ | `enter/topple-scatter-kick` | character | 35ms | `opacity` · `translateY` · `rotateX` · `scaleY` · `rotate` · `scale` |
150
+ | `enter/topple-scatter-trail` | character | 20ms | `opacity` · `scale` · `rotate` · `rotateX` · `translateX` |
151
+ | `enter/topple-snap-loose-word` | word | 45ms | `opacity` · `scale` · `skewX` · `rotateX` · `blur` · `translateZ` |
152
+ | `enter/tumble-scatter` | character | 50ms | `opacity` · `scaleY` · `scale` · `translateY` · `rotateX` · `blur` |
153
+ | `enter/tumble-scatter-2` | character | 50ms | `opacity` · `blur` · `scale` · `translateZ` · `rotateX` |
154
+ | `enter/tumble-scatter-tunnel-word` | word | 50ms | `opacity` · `rotateX` · `skewX` · `blur` |
155
+ | `enter/tumble-x-loose` | word | 40ms | `opacity` · `blur` · `rotateX` · `translateY` · `translateZ` · `scaleX` |
156
+ | `enter/tumble-x-scatter-word` | word | 20ms | `opacity` · `translateY` · `translateX` · `rotateX` |
157
+ | `enter/tunnel` | word | 25ms | `opacity` · `translateZ` · `translateY` |
158
+ | `enter/turn-scatter-curl` | character | 55ms | `opacity` · `skewX` · `rotateY` · `translateY` · `rotate` · `blur` |
159
+ | `enter/turn-spring` | word | 25ms | `opacity` · `rotateY` · `translateY` |
160
+ | `enter/twirl-scatter` | character | 45ms | `opacity` · `scaleX` · `rotate` · `scale` |
161
+ | `enter/twirl-scatter-2` | character | 20ms | `opacity` · `scale` · `scaleY` · `rotate` · `rotateX` |
162
+ | `enter/twirl-scatter-3` | character | 60ms | `opacity` · `rotateY` · `rotate` · `scale` · `blur` · `skewX` |
163
+ | `enter/twirl-scatter-4` | character | 55ms | `opacity` · `rotate` · `translateY` · `blur` |
164
+ | `enter/twirl-scatter-curl` | character | 20ms | `opacity` · `blur` · `skewX` · `scaleX` · `scaleY` · `rotate` |
165
+ | `enter/unfurl-x-kick` | character | 20ms | `opacity` · `translateX` · `scaleX` |
166
+ | `enter/unfurl-x-scatter` | character | 25ms | `opacity` · `scale` · `translateX` · `scaleX` |
167
+ | `enter/unfurl-y-curl` | character | 40ms | `opacity` · `scaleY` · `scale` · `blur` |
168
+ | `enter/unfurl-y-scatter` | character | 35ms | `opacity` · `translateY` · `scaleY` |
169
+ | `enter/whirl-scatter` | character | 45ms | `opacity` · `translateX` · `blur` · `translateZ` · `scaleX` · `rotate` |
170
+ | `enter/whirl-scatter-2` | character | 15ms | `opacity` · `translateZ` · `rotate` |
171
+ | `enter/whirl-scatter-3` | character | 60ms | `opacity` · `rotateY` · `blur` · `rotate` |
172
+ | `enter/whirl-scatter-4` | character | 35ms | `opacity` · `rotateY` · `rotate` · `blur` |
173
+ | `enter/whirl-scatter-5` | character | 35ms | `opacity` · `rotateY` · `scaleY` · `blur` · `rotate` |
174
+ | `enter/whirl-scatter-6` | character | 15ms | `opacity` · `scale` · `rotate` · `rotateY` · `scaleX` |
175
+ | `enter/whirl-scatter-curl` | character | 35ms | `opacity` · `skewX` · `rotate` · `scale` · `translateY` |
176
+ | `enter/whirl-scatter-loose` | character | 55ms | `opacity` · `blur` · `translateZ` · `rotate` · `scaleX` · `scaleY` |
177
+ | `enter/whirl-scatter-snap` | character | 55ms | `opacity` · `scaleY` · `scaleX` · `translateX` · `rotate` |
178
+ | `enter/whirl-scatter-snap-tunnel` | character | 35ms | `opacity` · `translateY` · `scaleX` · `translateZ` · `translateX` · `rotate` |
179
+ | `enter/whirl-scatter-word` | word | 40ms | `opacity` · `blur` · `skewX` · `rotate` · `scaleY` |
180
+
181
+ ### Exit · 92
182
+
183
+ | Name | Split | Stagger | Animates |
184
+ |---|---|---|---|
185
+ | `exit/collapse-burst` | word | 30ms | `opacity` · `translateX` · `scale` · `translateY` |
186
+ | `exit/collapse-snap` | word | 55ms | `opacity` · `translateX` · `translateY` · `scale` |
187
+ | `exit/compress-x-burst` | character | 25ms | `opacity` · `scaleX` · `blur` · `scaleY` · `translateY` |
188
+ | `exit/compress-x-burst-curl` | character | 35ms | `opacity` · `scaleX` · `blur` · `translateZ` · `scaleY` |
189
+ | `exit/compress-x-burst-kick` | character | 50ms | `opacity` · `translateZ` · `translateY` · `blur` · `scaleX` |
190
+ | `exit/compress-x-burst-loose` | character | 35ms | `opacity` · `scaleY` · `translateZ` · `scale` · `scaleX` |
191
+ | `exit/compress-x-kick` | character | 30ms | `opacity` · `translateX` · `scaleY` · `scaleX` |
192
+ | `exit/compress-y-burst-curl` | character | 45ms | `opacity` · `skewX` · `translateX` · `scaleY` · `translateZ` |
193
+ | `exit/dissolve-kick` | character | 55ms | `opacity` · `blur` |
194
+ | `exit/exit-x-burst` | character | 45ms | `opacity` · `translateX` · `skewX` |
195
+ | `exit/fade-down` | character | 30ms | `opacity` · `translateY` |
196
+ | `exit/flatten-x-burst-deep` | character | 50ms | `opacity` · `blur` · `translateZ` · `scaleX` |
197
+ | `exit/flatten-x-burst-loose` | character | 15ms | `opacity` · `skewX` · `blur` · `scaleX` |
198
+ | `exit/flatten-x-curl` | character | 55ms | `opacity` · `skewX` · `translateZ` · `scaleX` · `translateX` |
199
+ | `exit/flatten-x-loose` | character | 25ms | `opacity` · `scaleX` · `translateY` |
200
+ | `exit/flatten-y` | word | 55ms | `opacity` · `scaleY` · `translateY` |
201
+ | `exit/flatten-y-burst` | character | 55ms | `opacity` · `translateZ` · `scaleY` · `skewX` · `translateX` |
202
+ | `exit/flatten-y-curl` | character | 55ms | `opacity` · `scaleY` · `translateX` |
203
+ | `exit/flip-away` | character | 35ms | `opacity` · `rotateY` |
204
+ | `exit/flip-out-burst` | character | 20ms | `opacity` · `scaleY` · `rotateX` · `rotate` · `scaleX` |
205
+ | `exit/flip-out-curl` | character | 40ms | `opacity` · `scaleY` · `rotateX` · `translateY` |
206
+ | `exit/flip-out-loose` | character | 55ms | `opacity` · `translateX` · `translateZ` · `rotateX` |
207
+ | `exit/fog-scatter` | character | 45ms | `opacity` · `blur` · `scaleX` · `rotate` · `translateX` |
208
+ | `exit/fog-scatter-2` | character | 20ms | `opacity` · `translateY` · `scaleY` · `blur` |
209
+ | `exit/fold-out-burst` | character | 45ms | `opacity` · `rotateX` · `rotateY` · `blur` · `skewX` |
210
+ | `exit/fold-out-burst-2` | character | 55ms | `opacity` · `translateY` · `translateX` · `rotateX` |
211
+ | `exit/fold-out-burst-curl` | character | 50ms | `opacity` · `rotateX` · `scale` · `translateX` · `scaleY` |
212
+ | `exit/fold-out-burst-loose` | character | 25ms | `opacity` · `translateX` · `rotate` · `scaleX` · `scale` · `rotateX` |
213
+ | `exit/implode-burst` | word | 55ms | `opacity` · `skewX` · `translateX` · `scale` · `translateZ` |
214
+ | `exit/lean-out-burst` | character | 55ms | `opacity` · `scale` · `translateZ` · `skewX` · `rotate` · `scaleY` · `scaleX` · `blur` |
215
+ | `exit/lean-out-burst-curl` | character | 20ms | `opacity` · `blur` · `rotate` · `scale` · `scaleY` · `translateZ` |
216
+ | `exit/lean-out-burst-swarm` | character | 20ms | `opacity` · `rotate` · `blur` |
217
+ | `exit/lean-out-burst-word` | word | 35ms | `opacity` · `scale` · `rotate` · `translateX` · `translateZ` · `translateY` |
218
+ | `exit/lean-out-snap` | character | 60ms | `opacity` · `rotate` |
219
+ | `exit/lift-out-burst` | character | 15ms | `opacity` · `blur` · `translateY` · `translateX` |
220
+ | `exit/mist-out` | character | 30ms | `opacity` · `blur` |
221
+ | `exit/pinwheel-out` | character | 35ms | `opacity` · `scaleX` · `rotate` · `blur` |
222
+ | `exit/pivot-out-burst` | character | 45ms | `opacity` · `translateX` · `rotateY` · `blur` · `rotate` |
223
+ | `exit/pivot-out-burst-loose` | character | 45ms | `opacity` · `rotateY` · `translateZ` |
224
+ | `exit/pivot-scatter-tunnel` | word | 45ms | `opacity` · `rotate` · `scaleX` · `translateZ` |
225
+ | `exit/rise-out-burst` | character | 60ms | `opacity` · `translateY` |
226
+ | `exit/rise-out-kick` | character | 50ms | `opacity` · `translateY` |
227
+ | `exit/rise-scatter` | word | 15ms | `opacity` · `translateY` · `rotateY` · `scale` |
228
+ | `exit/rise-scatter-2` | character | 50ms | `opacity` · `translateY` · `blur` · `scaleX` · `scaleY` · `rotateX` · `translateX` |
229
+ | `exit/scale-out` | character | 30ms | `opacity` · `scale` |
230
+ | `exit/shear-out-burst` | character | 35ms | `opacity` · `skewX` |
231
+ | `exit/slide-loose` | character | 55ms | `opacity` · `translateY` · `translateX` · `scale` · `scaleX` |
232
+ | `exit/slide-scatter` | character | 45ms | `opacity` · `rotate` · `skewX` · `scaleX` · `scaleY` · `blur` · `translateX` |
233
+ | `exit/slide-scatter-2` | character | 45ms | `opacity` · `translateY` · `scale` · `skewX` · `translateZ` · `translateX` |
234
+ | `exit/squash-x-burst` | character | 30ms | `opacity` · `skewX` · `scale` · `blur` · `scaleX` |
235
+ | `exit/squash-x-burst-curl` | character | 45ms | `opacity` · `skewX` · `scaleY` · `scaleX` |
236
+ | `exit/swipe-out-snap` | character | 45ms | `opacity` · `translateX` |
237
+ | `exit/swirl-out-burst` | character | 50ms | `opacity` · `scaleY` · `blur` · `skewX` · `translateY` · `scale` · `rotate` |
238
+ | `exit/swirl-out-curl` | character | 60ms | `opacity` · `rotate` · `scale` · `translateZ` |
239
+ | `exit/swivel-out` | word | 25ms | `opacity` · `rotateY` · `translateY` · `scaleX` |
240
+ | `exit/swivel-out-burst` | character | 45ms | `opacity` · `blur` · `translateX` · `rotate` · `rotateY` |
241
+ | `exit/swivel-out-burst-curl` | character | 60ms | `opacity` · `rotate` · `translateZ` · `scale` · `rotateY` |
242
+ | `exit/swivel-out-burst-loose` | character | 35ms | `opacity` · `scaleY` · `translateZ` · `translateX` · `rotateY` |
243
+ | `exit/swivel-out-burst-snap` | character | 40ms | `opacity` · `scaleY` · `translateZ` · `skewX` · `scale` · `translateX` · `rotate` · `rotateY` |
244
+ | `exit/swivel-out-curl` | character | 45ms | `opacity` · `rotateY` · `blur` |
245
+ | `exit/swivel-out-kick` | character | 40ms | `opacity` · `scale` · `rotateY` |
246
+ | `exit/swivel-out-loose` | character | 35ms | `opacity` · `scale` · `rotateY` · `translateZ` |
247
+ | `exit/tilt-out-burst` | word | 45ms | `opacity` · `rotate` · `scaleX` · `skewX` · `scale` · `translateX` · `translateZ` |
248
+ | `exit/tilt-out-burst-deep` | character | 45ms | `opacity` · `rotate` · `skewX` · `scaleY` · `translateZ` · `blur` |
249
+ | `exit/tilt-out-burst-kick` | character | 60ms | `opacity` · `blur` · `scale` · `rotate` · `scaleY` |
250
+ | `exit/tilt-out-burst-loose` | character | 30ms | `opacity` · `scale` · `scaleX` · `rotate` |
251
+ | `exit/tilt-out-burst-word` | word | 25ms | `opacity` · `rotate` · `skewX` · `blur` |
252
+ | `exit/tip-out-burst` | character | 35ms | `opacity` · `scale` · `rotate` · `scaleX` · `skewX` · `blur` · `scaleY` |
253
+ | `exit/tip-out-burst-curl` | character | 30ms | `opacity` · `rotate` · `translateZ` · `scaleX` |
254
+ | `exit/tip-out-burst-inward` | character | 60ms | `opacity` · `translateY` · `blur` · `rotate` · `scale` · `translateZ` |
255
+ | `exit/tip-out-burst-loose` | character | 50ms | `opacity` · `rotate` · `skewX` |
256
+ | `exit/topple` | character | 40ms | `opacity` · `scale` · `rotateX` |
257
+ | `exit/topple-out-burst` | character | 40ms | `opacity` · `rotateY` · `rotate` · `scale` · `rotateX` · `translateZ` |
258
+ | `exit/topple-out-burst-2` | character | 55ms | `opacity` · `scaleY` · `rotateX` · `translateY` · `translateZ` · `rotateY` |
259
+ | `exit/topple-out-burst-curl` | character | 35ms | `opacity` · `rotateX` · `scaleX` · `scale` · `translateX` |
260
+ | `exit/topple-out-burst-kick` | character | 30ms | `opacity` · `skewX` · `scale` · `rotateX` · `rotate` · `rotateY` · `translateZ` |
261
+ | `exit/topple-out-burst-snap` | character | 50ms | `opacity` · `blur` · `translateZ` · `rotate` · `translateY` · `rotateX` |
262
+ | `exit/turn-out-burst` | character | 30ms | `opacity` · `translateY` · `translateZ` · `rotateY` · `blur` |
263
+ | `exit/turn-out-burst-2` | character | 35ms | `opacity` · `rotate` · `rotateY` · `scaleX` · `translateZ` · `scaleY` |
264
+ | `exit/turn-out-burst-deep` | character | 35ms | `opacity` · `rotate` · `scaleX` · `translateZ` · `rotateY` · `skewX` |
265
+ | `exit/turn-out-burst-snap` | character | 60ms | `opacity` · `translateZ` · `rotateY` · `scaleY` · `rotate` |
266
+ | `exit/turn-out-burst-swarm` | character | 40ms | `opacity` · `scale` · `rotateY` · `translateZ` · `translateY` |
267
+ | `exit/turn-out-burst-trail` | character | 60ms | `opacity` · `rotateY` · `scale` · `scaleY` · `translateZ` · `translateY` · `translateX` |
268
+ | `exit/twirl` | character | 45ms | `opacity` · `rotate` · `scale` |
269
+ | `exit/twirl-2` | character | 40ms | `opacity` · `scaleY` · `scaleX` · `rotate` |
270
+ | `exit/twirl-loose` | character | 45ms | `opacity` · `rotate` · `scale` · `rotateY` |
271
+ | `exit/twirl-out-burst` | character | 20ms | `opacity` · `skewX` · `scaleY` · `rotate` |
272
+ | `exit/twirl-out-burst-loose` | character | 55ms | `opacity` · `scaleY` · `rotate` · `translateZ` · `skewX` · `translateX` |
273
+ | `exit/twirl-scatter-tunnel` | character | 45ms | `opacity` · `rotate` · `translateZ` · `scale` |
274
+ | `exit/whirl-scatter` | character | 45ms | `opacity` · `scaleX` · `rotate` · `translateY` · `blur` |
275
+ | `exit/whirl-scatter-tunnel` | character | 50ms | `opacity` · `rotateY` · `translateZ` · `rotate` · `blur` · `skewX` |
276
+ | `exit/whirl-scatter-tunnel-2` | character | 35ms | `opacity` · `translateZ` · `rotate` · `scale` · `skewX` |
277
+
278
+ ### Emphasis · 31
279
+
280
+ | Name | Split | Stagger | Animates |
281
+ |---|---|---|---|
282
+ | `emphasis/bob` | character | 50ms | `translateY` |
283
+ | `emphasis/carousel-inward` | character | 20ms | `rotate` |
284
+ | `emphasis/coin-flip` | character | 30ms | `rotateY` |
285
+ | `emphasis/fold-tap-curl` | word | 60ms | `rotateX` |
286
+ | `emphasis/jolt-y-trail` | character | 15ms | `translateY` |
287
+ | `emphasis/jolt-y-trail-2` | character | 55ms | `translateY` |
288
+ | `emphasis/lean-loose` | character | 55ms | `rotate` |
289
+ | `emphasis/pinwheel-curl` | word | 30ms | `rotate` |
290
+ | `emphasis/pivot` | character | 50ms | `rotate` |
291
+ | `emphasis/pivot-2` | word | 40ms | `rotate` |
292
+ | `emphasis/pivot-3` | character | 50ms | `rotate` |
293
+ | `emphasis/pivot-bounce` | character | 50ms | `rotate` |
294
+ | `emphasis/pivot-snap` | character | 30ms | `rotate` |
295
+ | `emphasis/pulse` | character | 20ms | `scale` |
296
+ | `emphasis/pump-trail` | character | 25ms | `scale` |
297
+ | `emphasis/rock-inward` | word | 25ms | `rotate` |
298
+ | `emphasis/shake` | character | 15ms | `translateX` |
299
+ | `emphasis/spin` | character | 20ms | `rotate` |
300
+ | `emphasis/sway-curl` | character | 50ms | `rotate` |
301
+ | `emphasis/swivel-curl` | character | 50ms | `rotateY` |
302
+ | `emphasis/swivel-snap-depth` | character | 20ms | `rotateY` |
303
+ | `emphasis/tap-x-loose` | character | 30ms | `translateX` |
304
+ | `emphasis/tip-curl` | character | 35ms | `rotateX` |
305
+ | `emphasis/tip-deep` | character | 40ms | `rotateX` |
306
+ | `emphasis/turn-deep` | character | 15ms | `rotateY` |
307
+ | `emphasis/twirl-curl` | character | 50ms | `rotate` |
308
+ | `emphasis/twirl-curl-inward` | character | 30ms | `rotate` |
309
+ | `emphasis/whirl-loose` | character | 20ms | `rotate` |
310
+ | `emphasis/whirl-loose-2` | character | 45ms | `rotate` |
311
+ | `emphasis/wiggle-outward` | character | 30ms | `translateX` |
312
+ | `emphasis/wobble` | character | 25ms | `rotate` |
313
+
314
+ <!-- catalog:end -->
315
+
316
+ `listPresets()` enumerates everything; `resolvePreset(name)` looks one up by name.
317
+
318
+ ## Preset shape
319
+
320
+ ```ts
321
+ // @no-check
322
+ type Preset = {
323
+ name: string; // "enter/fade-up"
324
+ split?: "character" | "word" | "line";
325
+ stagger: number; // ms between slices
326
+ staggerOrder?: "start" | "end" | "center" | "edges" | "random";
327
+ perspective?: number; // px, applied to the container for 3D
328
+ transformOrigin?: { x: number; y: number; z?: number }; // normalized
329
+ animations: TextAnimationSpec[];
330
+ repeat?: number | "infinite";
331
+ repeatDelay?: number;
332
+ };
333
+
334
+ type TextAnimationSpec = {
335
+ prop: TextProperty; // opacity, translateX/Y/Z, rotateX/Y/Z, scale, scaleX/Y, skewX/Y, blur, brightness, …
336
+ from: number | { min: number; max: number };
337
+ to: number | { min: number; max: number };
338
+ duration?: number;
339
+ delay?: number;
340
+ ease?: string | EasingFn; // GSAP-style "power2.out", or any (t: number) => number
341
+ stagger?: number;
342
+ staggerOrder?: StaggerOrder;
343
+ jitterDelay?: number; // per-slice random delay in [0, jitterDelay]
344
+ transformOrigin?: { x: number; y: number; z?: number };
345
+ perspective?: number;
346
+ };
347
+ ```
348
+
349
+ Every field is JSON-serializable (no function references, no CSS strings) — presets travel cleanly through localStorage, network, and AI agent output.
350
+
351
+ ## Splitting
352
+
353
+ ```ts
354
+ import { splitText } from "@vysmo/text";
355
+
356
+ const splits = splitText(el, { mode: "character" }); // or "word" | "line"
357
+ splits.slices; // HTMLElement[] in document order
358
+ splits.restore(); // put the original textContent back
359
+ ```
360
+
361
+ Splitting is grapheme-safe via `Intl.Segmenter` — emoji ZWJ sequences, accented characters, and most scripts behave correctly. Note: connected / contextually-shaped scripts (Arabic, Devanagari, Lao, Khmer, …) break in `character` mode because each grapheme lands in its own inline-block box; use `word` or `line` for those scripts.
362
+
363
+ ## Range values
364
+
365
+ ```ts
366
+ animateText(el, {
367
+ animations: [
368
+ { prop: "translateY", from: { min: -30, max: 30 }, to: 0, duration: 600 },
369
+ ],
370
+ });
371
+ ```
372
+
373
+ `{ min, max }` resolves **per slice** at animate-start: every slice samples its own value. That's how presets like "letters scatter from random offsets" become a one-line spec change.
374
+
375
+ ## Stagger
376
+
377
+ ```ts
378
+ animateText(el, {
379
+ stagger: 30, // ms between slices
380
+ staggerOrder: "edges", // start | end | center | edges | random
381
+ });
382
+ ```
383
+
384
+ Per-spec overrides: `{ stagger, staggerOrder }` on any animation entry overrides the root values for that spec only. Pair with `jitterDelay` to break the metronome feel.
385
+
386
+ ## Repeat & emphasis
387
+
388
+ ```ts
389
+ animateText(el, { preset: "emphasis/pulse" }); // repeats per the preset
390
+ animateText(el, { ...spec, repeat: 3, repeatDelay: 200 }); // override
391
+ animateText(el, { ...spec, repeat: "infinite" });
392
+ ```
393
+
394
+ ## Reduced motion
395
+
396
+ ```ts
397
+ animateText(el, { ...spec, respectReducedMotion: true }); // default true — no-op when prefers-reduced-motion is set
398
+ ```
399
+
400
+ ## Deterministic playback
401
+
402
+ ```ts
403
+ import { animateText } from "@vysmo/text";
404
+ import { createTestScheduler } from "@vysmo/animations";
405
+
406
+ const sched = createTestScheduler();
407
+ const handle = animateText(el, { ...spec, scheduler: sched });
408
+ sched.tick(0);
409
+ sched.tick(500); // … etc
410
+ ```
411
+
412
+ Per-slice ranges use a deterministic RNG — pass `{ rng: () => 0.5 }` to fix sample values for snapshots.
413
+
414
+ ## Defining your own preset
415
+
416
+ Any object matching the `Preset` shape works as `{ preset: yourPreset }`. There's no registration step — presets are pure data.
417
+
418
+ For bulk authoring, the [Studio](https://vysmo.com/text/studio) generates random combos against the full easings pool; export to `_staging.ts`, run `pnpm --filter @vysmo/text ingest`.
419
+
420
+ ## Characteristics
421
+
422
+ - **DOM-only.** Renders into the DOM via the standard split + animate flow; the preset shape is plain JSON, so any consumer that interprets `TextAnimationSpec` can drive it.
423
+ - **SSR-safe at module load.** `splitText` throws a readable error if called without a DOM; the module imports cleanly in Node (preset data is reachable; `evaluateSpecs` runs pure-math without DOM).
424
+ - **Zero runtime dependencies** except `@vysmo/animations` and `@vysmo/easings` (both transitive).
425
+ - **Bundle size:** ~26 KB gzipped — dominated by the preset catalog. The runtime is ~3 KB; the rest is data. Tree-shaking the catalog is currently blocked because `animateText` imports `resolvePreset` unconditionally so callers can pass `preset: "name"`.
426
+
427
+ ## License
428
+
429
+ MIT.
@@ -0,0 +1,28 @@
1
+ import { type PropValues } from "./properties.js";
2
+ import type { AnimateTextHandle, AnimateTextOptions, TextAnimationSpec } from "./types.js";
3
+ /**
4
+ * Pure, time-point evaluation of a spec array against a single per-slice
5
+ * clock. Useful for tests and headless rendering. The live animateText
6
+ * renderer subtracts the per-spec stagger offset *before* calling the
7
+ * equivalent of this function, so pass the already-offset slice time.
8
+ *
9
+ * Range `from` / `to` values resolve deterministically to their midpoint
10
+ * here — the live runtime samples per slice via the rng option, but
11
+ * `evaluateSpecs` has no slice context, so it returns the spread's
12
+ * average. Tests that exercise per-slice scatter should drive the live
13
+ * renderer instead.
14
+ */
15
+ export declare function evaluateSpecs(specs: TextAnimationSpec[], t: number): PropValues;
16
+ /**
17
+ * Animate an element's text with per-slice, per-property choreography.
18
+ *
19
+ * Each spec is an independent timeline — its own `duration`, `delay`,
20
+ * `ease`, `stagger`, and `staggerOrder`. Specs run on a single master
21
+ * clock so one rAF tick produces one DOM write per slice, and same-prop
22
+ * specs chain via `delay` (later wins once its window opens).
23
+ *
24
+ * For 3D transforms (rotateX/Y, translateZ) set `perspective` so children
25
+ * render with depth.
26
+ */
27
+ export declare function animateText(element: HTMLElement, options?: AnimateTextOptions): AnimateTextHandle;
28
+ //# sourceMappingURL=animate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"animate.d.ts","sourceRoot":"","sources":["../src/animate.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0B,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAI1E,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAElB,iBAAiB,EAGlB,MAAM,YAAY,CAAC;AAgDpB;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU,CAa/E;AA+ID;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,WAAW,EACpB,OAAO,GAAE,kBAAuB,GAC/B,iBAAiB,CAiOnB"}