API reference
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangeeditContentgetCurrentPageContextgetDefaultPageDimensionsgetDesignTokeninitAppElementoverlay.registerOnCanOpenrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Intents: data
Intents: design
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInforequestOpenExternalUrl
prepareDesignEditor
API reference for the intents prepareDesignEditor method.
Prepares a DesignEditor Intent.
Usage
import { prepareDesignEditor } from '@canva/intents/design';prepareDesignEditor({render: async () => {// TODO: Implement the logic to render your app's UI},});
TSX
Parameters
implementation
DesignEditorIntent
RequiredMain interface for implementing the DesignEditor intent.
Implementing the DesignEditor Intent enables apps to assist users in editing designs, by presenting interactive and creative tooling alongside the Canva design surface.
render
function
RequiredRenders the UI containing the app’s functionality.
Example
function render() {// render your UI using your preferred framework}
TSX
Returns
void
Returns
void