ColourPickerOptions

Options for the Colour Picker.

TypeScript

export interface

Properties

Property	Type	Description	Default
filterColours	`(context:ColourPickerFilterContext) =>ColourPickerFilterResult` `\| void`	Chooses which of the supplied colours (theme & colour palette) the Palette tab shows
orderPaletteColours	`boolean`	Orders Palette swatches around the colour wheel; if `false`, each colour stays the order supplied	true
removeDuplicates	`boolean`	Leave out duplicates of swatches already displayed	true
showGroupLabels	`boolean`	Show Theme and Palette headings on the Palette tab (if both have colours)	false
tabs	`ColourPickerTab[]`	Colour Picker tabs to display in order provided; `Custom`, `Palette`, or both	['Custom', 'Palette']

Chooses which of the supplied colours (theme & colour palette) the Palette tab shows

TypeScript

filterColours?: (context: ColourPickerFilterContext) => ColourPickerFilterResult | void;

Orders Palette swatches around the colour wheel; if false, each colour stays the order supplied

TypeScript

orderPaletteColours?: boolean;

true

boolean

Leave out duplicates of swatches already displayed

TypeScript

removeDuplicates?: boolean;

true

boolean

Show Theme and Palette headings on the Palette tab (if both have colours)

TypeScript

showGroupLabels?: boolean;

false

boolean

Colour Picker tabs to display in order provided; Custom, Palette, or both

TypeScript

tabs?: ColourPickerTab[];

['Custom', 'Palette']