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
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPagecreateRichtextRangegetCurrentPageContextgetDefaultPageDimensionsgetDesignTokeninitAppElementoverlay.registerOnCanOpenrequestExportselection.registerOnChangesetCurrentPageBackgroundui.startDragToCursorui.startDragToPointui.startDrag
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInforequestOpenExternalUrl
Updates the background of the user's current page. The background can be a solid color, an image or a video.
Parameters
opts
PageBackgroundFill
REQUIRED
The appearance of a page's background.
Properties of opts
asset
object
OPTIONAL
An image or video to use as the fill.
An image asset that fills a path's interior.
type
string
REQUIRED
The type of fill.
This must be "image"
.
ref
ImageRef
REQUIRED
A unique identifier that points to an image asset in Canva's backend.
A video asset that fills a path's interior.
type
string
REQUIRED
The type of fill.
This must be "video"
.
ref
VideoRef
REQUIRED
A unique identifier that points to a video asset in Canva's backend.
color
string
OPTIONAL
The color of the fill as a hex code.
The hex code must include all six characters and be prefixed with a #
symbol.
Example
" #ff0099"
TS
Returns
Promise<void>