API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagebulkCreate.launchChangelogcreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Error
Intents
Intents: Content
Intents: data
Intents: design
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Changelog for @canva/design
The latest changes for the Canva Apps SDK @canva/design package.
2.8.0 - 2026-02-02
Added
- Added a CHANGELOG.md to track changes.
- This introduces 2 new APIs, bulkCreate and publish, each with a corresponding launch function that allows the app to launch these experiences directly using the app's set up Data Connector and Content Publisher intents.
Fixed
- Improve
mailtoURI validation to more accurately detect valid email addresses.
Other
- Updated types for
requestExportinto separate named objects
2.7.5 - 2025-12-09
Added
- Added support for custom dimensions in the
addPageAPI call. - Added the ability to configure the zipped behaviour of certain types when exporting with
requestExport.
2.7.4 - 2025-11-28
Added
- Added
design.getDesignMetadatamethod, which allows apps to get information about the design. See the documentation.
2.7.3 - 2025-10-13
Deprecated
- Deprecated
CurrentPageResultin favour ofCurrentPageSession.
Removed
- We no longer provide
indexparameter in theforEachcallbacks.
2.7.2 - 2025-08-05
Deprecated
- Deprecate
design.getDefaultPageDimensions, usedesign.getDesignMetadatainstead. See the documentation.
2.7.0 - 2025-07-15
Added
- Added the
getDesignMetadatamethod, which allows apps to get information about the design. See the documentation.
Deprecated
- Deprecated
design.getDefaultPageDimensions, usedesign.getDesignMetadatainstead. See the documentation.
2.6.1 - 2025-06-24
Added
openDesign: Added new async helper methodsgroupandungroup. See the documentation on PageHelpers.
Changed
openDesign: Design Editing API is out of preview and Generally Available.- Breaking:
openDesignfunction signature changes:saveis superseded bysync. Unlikesave,synccan be called multiple times as needed.- Renamed page type:
fixed→absolute. - New page type:
unsupported, which represents pages that are notabsolute. - Renamed
elementBuildertoelementStateBuilder. - Removed
cloneElement. mediaandcolorfills are superseded bymediaContainerandcolorContainer.- For shape path fills,
isMediaEditableintroduced to indicate editability.
2.4.0 - 2025-02-17
Added
- Latest version of the App Element API is out of preview and Generally Available. This version enables atomic and predictable operations that are no longer tied current selection. To learn more, see App Elements.
2.3.0 - 2024-12-15
Added
- Content Query API is out of preview and Generally Available.
- Introduced a test harness to allow for unit testing of the package.
2.2.1 - 2024-10-21
Added
- Updated App Element API to enable atomic and predictable operations that are no longer tied current selection. To learn more, see App Elements documentation.
2.1.0 - 2024-09-23
Deprecated
- Deprecated
NativeElementTypetype.
2.0.0 - 2024-09-20
Changed
- Breaking: See Apps SDK Migration Guide for full list of changes.
1.10.0 - 2024-08-22
Added
- Added
altTextproperty to image elements. - Added design.overlay.registerOnCanOpen which was previously in beta.
1.9.0 - 2024-05-29
Added
- Added the ability to read/write video via the Selection API.
1.8.0 - 2024-05-06
Added
- NativeVideoElement is now supported in app elements. See the documentation.
1.7.0 - 2024-04-10
Added
- Added design.getDesignToken which was previously in beta. See the documentation.
1.6.0 - 2024-02-25
1.5.0 - 2024-02-12
Changed
- Updated
fontWeightofstartDragto allow more values. - Exported some additional types, such as
FontWeightandTextAttributes.
1.4.0 - 2023-12-13
Removed
- Removed video elements from
AppElementRendererOutput.
Fixed
- Excluded
undefinedinArraytype, and removedbigint,Set, andMaptypes fromAppElementDatato align with existing internal validation.
1.3.0 - 2023-12-12
Added
- Initial NPM release of
@canva/designpackage.