DEVELOPER REFERENCE · v4.0.0

ColorPicker API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

ColorPicker10 props1 callbacks0 methods

ColorPicker props
Name	Type	Description
`label`Required	`string`	Label content or accessible name for the component, as rendered by this control.
`value`Optional	`string \| undefined`	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
`defaultLabel`Required	`string`	Label for the default or unset color choice.
`customLabel`Required	`string`	Label for choosing a custom color.
`customHexLabel`Optional	`string \| undefined`	Accessible label for entering a custom hexadecimal color.
`invalidColor`Optional	`string \| undefined`	Validation message shown when the entered color is invalid.
`colorLabels`Required	`Readonly<Record<string, string>>`Inspect type	Maps color values to localized display/accessibility labels.
`optional`Optional	`boolean \| undefined`	Allows the color value to be cleared or left unset.
`allowHexInput`Optional	`boolean \| undefined`	Set false for a selection-only palette and native color chooser.
`disabled`Optional	`boolean \| undefined`	Disables user interaction with the control.

ColorPicker events and callbacks
Name	Type	Description
`onChange`Required	`(value: string \| undefined) => void`Inspect type	Receives the new value when the user changes the control. Update the corresponding value prop for controlled use.

No component-specific imperative methods. Use props and callbacks to control this component.