Interface IColorSelectorConfig

Provides properties for a color-selector.

Package: ui-framework

Properties

colors

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

Declaration

colors: Array<IColor>

Property Value

Type	Description
Array<IColor>	An array of colors available for user selection by the user.

onChange

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

Declaration

onChange?: Function | Array<Function>

Property Value

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

popupText

A text hint in the pop-up box.

Declaration

popupText: string

Property Value

Type	Description
string	A text hint in the pop-up box.

svg

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.

Declaration

svg?: string

Property Value

Type	Description
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

The widget caption.

Declaration

text: string

Property Value

Type	Description
string	The widget caption.

value

The preview of the selected color.

Declaration

value: any

Property Value

Type	Description
any	The preview of the selected color.