Skip navigation
Skip to main content
API reference
API reference

openColorSelector

API reference for the openColorSelector method.

Prompts the user to choose a color that can be used within Canva.

Parameters

#anchorAnchor
Required

A bounding box.

Properties of anchor
#heightnumber
Required

The height of the bounding box, in pixels.

#leftnumber
Required

The left position of the bounding box, in pixels.

#topnumber
Required

The top position of the bounding box, in pixels.

#widthnumber
Required

The width of the bounding box, in pixels.

#optionsColorSelectorOpts<Scope>
Required

Options for configuring a color selector.

Properties of options
#onColorSelectfunction
Required

A callback that runs when the user selects a color.

Parameters

#eventColorSelectionEvent<Scope>
Required

The color selection event.

Properties of event
#selectionobject
Required

The selected color.

The exact properties depends on the configured scope.

Returns

void

#scopesScope[]
Required

The supported scopes, used to determine the appearance and behavior of the color selector.

This must be "solid".

#selectedColorobject
Optional

The color to display as selected when the color selector is opened.

This is only required if there are multiple UI components for selecting colors. For example, if the app renders multiple Swatch components.

If this value is undefined, the most recently selected color will be displayed as selected.

This property only affects Document colors and Default colors.

Returns

A function that closes the currently open color selector.

Promise<() => void>