API reference
Intents
Intents: Asset
Intents: Content
Intents: Design
Intents: Test
Platform: Test

Changelog for @canva/design@beta

The latest changes for the Canva Apps SDK @canva/design@beta package.

2.13.1-beta.1 - 2026-09-04

Added

  • requestApplyPublicTemplate has been added. It opens a template selection panel scoped to either a developer-curated list of template IDs or a partner's published Marketplace template collections, and applies the selected template to the current design.

2.13.1-beta.0 - 2026-09-01

Added

  • Promoted getDesignColors and getBrandKitColors from preview to GA.

2.12.1-beta.0 - 2026-08-13

Added

  • openDesign (Beta): the current-page session's helpers now include getDataFieldFor({ target }), returning a DataFieldAccessor for reading and updating an element's data-field mapping. Supported targets are a TextElement (connects to a text field), a RectElement, or a PathFillWithEditableMedia (connect their fill to a fill field). get() returns the connected field's label; set({ label }) connects to or creates a field, and set({ label: Unset }) removes the mapping. Changes are staged until session.sync(). set() resolves to { status: 'completed' }, or to { status: 'incompatible_data_field_type' | 'data_field_limit_exceeded' } on a validation failure. Also exports the Unset symbol and the DataFieldAccessor, DataFieldSetOptions, DataFieldAccessorSetResult, and GetDataFieldForOptions types.
  • Promoted APIs that newly expose page IDs as unique identifiers to public release: getDesignMetadata, openDesign, addPage and getCurrentPageMetadata.
  • Promoted line height and letter spacing formatting properties in createRichtextRange which was previously in Preview to GA.
  • Add setDataFieldLabelVisibility, which shows or hides the purple data field labels in the editor for the current app session. The setting resets to hidden once the app session ends.
  • Added new preview API getBrandKitColors, which retrieves the current Brand Kit colors for the design.
  • Added brandColorsEnforced and brandFontsEnforced to DesignMetadata returned by getDesignMetadata(). These booleans indicate whether brand colors and/or brand fonts are enforced for the design via the brand admin's Brand Control settings.

2.10.2-beta.3 - 2026-08-03

Added

  • Added line height and letter spacing formatting to RichtextFormatting in createRichtextRange.

2.10.2-beta.2 - 2026-07-28

Added

  • Page IDs are now exposed in AbsolutePage in the Design Editing API (openDesign)

Fixed

  • ElementId is now a branded string type.

2.10.2-beta.1 - 2026-07-24

Added

  • Promoted requestDataFieldMatching from Alpha to Beta.

2.10.2-beta.0 - 2026-07-23

Changed

  • autofillDesign no longer accepts a title option — the document's current title is retained after Autofill completes.
  • autofillDesign now resolves with { status: 'success' | 'no_matched_fields' }, adding a no_matched_fields status for designs with no fields tagged for Autofill. The user not having access to Autofill (and any other unexpected failure) rejects the promise with a CanvaError.
  • Renamed pageId to id in the Metadata APIs
  • Promote Template APIs (requestBrandTemplates, getBrandTemplateMetadata, applyTemplate) from early preview to preview.

Added

  • Add autofillDesign, which fills the tagged elements of the current design with a provided DataTable (optionally updating the document title). This replaces the Alpha requestAutofillDesign — data is now retrieved separately via requestDataTable, so Autofill only fills the design.

Changed

  • Deprecate the Alpha requestAutofillDesign in favour of autofillDesign.

2.10.1-beta.2 - 2026-07-15

Added

  • Added new API getCurrentPageMetadata

2.10.1-beta.1 - 2026-07-07

Added

  • Added new beta API getDesignColors to retrieve the colors currently used in the design.

2.10.1-beta.0 - 2026-07-01

Changed

  • Added element ID as id on Design Editing API type Element. The type of Element.id is type ElementId = string.

Added

  • addPage API responds with PageMetadata object
  • Promoted design.getDesignTemplateMetadata which was previously in preview to GA.
  • Added pageId to AbsolutePageMetadata returned by getDesignMetadata and addPage

2.8.1-beta.0 - 2026-05-11

Changed

  • Introduced a new property to DesignMetadata that lists all the dataset fields in the current document. These are fields that were tagged for bulk create or brand templates mapping, and are only available in FIXED designs. The list will come empty if no fields are available.

Added

  • Introduce trim and imageBox optional properties on VideoElement to beta, enabling apps to control video playback timing (start/end points in seconds) and crop the visible portion of a video.

2.7.6-beta.2 - 2026-02-01

Added

  • Beta version of getDesignMetadata has been evolved to include page type and page title for supported page types.

2.7.6-beta.1 - 2026-01-18

Added

  • Beta versions of addElementAtPoint, initAppElement, and addPage now support trim and imageBox on video elements.
  • New API publish.launch to launch the content publisher
  • New API bulkCreate.launch to open the Bulk Create experience with the Data Connector intent open.
  • Added a CHANGELOG.md to track changes.
  • New API getDesignTemplateMetadata in beta to return template metadata for a design that has used a template.

2.7.6-beta.0 - 2025-11-12

  • Initial changelog for the Preview Design SDK.