Contact us

Applies to: Customer's Canvas On-Premises; Customer's Canvas Hub cloud; UI Framework 4.0 - 4.46

Skip to main content

au-widget-color-selector/IColorSelectorConfig

Interfaces​

IColor​

Provides color properties.

Properties​

preselected?​
optional preselected?: boolean;

If true, highlights this color when the color selector opens.

props?​
optional props?: any;
title​
title: string;

The title preview.

value​
value: string | string[];

The color preview.


IColorSelectorConfig​

Provides properties for a color selector.

Properties​

colors​
colors: IColor[];

An array of colors available for user selection by the user.

onChange?​
optional onChange?: Function | Function[];

A function ("{{#function <expression>}}") or an array of functions. This event triggers when the user selects a color set.

popupText​
popupText: string;

A text hint in the pop-up box.

svg?​
optional svg?: string;

A custom inline SVG string in which you must refer to currentColor.

For example, "<svg viewBox='0 0 20 20'><path d='m5 5h10v10h-10z' fill='currentColor'/></svg>".

The currentColor corresponds to the first color in the array, and the second color fills the background.

text​
text: string;

The widget caption.

value​
value: any;

The preview of the selected color.

Was this page helpful?