@rive-app/webgl-single 2.3.1 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/webgl-single",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Rive's webgl based web api with bundled wasm.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -95,6 +95,10 @@ export declare class StateMachineInput {
      */
     fire(): void;
 }
+export declare enum RiveEventType {
+    General = 128,
+    OpenUrl = 131
+}
 /**
  * Supported event types triggered in Rive
  */
@@ -107,11 +111,13 @@ export declare enum EventType {
     Loop = "loop",
     Draw = "draw",
     Advance = "advance",
-    StateChange = "statechange"
+    StateChange = "statechange",
+    RiveEvent = "riveevent"
 }
+export type RiveEventPayload = rc.RiveEvent | rc.OpenUrlEvent;
 export interface Event {
     type: EventType;
-    data?: string | string[] | LoopEvent | number;
+    data?: string | string[] | LoopEvent | number | RiveEventPayload;
 }
 /**
  * Looping types: one-shot, loop, and ping-pong
@@ -189,6 +195,18 @@ export interface RiveParameters {
      * will be attached to the <canvas> element
      */
     shouldDisableRiveListeners?: boolean;
+    /**
+     * Enable Rive Events to be handled by the runtime. This means any special Rive Event may have
+     * a side effect that takes place implicitly.
+     *
+     * For example, if during the render loop an OpenUrlEvent is detected, the
+     * browser may try to open the specified URL in the payload.
+     *
+     * This flag is false by default to prevent any unwanted behaviors from taking place.
+     * This means any special Rive Event will have to be handled manually by subscribing to
+     * EventType.RiveEvent
+     */
+    automaticallyHandleEvents?: boolean;
     onLoad?: EventCallback;
     onLoadError?: EventCallback;
     onPlay?: EventCallback;
@@ -266,6 +284,7 @@ export declare class Rive {
     private animator;
     private static readonly missingErrorMessage;
     private shouldDisableRiveListeners;
+    private automaticallyHandleEvents;
     durations: number[];
     frameTimes: number[];
     frameCount: number;