Prompts the user to choose a color that can be used within Canva.
Parameters
Required
Required
Options for configuring a color selector.
Properties of options
Required
Required
The supported scopes, used to determine the appearance and behavior of the color selector.
This must be "solid"
.
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>