@uibit/effect-trigger 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 UIBit Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,27 @@
+# Effect Trigger
+
+[Interactive Demonstration](https://rawlings.github.io/uibit/components/effect-trigger)
+
+Effect Trigger is an interactive animation wrapper that orchestrates visual reactions based on user inputs. By separating interactive triggers from animation assets, it allows product teams to add spatial transitions, particle bursts, and motion paths to standard controls, enhancing visual feedback and celebration states.
+
+## Value Delivery
+
+- **Polished Feedback** – Adds a layer of response to clicks, hovers, or success events, reinforcing user action completion.
+- **Dynamic Physics Paths** – Supports pre-configured movement profiles, including sweeps, bursts, orbits, and gravity-simulated drops, without needing to hand-code complex physics loops.
+- **Design Agility** – Decouples animations from control elements. Any standard markup, icon, or visual asset can serve as the animation payload.
+- **Seamless Integration** – Wraps standard interactive components such as buttons, form fields, and cards to trigger animations automatically.
+
+## Ideal Applications
+
+- **Reward Configurations** – Celebrating order completions, payment successes, or milestones.
+- **Interactive Button States** – Enhancing key calls-to-action with hover effects or custom visual bursts.
+- **Gamified Elements** – Providing visual rewards for quizzes, loyalty points, or feature discoveries.
+
+## Further Information
+
+Detailed design guidelines, customizable attributes, and integration examples are available on our documentation site.
+
+
+## Changelog
+
+Please see the [Changelog](CHANGELOG.md) for version history.

package/custom-elements.json

@@ -0,0 +1,588 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/effect-trigger.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Trigger visual effects like particles or vortex attractions.",
+          "name": "EffectTrigger",
+          "members": [
+            {
+              "kind": "field",
+              "name": "_customBehaviors",
+              "type": {
+                "text": "Map<string, BehaviorFn>"
+              },
+              "privacy": "private",
+              "static": true,
+              "default": "new Map()",
+              "description": "Registry of custom behaviors"
+            },
+            {
+              "kind": "method",
+              "name": "registerBehavior",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "fn",
+                  "type": {
+                    "text": "BehaviorFn"
+                  }
+                }
+              ],
+              "description": "Register a custom behavior that content authors can use by setting the behavior attribute."
+            },
+            {
+              "kind": "method",
+              "name": "getRegisteredBehaviors",
+              "static": true,
+              "return": {
+                "type": {
+                  "text": "Map<string, BehaviorFn>"
+                }
+              },
+              "description": "Get all registered custom behaviors."
+            },
+            {
+              "kind": "field",
+              "name": "trigger",
+              "type": {
+                "text": "EffectTriggerType"
+              },
+              "default": "'click'",
+              "description": "The trigger action to listen for",
+              "attribute": "trigger"
+            },
+            {
+              "kind": "field",
+              "name": "behavior",
+              "type": {
+                "text": "EffectBehaviorType"
+              },
+              "default": "'float-displace'",
+              "description": "The movement behavior/vector path to execute",
+              "attribute": "behavior"
+            },
+            {
+              "kind": "field",
+              "name": "density",
+              "type": {
+                "text": "number"
+              },
+              "default": "1",
+              "description": "Number of dynamic asset clones generated for particle-based behaviors",
+              "attribute": "density"
+            },
+            {
+              "kind": "field",
+              "name": "velocity",
+              "type": {
+                "text": "string"
+              },
+              "default": "'1s'",
+              "description": "Duration/velocity bound of the movement (e.g. \"600ms\", \"2.5s\")",
+              "attribute": "velocity"
+            },
+            {
+              "kind": "field",
+              "name": "randomize",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Applies real-time visual variations (scale, drift, rotation) to each clone",
+              "attribute": "randomize"
+            },
+            {
+              "kind": "field",
+              "name": "stagger",
+              "type": {
+                "text": "string"
+              },
+              "default": "'0ms'",
+              "description": "Stagger delay between spawning each particle (e.g., \"50ms\", \"0.1s\")",
+              "attribute": "stagger"
+            },
+            {
+              "kind": "field",
+              "name": "scaleRange",
+              "type": {
+                "text": "string"
+              },
+              "default": "'0.5,1.5'",
+              "description": "Min,Max range scale bounds for randomization (e.g., \"0.5,1.5\")",
+              "attribute": "scale-range"
+            },
+            {
+              "kind": "field",
+              "name": "rotationRange",
+              "type": {
+                "text": "string"
+              },
+              "default": "'-180,180'",
+              "description": "Min,Max range rotation degrees for randomization (e.g., \"-180,180\")",
+              "attribute": "rotation-range"
+            },
+            {
+              "kind": "field",
+              "name": "keyframes",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Custom keyframe definition in JSON string format to override behavior",
+              "attribute": "keyframes"
+            },
+            {
+              "kind": "field",
+              "name": "targetSelector",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "CSS selector of an external element to bind trigger events to",
+              "attribute": "target-selector"
+            },
+            {
+              "kind": "field",
+              "name": "destinationSelector",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "CSS selector of a destination element to animate particles towards",
+              "attribute": "destination-selector"
+            },
+            {
+              "kind": "field",
+              "name": "_viewport",
+              "type": {
+                "text": "ViewportController | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "_hasIntersections",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "_boundEventsCleanups",
+              "type": {
+                "text": "Array<() => void>"
+              },
+              "privacy": "private",
+              "default": "[]"
+            },
+            {
+              "kind": "method",
+              "name": "_cleanupObserver",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "_cleanupBoundEvents",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "_getTriggerElement",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_getAssetTemplate",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_setupListeners",
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "ignite",
+              "parameters": [
+                {
+                  "name": "event",
+                  "optional": true,
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ],
+              "description": "Launch/Ignite the visual effect. Can be called programmatically."
+            },
+            {
+              "kind": "method",
+              "name": "_spawnParticle",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "index",
+                  "type": {
+                    "text": "number"
+                  }
+                },
+                {
+                  "name": "triggerEl",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "assetEl",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "container",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "event",
+                  "optional": true,
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_getRandomFromRange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rangeStr",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_parseDuration",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "v",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_createClone",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "template",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_executeBakedBehavior",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "triggerEl",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "clone",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "container",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                },
+                {
+                  "name": "event",
+                  "optional": true,
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            }
+          ],
+          "events": [
+            {
+              "type": {
+                "text": "{ particle: HTMLElement, index: number, trigger: string }"
+              },
+              "description": "Fired when a particle is created",
+              "name": "uibit-particle-create"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "trigger",
+              "type": {
+                "text": "EffectTriggerType"
+              },
+              "default": "'click'",
+              "description": "The trigger action to listen for",
+              "fieldName": "trigger"
+            },
+            {
+              "name": "behavior",
+              "type": {
+                "text": "EffectBehaviorType"
+              },
+              "default": "'float-displace'",
+              "description": "The movement behavior/vector path to execute",
+              "fieldName": "behavior"
+            },
+            {
+              "name": "density",
+              "type": {
+                "text": "number"
+              },
+              "default": "1",
+              "description": "Number of dynamic asset clones generated for particle-based behaviors",
+              "fieldName": "density"
+            },
+            {
+              "name": "velocity",
+              "type": {
+                "text": "string"
+              },
+              "default": "'1s'",
+              "description": "Duration/velocity bound of the movement (e.g. \"600ms\", \"2.5s\")",
+              "fieldName": "velocity"
+            },
+            {
+              "name": "randomize",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Applies real-time visual variations (scale, drift, rotation) to each clone",
+              "fieldName": "randomize"
+            },
+            {
+              "name": "stagger",
+              "type": {
+                "text": "string"
+              },
+              "default": "'0ms'",
+              "description": "Stagger delay between spawning each particle (e.g., \"50ms\", \"0.1s\")",
+              "fieldName": "stagger"
+            },
+            {
+              "name": "scale-range",
+              "type": {
+                "text": "string"
+              },
+              "default": "'0.5,1.5'",
+              "description": "Min,Max range scale bounds for randomization (e.g., \"0.5,1.5\")",
+              "fieldName": "scaleRange"
+            },
+            {
+              "name": "rotation-range",
+              "type": {
+                "text": "string"
+              },
+              "default": "'-180,180'",
+              "description": "Min,Max range rotation degrees for randomization (e.g., \"-180,180\")",
+              "fieldName": "rotationRange"
+            },
+            {
+              "name": "keyframes",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Custom keyframe definition in JSON string format to override behavior",
+              "fieldName": "keyframes"
+            },
+            {
+              "name": "target-selector",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "CSS selector of an external element to bind trigger events to",
+              "fieldName": "targetSelector"
+            },
+            {
+              "name": "destination-selector",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "CSS selector of a destination element to animate particles towards",
+              "fieldName": "destinationSelector"
+            }
+          ],
+          "superclass": {
+            "name": "UIBitElement",
+            "package": "@uibit/core"
+          },
+          "tagName": "uibit-effect-trigger",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "EffectTrigger",
+          "declaration": {
+            "name": "EffectTrigger",
+            "module": "src/effect-trigger.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "uibit-effect-trigger",
+          "declaration": {
+            "name": "EffectTrigger",
+            "module": "src/effect-trigger.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "EffectTrigger",
+            "module": "src/effect-trigger.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "default",
+            "module": "./effect-trigger"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EffectTrigger",
+          "declaration": {
+            "name": "EffectTrigger",
+            "module": "./effect-trigger"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EffectTriggerType",
+          "declaration": {
+            "name": "EffectTriggerType",
+            "module": "./types"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EffectBehaviorType",
+          "declaration": {
+            "name": "EffectBehaviorType",
+            "module": "./types"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "BehaviorContext",
+          "declaration": {
+            "name": "BehaviorContext",
+            "module": "./types"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "BehaviorFn",
+          "declaration": {
+            "name": "BehaviorFn",
+            "module": "./types"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/styles.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "styles",
+          "default": "css` :host { display: inline-block; position: relative; } ::slotted([slot=\"trigger\"]) { display: inline-block; } /* Hide the template asset from standard layout */ slot[name=\"asset\"] { display: none !important; } `"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "styles",
+          "declaration": {
+            "name": "styles",
+            "module": "src/styles.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/types.ts",
+      "declarations": [],
+      "exports": []
+    }
+  ]
+}