API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddPagebulkCreate.launchcreateRichtextRangeeditContentgetCurrentPageContextgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointChangelog
Intents
Intents: Asset
Intents: Content
Intents: data
Intents: design
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrl
App middleware: Express
Changelog for @canva/design@beta
The latest changes for the Canva Apps SDK @canva/design@beta package.
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.