@rive-app/canvas-lite 2.12.1 → 2.12.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/canvas-lite",
-  "version": "2.12.1",
+  "version": "2.12.2",
   "description": "A lite version of Rive's canvas based web api.",
   "main": "rive.js",
   "homepage": "https://rive.app",

package/rive.d.ts

@@ -5,6 +5,9 @@ export type { FileAsset, FontAsset, ImageAsset } from './rive_advanced.mjs';
  */
 export type VoidCallback = () => void;
 export type AssetLoadCallback = (asset: rc.FileAsset, bytes: Uint8Array) => Boolean;
+interface SetupRiveListenersOptions {
+    isTouchScrollEnabled?: boolean;
+}
 /**
  * Type for artboard bounds
  */
@@ -202,6 +205,12 @@ export interface RiveParameters {
      * will be attached to the <canvas> element
      */
     shouldDisableRiveListeners?: boolean;
+    /**
+     * For Rive Listeners, allows scrolling behavior to still occur on canvas elements
+     * when a touch/drag action is performed on touch-enabled devices. Otherwise,
+     * scroll behavior may be prevented on touch/drag actions on the canvas by default.
+     */
+    isTouchScrollEnabled?: 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.
@@ -298,10 +307,21 @@ export declare class Rive {
     durations: number[];
     frameTimes: number[];
     frameCount: number;
+    isTouchScrollEnabled: boolean;
     constructor(params: RiveParameters);
     static new(params: RiveParameters): Rive;
     private init;
-    private setupRiveListeners;
+    /**
+     * Setup Rive Listeners on the canvas
+     * @param riveListenerOptions - Enables TouchEvent events on the canvas. Set to true to allow
+     * touch scrolling on the canvas element on touch-enabled devices
+     * i.e. { isTouchScrollEnabled: true }
+     */
+    setupRiveListeners(riveListenerOptions?: SetupRiveListenersOptions): void;
+    /**
+     * Remove Rive Listeners setup on the canvas
+     */
+    removeRiveListeners(): void;
     private initData;
     private initArtboard;
     drawFrame(): void;

package/rive.js

@@ -2252,7 +2252,7 @@ Pc();
 /* 2 */
 /***/ ((module) => {
 
-module.exports = JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.12.1","description":"A lite version of Rive\'s canvas based web api.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
+module.exports = JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.12.2","description":"A lite version of Rive\'s canvas based web api.","main":"rive.js","homepage":"https://rive.app","repository":{"type":"git","url":"https://github.com/rive-app/rive-wasm/tree/master/js"},"keywords":["rive","animation"],"author":"Rive","contributors":["Luigi Rosso <luigi@rive.app> (https://rive.app)","Maxwell Talbot <max@rive.app> (https://rive.app)","Arthur Vivian <arthur@rive.app> (https://rive.app)","Umberto Sonnino <umberto@rive.app> (https://rive.app)","Matthew Sullivan <matt.j.sullivan@gmail.com> (mailto:matt.j.sullivan@gmail.com)"],"license":"MIT","files":["rive.js","rive.js.map","rive.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
 
 /***/ }),
 /* 3 */
@@ -2286,11 +2286,15 @@ var _this = undefined;
  * @param event - Either a TouchEvent or a MouseEvent
  * @returns - Coordinates of the clientX and clientY properties from the touch/mouse event
  */
-var getClientCoordinates = function (event) {
+var getClientCoordinates = function (event, isTouchScrollEnabled) {
     var _a, _b;
     if (["touchstart", "touchmove"].indexOf(event.type) > -1 &&
         ((_a = event.touches) === null || _a === void 0 ? void 0 : _a.length)) {
-        event.preventDefault();
+        // This flag, if false, prevents touch events on the canvas default behavior
+        // which may prevent scrolling if a drag motion on the canvas is performed
+        if (!isTouchScrollEnabled) {
+            event.preventDefault();
+        }
         return {
             clientX: event.touches[0].clientX,
             clientY: event.touches[0].clientY,
@@ -2315,7 +2319,7 @@ var getClientCoordinates = function (event) {
  * the state machine pointer move/up/down functions based on cursor interaction
  */
 var registerTouchInteractions = function (_a) {
-    var canvas = _a.canvas, artboard = _a.artboard, _b = _a.stateMachines, stateMachines = _b === void 0 ? [] : _b, renderer = _a.renderer, rive = _a.rive, fit = _a.fit, alignment = _a.alignment;
+    var canvas = _a.canvas, artboard = _a.artboard, _b = _a.stateMachines, stateMachines = _b === void 0 ? [] : _b, renderer = _a.renderer, rive = _a.rive, fit = _a.fit, alignment = _a.alignment, _c = _a.isTouchScrollEnabled, isTouchScrollEnabled = _c === void 0 ? false : _c;
     if (!canvas ||
         !stateMachines.length ||
         !renderer ||
@@ -2326,7 +2330,7 @@ var registerTouchInteractions = function (_a) {
     }
     var processEventCallback = function (event) {
         var boundingRect = event.currentTarget.getBoundingClientRect();
-        var _a = getClientCoordinates(event), clientX = _a.clientX, clientY = _a.clientY;
+        var _a = getClientCoordinates(event, isTouchScrollEnabled), clientX = _a.clientX, clientY = _a.clientY;
         if (!clientX && !clientY) {
             return;
         }
@@ -3512,6 +3516,7 @@ var Rive = /** @class */ (function () {
         this.durations = [];
         this.frameTimes = [];
         this.frameCount = 0;
+        this.isTouchScrollEnabled = false;
         /**
          * Used be draw to track when a second of active rendering time has passed.
          * Used for debugging purposes
@@ -3522,6 +3527,7 @@ var Rive = /** @class */ (function () {
         this.buffer = params.buffer;
         this.layout = (_a = params.layout) !== null && _a !== void 0 ? _a : new Layout();
         this.shouldDisableRiveListeners = !!params.shouldDisableRiveListeners;
+        this.isTouchScrollEnabled = !!params.isTouchScrollEnabled;
         this.automaticallyHandleEvents = !!params.automaticallyHandleEvents;
         this.enableRiveAssetCDN =
             params.enableRiveAssetCDN === undefined
@@ -3623,12 +3629,22 @@ var Rive = /** @class */ (function () {
             console.error(e);
         });
     };
-    Rive.prototype.setupRiveListeners = function () {
+    /**
+     * Setup Rive Listeners on the canvas
+     * @param riveListenerOptions - Enables TouchEvent events on the canvas. Set to true to allow
+     * touch scrolling on the canvas element on touch-enabled devices
+     * i.e. { isTouchScrollEnabled: true }
+     */
+    Rive.prototype.setupRiveListeners = function (riveListenerOptions) {
         var _this = this;
         if (!this.shouldDisableRiveListeners) {
             var activeStateMachines = (this.animator.stateMachines || [])
                 .filter(function (sm) { return sm.playing && _this.runtime.hasListeners(sm.instance); })
                 .map(function (sm) { return sm.instance; });
+            var touchScrollEnabledOption = this.isTouchScrollEnabled;
+            if (riveListenerOptions && 'isTouchScrollEnabled' in riveListenerOptions) {
+                touchScrollEnabledOption = riveListenerOptions.isTouchScrollEnabled;
+            }
             this.eventCleanup = (0,_utils__WEBPACK_IMPORTED_MODULE_2__.registerTouchInteractions)({
                 canvas: this.canvas,
                 artboard: this.artboard,
@@ -3637,9 +3653,18 @@ var Rive = /** @class */ (function () {
                 rive: this.runtime,
                 fit: this._layout.runtimeFit(this.runtime),
                 alignment: this._layout.runtimeAlignment(this.runtime),
+                isTouchScrollEnabled: touchScrollEnabledOption,
             });
         }
     };
+    /**
+     * Remove Rive Listeners setup on the canvas
+     */
+    Rive.prototype.removeRiveListeners = function () {
+        if (this.eventCleanup) {
+            this.eventCleanup();
+        }
+    };
     // Initializes runtime with Rive data and preps for playing
     Rive.prototype.initData = function (artboardName, animationNames, stateMachineNames, autoplay) {
         var _a;