DEVELOPER REFERENCE · v4.0.0

ColorPalette API

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

ColorPalette8 props1 callbacks0 methods

ColorPalette props
Name	Type	Description
`value`Required	`ColorPaletteValue`Inspect type	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
`options`Optional	`readonly ColorPaletteOption[] \| undefined`Inspect type	Available choices or control configuration, according to the declared type; expand it to inspect each field.
`ariaLabel`Required	`string`	Accessible name announced by assistive technology.
`defaultLabel`Required	`string`	Label for the default or unset color choice.
`colorAriaLabel`Required	`(option: ColorPaletteOption) => string`Inspect type	Returns the accessible label for a palette option.
`disabled`Optional	`boolean \| undefined`	Disables user interaction with the control.
`includeDefault`Optional	`boolean \| undefined`	Includes a default/unset choice in the color palette.
`defaultDisabled`Optional	`boolean \| undefined`	Disables the default/unset palette choice.

ColorPalette events and callbacks
Name	Type	Description
`onChange`Required	`(value: ColorPaletteValue) => 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.