API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions 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

API reference

ListState

API reference for the ListState type.

A list of items that can be read.

Type Parameters

• T

Indexable

[n: number]: T

Properties

lengthnumberRead-onlyRequired

Methods

joinfunctionRequired

Parameters

separatorstringOptional

Returns

string

slicefunctionRequired

Parameters

startnumberOptional

endnumberOptional

Returns

A list of items that can be read and updated.

lengthnumber

popfunction

Returns

undefined | T

pushfunction

Parameters

itemsT[]Required

Returns

number

shiftfunction

Returns

undefined | T

splicefunction

Parameters

startnumberRequired

deleteCountnumberRequired

itemsT[]Required

Returns

A list of items that can be read and updated.

EditableListState<T>

unshiftfunction

Parameters

itemsT[]Required

Returns

number

For more information, see ListState.

indexOffunctionRequired

Parameters

searchElementTRequired

fromIndexnumberOptional

Returns

number

lastIndexOffunctionRequired

Parameters

searchElementTRequired

fromIndexnumberOptional

Returns

number

everyfunctionRequired

Parameters

predicatefunctionRequired

Parameters

valueTRequired

indexnumberRequired

Returns

unknown

Returns

boolean

somefunctionRequired

Parameters

predicatefunctionRequired

Parameters

valueTRequired

indexnumberRequired

Returns

unknown

Returns

boolean

forEachfunctionRequired

Parameters

callbackFnfunctionRequired

Parameters

valueTRequired

indexnumberRequired

Returns

void

Returns

void

mapfunctionRequired

Parameters

callbackFnfunctionRequired

Parameters

valueTRequired

indexnumberRequired

Returns

U

Returns

A list of items that can be read and updated.

lengthnumber

popfunction

Returns

undefined | T

pushfunction

Parameters

itemsT[]Required

Returns

number

shiftfunction

Returns

undefined | T

splicefunction

Parameters

startnumberRequired

deleteCountnumberRequired

itemsT[]Required

Returns

A list of items that can be read and updated.

EditableListState<T>

unshiftfunction

Parameters

itemsT[]Required

Returns

number

For more information, see ListState.

filterfunctionRequired

Parameters

predicatefunctionRequired

Parameters

valueTRequired

indexnumberRequired

Returns

unknown

Returns

T[]

reducefunctionRequired

Parameters

callbackFnfunctionRequired

Parameters

previousValueURequired

currentValueTRequired

currentIndexnumberRequired

Returns

U

initialValueURequired

Returns

U

reduceRightfunctionRequired

Parameters

callbackFnfunctionRequired

Parameters

previousValueURequired

currentValueTRequired

currentIndexnumberRequired

Returns

U

initialValueURequired

Returns

U

findfunctionRequired

Parameters

predicatefunctionRequired

Parameters

valueundefined | TRequired

indexnumberRequired

Returns

unknown

Returns

undefined | T

flatMapfunctionRequired

Parameters

callbackfunctionRequired

Parameters

valueTRequired

indexnumberRequired

arrayT[]Required

Returns

U[]