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

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-only

Required

Methods

joinfunction

Required

Parameters

separatorstring

Optional

Returns

string

slicefunction

Required

Parameters

startnumber

Optional

endnumber

Optional

Returns

A list of items that can be read and updated.

lengthnumber

popfunction

Returns

T | undefined

pushfunction

Parameters

itemsT[]

Required

Returns

number

shiftfunction

Returns

T | undefined

splicefunction

Parameters

startnumber

Required

deleteCountnumber

Required

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.

indexOffunction

Required

Parameters

searchElementT

Required

fromIndexnumber

Optional

Returns

number

lastIndexOffunction

Required

Parameters

searchElementT

Required

fromIndexnumber

Optional

Returns

number

everyfunction

Required

Parameters

predicatefunction

Required

Parameters

valueT

Required

indexnumber

Required

Returns

unknown

Returns

boolean

somefunction

Required

Parameters

predicatefunction

Required

Parameters

valueT

Required

indexnumber

Required

Returns

unknown

Returns

boolean

forEachfunction

Required

Parameters

callbackFnfunction

Required

Parameters

valueT

Required

indexnumber

Required

Returns

void

Returns

void

mapfunction

Required

Parameters

callbackFnfunction

Required

Parameters

valueT

Required

indexnumber

Required

Returns

U

Returns

A list of items that can be read and updated.

lengthnumber

popfunction

Returns

T | undefined

pushfunction

Parameters

itemsT[]

Required

Returns

number

shiftfunction

Returns

T | undefined

splicefunction

Parameters

startnumber

Required

deleteCountnumber

Required

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.

filterfunction

Required

Parameters

predicatefunction

Required

Parameters

valueT

Required

indexnumber

Required

Returns

unknown

Returns

T[]

reducefunction

Required

Parameters

callbackFnfunction

Required

Parameters

previousValueU

Required

currentValueT

Required

currentIndexnumber

Required

Returns

U

initialValueU

Required

Returns

U

reduceRightfunction

Required

Parameters

callbackFnfunction

Required

Parameters

previousValueU

Required

currentValueT

Required

currentIndexnumber

Required

Returns

U

initialValueU

Required

Returns

U

findfunction

Required

Parameters

predicatefunction

Required

Parameters

valueT | undefined

Required

indexnumber

Required

Returns

unknown

Returns

T | undefined

flatMapfunction

Required

Parameters

callbackfunction

Required

Parameters

valueT

Required

indexnumber

Required

arrayT[]

Required

Returns

U[]

atfunction

Required

Parameters

indexnumber

Required

Returns

T | undefined