@rive-app/canvas-lite 2.20.2 → 2.21.1

package/package.json

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

package/rive.d.ts

@@ -516,6 +516,44 @@ export declare class Rive {
      * @param path the path the input is located at an artboard level
      */
     fireStateAtPath(inputName: string, path: string): void;
+    private retrieveTextAtPath;
+    /**
+     * Retrieves the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param path The path to the text run within the artboard
+     * @returns The text value of the text run, or undefined if not found
+     *
+     * @example
+     * // Get the text value for a text run named "title" at one nested artboard deep
+     * const titleText = riveInstance.getTextRunValueAtPath("title", "artboard1");
+     *
+     * @example
+     * // Get the text value for a text run named "subtitle" within a nested group two artboards deep
+     * const subtitleText = riveInstance.getTextRunValueAtPath("subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    getTextRunValueAtPath(textName: string, path: string): string | undefined;
+    /**
+     * Sets the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param value The new text value to set
+     * @param path The path to the text run within the artboard
+     * @returns void
+     *
+     * @example
+     * // Set the text value for a text run named "title" at one nested artboard deep
+     * riveInstance.setTextRunValueAtPath("title", "New Title", "artboard1");
+     *
+     * @example
+     * // Set the text value for a text run named "subtitle" within a nested group two artboards deep
+     * riveInstance.setTextRunValueAtPath("subtitle", "New Subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    setTextRunValueAtPath(textName: string, value: string, path: string): void;
     get playingStateMachineNames(): string[];
     get playingAnimationNames(): string[];
     get pausedAnimationNames(): string[];

package/rive.js

@@ -2261,7 +2261,7 @@ Pc();
 /* 2 */
 /***/ ((module) => {
 
-module.exports = JSON.parse('{"name":"@rive-app/canvas-lite","version":"2.20.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_fallback.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.21.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_fallback.wasm","rive.d.ts","rive_advanced.mjs.d.ts"],"typings":"rive.d.ts","dependencies":{},"browser":{"fs":false,"path":false}}');
 
 /***/ }),
 /* 3 */
@@ -4803,6 +4803,78 @@ var Rive = /** @class */ (function () {
             console.warn("Input with name: '".concat(inputName, "', at path:'").concat(path, "' is not a trigger"));
         }
     };
+    // Returns the TextValueRun object for the provided name at the given path
+    Rive.prototype.retrieveTextAtPath = function (name, path) {
+        if (!name) {
+            console.warn("No text name provided for path '".concat(path, "'"));
+            return;
+        }
+        if (!path) {
+            console.warn("No path provided for text '".concat(name, "'"));
+            return;
+        }
+        if (!this.artboard) {
+            console.warn("Tried to access text: '".concat(name, "', at path: '").concat(path, "', but the Artboard is null"));
+            return;
+        }
+        var text = this.artboard.textByPath(name, path);
+        if (!text) {
+            console.warn("Could not access text with name: '".concat(name, "', at path:'").concat(path, "'"));
+            return;
+        }
+        return text;
+    };
+    /**
+     * Retrieves the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param path The path to the text run within the artboard
+     * @returns The text value of the text run, or undefined if not found
+     *
+     * @example
+     * // Get the text value for a text run named "title" at one nested artboard deep
+     * const titleText = riveInstance.getTextRunValueAtPath("title", "artboard1");
+     *
+     * @example
+     * // Get the text value for a text run named "subtitle" within a nested group two artboards deep
+     * const subtitleText = riveInstance.getTextRunValueAtPath("subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    Rive.prototype.getTextRunValueAtPath = function (textName, path) {
+        var run = this.retrieveTextAtPath(textName, path);
+        if (!run) {
+            console.warn("Could not get text with name: '".concat(textName, "', at path:'").concat(path, "'"));
+            return;
+        }
+        return run.text;
+    };
+    /**
+     * Sets the text value for a specified text run at a given path
+     * @param textName The name of the text run
+     * @param value The new text value to set
+     * @param path The path to the text run within the artboard
+     * @returns void
+     *
+     * @example
+     * // Set the text value for a text run named "title" at one nested artboard deep
+     * riveInstance.setTextRunValueAtPath("title", "New Title", "artboard1");
+     *
+     * @example
+     * // Set the text value for a text run named "subtitle" within a nested group two artboards deep
+     * riveInstance.setTextRunValueAtPath("subtitle", "New Subtitle", "group/nestedGroup");
+     *
+     * @remarks
+     * If the text run cannot be found at the specified path, a warning will be logged to the console.
+     */
+    Rive.prototype.setTextRunValueAtPath = function (textName, value, path) {
+        var run = this.retrieveTextAtPath(textName, path);
+        if (!run) {
+            console.warn("Could not set text with name: '".concat(textName, "', at path:'").concat(path, "'"));
+            return;
+        }
+        run.text = value;
+    };
     Object.defineProperty(Rive.prototype, "playingStateMachineNames", {
         // Returns a list of playing machine names
         get: function () {