API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagebulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetCurrentPageContextgetCurrentPageMetadatagetDefaultPageDimensionsgetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDragChangelog
Design: Test
Error
Error: Test
Intents
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
User: Test
Changelog for @canva/intents
The latest changes for the Canva Apps SDK @canva/intents package.
2.7.0 - 2026-08-17
Added
- Adds a new field contentNoun to content publisher intent, which controls the copy of the publish button. Leaving it empty defaults it to type 'content' (generic). Consumers should set this appropriately and prepare for the deprecation of custom overrides (the current method of changing the publish button copy).
2.6.0 - 2026-06-09
Added
- Promote
DocumentPreviewUpgrading,DocumentPreviewReady, andDocumentPreviewPagefrom beta to public - The
DocumentPreviewunion now includesupgradingandreadystates in the GA package
2.5.0 - 2026-04-09
Changed
- Increased the
publishRefsize limit from 5KB to 32KB, allowing apps to store more complex publishing settings.
Added
- Add design metadata in MediaSelections
- Enable apps to support transparent PNG exports in publish flow by adding optional allowTransparentBackground capability to ImageRequirement
2.4.0 - 2026-03-23
Added
- Launch the new Email media type to public, enabling publishing and selection of email pages.
2.3.1 - 2026-03-12
Fixed
- Re-export data types from the intents/data public API that were accidentally removed during a refactor
- Rename
Selectiontype toMediaSelectionfor clarity
2.3.0 - 2026-03-06
Added
- Promoted
Selection,ImageSelection,VideoSelection,DocumentSelection,EmailSelectiontypes andMediaSlot.selectionfield from beta to public
2.2.0 - 2026-02-06
Added
- Added invocation context to provide initial state when rendering UIs
2.1.2 - 2026-02-03
Fixed
- Fix missing id and status fields in Content Publisher email preview type
2.1.1 - 2026-01-30
Changed
- Update NPM readme
2.1.0 - 2026-01-30
Added
- Added a CHANGELOG.md to track changes.
- Added a test harness method
initTestEnvionmentwhich can be imported from@canva/intents/test - Promoted the Content Publisher Intent API from beta to general availability
2.0.0 - 2025-06-12
Added
- Added the new
@canva/intentspackage at version2.0.0with the brand new Data Connector intent.