@wix/interact 2.1.3 → 2.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 (84) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/cjs/react.js +1 -1
  3. package/dist/cjs/web.js +1 -1
  4. package/dist/cjs/web.js.map +1 -1
  5. package/dist/es/index.js +1 -1
  6. package/dist/es/react.js +2 -2
  7. package/dist/es/web.js +15 -15
  8. package/dist/es/web.js.map +1 -1
  9. package/dist/index-ByLXasWO.mjs +2832 -0
  10. package/dist/index-ByLXasWO.mjs.map +1 -0
  11. package/dist/index-CzRuJxn8.js +18 -0
  12. package/dist/index-CzRuJxn8.js.map +1 -0
  13. package/dist/tsconfig.build.tsbuildinfo +1 -1
  14. package/dist/types/core/Interact.d.ts +2 -2
  15. package/dist/types/core/InteractionController.d.ts +2 -2
  16. package/dist/types/core/InteractionController.d.ts.map +1 -1
  17. package/dist/types/core/add.d.ts.map +1 -1
  18. package/dist/types/core/css.d.ts.map +1 -1
  19. package/dist/types/handlers/effectHandlers.d.ts +4 -4
  20. package/dist/types/handlers/effectHandlers.d.ts.map +1 -1
  21. package/dist/types/handlers/eventTrigger.d.ts +2 -2
  22. package/dist/types/handlers/eventTrigger.d.ts.map +1 -1
  23. package/dist/types/handlers/index.d.ts.map +1 -1
  24. package/dist/types/handlers/viewEnter.d.ts.map +1 -1
  25. package/dist/types/index.d.ts +1 -1
  26. package/dist/types/index.d.ts.map +1 -1
  27. package/dist/types/react/index.d.ts +1 -1
  28. package/dist/types/react/index.d.ts.map +1 -1
  29. package/dist/types/types/config.d.ts +47 -0
  30. package/dist/types/types/config.d.ts.map +1 -0
  31. package/dist/types/types/controller.d.ts +34 -0
  32. package/dist/types/types/controller.d.ts.map +1 -0
  33. package/dist/types/types/effects.d.ts +75 -0
  34. package/dist/types/types/effects.d.ts.map +1 -0
  35. package/dist/types/types/external.d.ts +6 -0
  36. package/dist/types/types/external.d.ts.map +1 -0
  37. package/dist/types/types/global.d.ts +11 -0
  38. package/dist/types/types/global.d.ts.map +1 -0
  39. package/dist/types/types/handlers.d.ts +41 -0
  40. package/dist/types/types/handlers.d.ts.map +1 -0
  41. package/dist/types/types/index.d.ts +8 -0
  42. package/dist/types/types/index.d.ts.map +1 -0
  43. package/dist/types/types/internal.d.ts +36 -0
  44. package/dist/types/types/internal.d.ts.map +1 -0
  45. package/dist/types/types/triggers.d.ts +28 -0
  46. package/dist/types/types/triggers.d.ts.map +1 -0
  47. package/dist/types/web/InteractElement.d.ts +2 -2
  48. package/dist/types/web/InteractElement.d.ts.map +1 -1
  49. package/dist/types/web/index.d.ts +1 -1
  50. package/dist/types/web/index.d.ts.map +1 -1
  51. package/docs/api/README.md +2 -3
  52. package/docs/api/functions.md +4 -4
  53. package/docs/api/interact-class.md +2 -3
  54. package/docs/api/interact-element.md +2 -2
  55. package/docs/api/interaction-controller.md +4 -4
  56. package/docs/api/types.md +38 -69
  57. package/docs/examples/README.md +1 -1
  58. package/docs/examples/click-interactions.md +0 -7
  59. package/docs/examples/entrance-animations.md +28 -27
  60. package/docs/examples/list-patterns.md +17 -16
  61. package/docs/guides/conditions-and-media-queries.md +2 -3
  62. package/docs/guides/configuration-structure.md +5 -7
  63. package/docs/guides/effects-and-animations.md +2 -4
  64. package/docs/guides/getting-started.md +0 -1
  65. package/docs/guides/lists-and-dynamic-content.md +10 -9
  66. package/docs/guides/sequences.md +3 -4
  67. package/docs/guides/state-management.md +0 -2
  68. package/docs/guides/understanding-triggers.md +9 -13
  69. package/package.json +2 -2
  70. package/rules/click.md +96 -560
  71. package/rules/full-lean.md +536 -360
  72. package/rules/hover.md +107 -530
  73. package/rules/integration.md +212 -261
  74. package/rules/pointermove.md +154 -1407
  75. package/rules/viewenter.md +128 -863
  76. package/rules/viewprogress.md +88 -322
  77. package/dist/index-BtEG0cjF.mjs +0 -2791
  78. package/dist/index-BtEG0cjF.mjs.map +0 -1
  79. package/dist/index-ErMKtmX2.js +0 -18
  80. package/dist/index-ErMKtmX2.js.map +0 -1
  81. package/dist/types/types.d.ts +0 -256
  82. package/dist/types/types.d.ts.map +0 -1
  83. package/rules/MASTER-CLEANUP-PLAN.md +0 -286
  84. package/rules/scroll-list.md +0 -748
@@ -45,9 +45,6 @@ The `hover` trigger responds to mouse enter and leave events.
45
45
  {
46
46
  key: 'my-card',
47
47
  trigger: 'hover',
48
- params: {
49
- type: 'alternate'
50
- },
51
48
  effects: [
52
49
  {
53
50
  keyframeEffect: {
@@ -66,6 +63,8 @@ The `hover` trigger responds to mouse enter and leave events.
66
63
 
67
64
  ### Hover Behavior Types
68
65
 
66
+ Set `triggerType` on each time-based effect (defaults shown below):
67
+
69
68
  - **`alternate`** (default): Plays forward on enter, reverses on leave
70
69
  - **`repeat`**: Restarts animation each time
71
70
  - **`once`**: Only plays once, then stops
@@ -77,7 +76,6 @@ The `hover` trigger responds to mouse enter and leave events.
77
76
  {
78
77
  key: 'image-card',
79
78
  trigger: 'hover',
80
- params: { type: 'alternate' },
81
79
  effects: [
82
80
  {
83
81
  key: 'image-overlay',
@@ -127,9 +125,6 @@ The `click` trigger responds to mouse click events and supports multiple behavio
127
125
  {
128
126
  key: 'accordion-header',
129
127
  trigger: 'click',
130
- params: {
131
- type: 'alternate'
132
- },
133
128
  effects: [
134
129
  {
135
130
  key: 'accordion-content',
@@ -151,13 +146,14 @@ The `click` trigger responds to mouse click events and supports multiple behavio
151
146
  - **`once`**: Only responds to the first click
152
147
  - **`state`**: First click plays, subsequent clicks pause/resume
153
148
 
149
+ Configure these via `triggerType` on each time-based effect.
150
+
154
151
  ### Real-World Example: Menu Toggle
155
152
 
156
153
  ```typescript
157
154
  {
158
155
  key: 'menu-button',
159
156
  trigger: 'click',
160
- params: { type: 'alternate' },
161
157
  effects: [
162
158
  {
163
159
  key: 'menu-icon',
@@ -276,7 +272,6 @@ The `viewEnter` trigger uses Intersection Observer to detect when elements enter
276
272
  key: 'hero-image',
277
273
  trigger: 'viewEnter',
278
274
  params: {
279
- type: 'once', // 'once' | 'repeat' | 'alternate'
280
275
  threshold: 0.5, // 0-1, how much of element must be visible
281
276
  inset: '-50px' // Margin around viewport
282
277
  },
@@ -299,7 +294,9 @@ The `viewEnter` trigger uses Intersection Observer to detect when elements enter
299
294
 
300
295
  ### ViewEnter Behavior Types
301
296
 
302
- - **`once`** (recommended): Triggers only when element first enters viewport
297
+ Set `triggerType` on each time-based effect (defaults shown below). `params` only holds Intersection Observer options (`threshold`, `inset`, etc.).
298
+
299
+ - **`once`** (default, recommended): Triggers only when element first enters viewport
303
300
  - **`repeat`**: Triggers every time element enters viewport
304
301
  - **`alternate`**: Plays forward on enter, reverses on exit
305
302
  - **`state`**: Plays on enter, pauses on exit
@@ -312,7 +309,7 @@ const cardAnimations = [
312
309
  {
313
310
  key: 'card-1',
314
311
  trigger: 'viewEnter',
315
- params: { type: 'once', threshold: 0.3 },
312
+ params: { threshold: 0.3 },
316
313
  effects: [
317
314
  {
318
315
  key: 'card-1',
@@ -332,7 +329,7 @@ const cardAnimations = [
332
329
  {
333
330
  key: 'card-2',
334
331
  trigger: 'viewEnter',
335
- params: { type: 'once', threshold: 0.3 },
332
+ params: { threshold: 0.3 },
336
333
  effects: [
337
334
  {
338
335
  key: 'card-2',
@@ -618,7 +615,6 @@ You can combine multiple triggers on the same element for complex interactions:
618
615
  {
619
616
  key: 'interactive-card',
620
617
  trigger: 'viewEnter',
621
- params: { type: 'once' },
622
618
  effects: [
623
619
  {
624
620
  key: 'interactive-card',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/interact",
3
- "version": "2.1.3",
3
+ "version": "2.2.0",
4
4
  "description": "A powerful, declarative interaction library for creating engaging web apps.",
5
5
  "license": "MIT",
6
6
  "main": "dist/cjs/index.js",
@@ -56,7 +56,7 @@
56
56
  "url": "https://github.com/wix/interact/issues"
57
57
  },
58
58
  "dependencies": {
59
- "@wix/motion": "^2.1.2",
59
+ "@wix/motion": "^2.1.4",
60
60
  "fastdom": "^1.0.12",
61
61
  "fizban": "^0.7.2",
62
62
  "kuliso": "^0.4.13"