API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointChangelog
Design: Test
Intents
Intents: Asset
Intents: Content
Intents: Data
Intents: Design
Intents: Test
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
User: Test
App middleware: Express
Error
Error: 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
requestApplyPublicTemplatehas 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
getDesignColorsandgetBrandKitColorsfrom preview to GA.
2.12.1-beta.0 - 2026-08-13
Added
openDesign(Beta): the current-page session'shelpersnow includegetDataFieldFor({ target }), returning aDataFieldAccessorfor reading and updating an element's data-field mapping. Supported targets are aTextElement(connects to atextfield), aRectElement, or aPathFillWithEditableMedia(connect their fill to afillfield).get()returns the connected field's label;set({ label })connects to or creates a field, andset({ label: Unset })removes the mapping. Changes are staged untilsession.sync().set()resolves to{ status: 'completed' }, or to{ status: 'incompatible_data_field_type' | 'data_field_limit_exceeded' }on a validation failure. Also exports theUnsetsymbol and theDataFieldAccessor,DataFieldSetOptions,DataFieldAccessorSetResult, andGetDataFieldForOptionstypes.- Promoted APIs that newly expose page IDs as unique identifiers to public release:
getDesignMetadata,openDesign,addPageandgetCurrentPageMetadata. - Promoted line height and letter spacing formatting properties in
createRichtextRangewhich 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
brandColorsEnforcedandbrandFontsEnforcedtoDesignMetadatareturned bygetDesignMetadata(). 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
RichtextFormattingincreateRichtextRange.
2.10.2-beta.2 - 2026-07-28
Added
- Page IDs are now exposed in
AbsolutePagein the Design Editing API (openDesign)
Fixed
ElementIdis now a branded string type.
2.10.2-beta.1 - 2026-07-24
Added
- Promoted
requestDataFieldMatchingfrom Alpha to Beta.
2.10.2-beta.0 - 2026-07-23
Changed
autofillDesignno longer accepts atitleoption — the document's current title is retained after Autofill completes.autofillDesignnow resolves with{ status: 'success' | 'no_matched_fields' }, adding ano_matched_fieldsstatus for designs with no fields tagged for Autofill. The user not having access to Autofill (and any other unexpected failure) rejects the promise with aCanvaError.- 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 providedDataTable(optionally updating the document title). This replaces the AlpharequestAutofillDesign— data is now retrieved separately viarequestDataTable, so Autofill only fills the design.
Changed
- Deprecate the Alpha
requestAutofillDesignin favour ofautofillDesign.
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
getDesignColorsto retrieve the colors currently used in the design.
2.10.1-beta.0 - 2026-07-01
Changed
- Added element ID as
idon Design Editing API typeElement. The type ofElement.idistype ElementId = string.
Added
- addPage API responds with PageMetadata object
- Promoted
design.getDesignTemplateMetadatawhich was previously in preview to GA. - Added
pageIdtoAbsolutePageMetadatareturned bygetDesignMetadataandaddPage
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
trimandimageBoxoptional properties onVideoElementto 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
getDesignMetadatahas been evolved to includepage typeandpage titlefor supported page types.
2.7.6-beta.1 - 2026-01-18
Added
- Beta versions of
addElementAtPoint,initAppElement, andaddPagenow supporttrimandimageBoxon video elements. - New API
publish.launchto launch the content publisher - New API
bulkCreate.launchto open the Bulk Create experience with the Data Connector intent open. - Added a CHANGELOG.md to track changes.
- New API
getDesignTemplateMetadatain 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.