@canva/design 1.9.0 → 1.10.0

package/index.d.ts

@@ -30,6 +30,23 @@ export declare function addPage(opts?: {
   title?: string;
 }): Promise<void>;
 
+/**
+ * @public
+ * Describes any alt-text that will be added for a11y.
+ */
+export declare type AltText = {
+  /**
+   * The text that will appear as alt-text.
+   */
+  text: string;
+  /**
+   * An optional property that will determine whether text is shown in just the editor or both editor and view mode.
+   * If set to true, alt-text will only be rendered inside the editor.
+   * If set to false or omitted, alt-text will be rendered in both the editor and in view only mode.
+   */
+  decorative: boolean | undefined;
+};
+
 /**
  * @public
  * A callback that runs when an app element's data is created or updated,
@@ -765,6 +782,10 @@ export declare type NativeImageElement = {
    * The type of element.
    */
   type: "IMAGE";
+  /**
+   * An optional object to describe alt-text that may be applied to an image.
+   */
+  altText?: AltText;
 } & (
   | {
       /**
@@ -944,6 +965,10 @@ export declare type NativeVideoElement = {
    * A unique identifier that references a video asset in Canva's backend.
    */
   ref: VideoRef;
+  /**
+   * An optional object to describe alt-text that may be applied to a video.
+   */
+  altText?: AltText;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canva/design",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "The Canva Apps SDK design library",
   "author": "Canva Pty Ltd.",
   "license": "SEE LICENSE IN LICENSE.md FILE",