Skip navigation

Skip to main content

On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions getDesignMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl

User

auth.getCanvaUserToken auth.initOauth

overlay.registerOnCanOpen

API reference for the overlay.registerOnCanOpen method.

This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Registers a callback that runs when the canOpen state of an overlay target changes.

Parameters

optsobject

Required

Options for configuring the callback.

targetTarget

Required

The target to check the canOpen state of.

This must be "image_selection".

onCanOpenfunction

Required

A callback that runs when the canOpen state of the specified target changes.

This callback fires immediately.

Parameters

eventOverlayOpenableEvent<Target>

Required

Information about whether or not an overlay can be opened for the specified target.

Returns

void

Returns

() => void