Prompts the user to choose a color that can be used within Canva.
Parameters
anchor
Anchor
A bounding box.
Properties of anchor
height
number
The height of the bounding box, in pixels.
width
number
The width of the bounding box, in pixels.
top
number
The top position of the bounding box, in pixels.
left
number
The left position of the bounding box, in pixels.
options
ColorSelectorOpts<Scope>
Options for configuring a color selector.
Properties of options
scopes
Scope[]
The supported scopes, used to determine the appearance and behavior of the color selector.
This must be "solid"
.
onColorSelect
function
A callback that runs when the user selects a color.
Parameters
event
ColorSelectionEvent<Scope>
The color selection event.
Properties of event
selection
object
The selected color.
The exact properties depends on the configured scope
.
Returns
void
selectedColor
object
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>