@rive-app/canvas - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

package.json

 {
   "name": "@rive-app/canvas",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Rive's canvas based web api.",
@@ -5,0 +5,0 @@ "main": "rive.js",

rive_advanced.mjs.d.ts

@@ -384,2 +384,7 @@ interface RiveOptions {
   transformComponent(name: string): TransformComponent;
+  /**
+   * Returns a reference for a TextValueRun object to get/set a text value for
+   * @param name - Name of the Text Run to grab a reference to
+   */
+  textRun(name: string): TextValueRun;
 }
@@ -487,2 +492,13 @@
 
+export declare class TextValueRun {
+  /**
+   * Getter for text value of the Text Run
+   */
+  get text(): string;
+  /**
+   * Setter for the text value of the Text Run
+   */
+  set text(val: string);
+}
+
 export declare class LinearAnimation {
@@ -489,0 +505,0 @@ /**

rive.d.ts

@@ -314,2 +314,24 @@ import * as rc from "./rive_advanced.mjs";
     cleanupInstances(): void;
+    /**
+     * Tries to query the setup Artboard for a text run node with the given name.
+     *
+     * @param textRunName - Name of the text run node associated with a text object
+     * @returns - TextValueRun node or undefined if the text run cannot be queried
+     */
+    private retrieveTextRun;
+    /**
+     * Returns a string from a given text run node name, or undefined if the text run
+     * cannot be queried.
+     *
+     * @param textRunName - Name of the text run node associated with a text object
+     * @returns - String value of the text run node or undefined
+     */
+    getTextRunValue(textRunName: string): string | undefined;
+    /**
+     * Sets a text value for a given text run node name if possible
+     *
+     * @param textRunName - Name of the text run node associated with a text object
+     * @param textRunValue - String value to set on the text run node
+     */
+    setTextRunValue(textRunName: string, textRunValue: string): void;
     play(animationNames?: string | string[], autoplay?: true): void;
@@ -316,0 +338,0 @@ pause(animationNames?: string | string[]): void;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

983672

increased by0.62%

Lines of code

3419

increased by2.49%

No dependency changes