File

projects/components/src/widgets/common/color-picker/color-picker.component.doc.ts

Description

The wmColorPicker component defines the colorpicker widget.

Index

Methods
Inputs

Methods

onBlur
onBlur($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget loses focus.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void
onChange
onChange($event: MouseEvent, widget: any, newVal: string, oldVal: string)

Callback function which will be triggered when the widget value is changed.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

newVal string No

New value of the colorpicker widget

oldVal string No

Previous value of the colorpicker widget

Returns : void
onClick
onClick($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget is clicked.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void
onFocus
onFocus($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget gets focused.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse enters the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse leaves the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void
onTap
onTap($event: TouchEvent, widget: any)

Callback function which will be triggered when the tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered

widget any No

Instance of the colorpicker widget

Returns : void

Inputs

class

Class of the widget.

Type : string

datavalue

Value of the colorpicker widget. Accepts the value from a studio variable or from another widget's value.

Bindable: true

Type : string

disabled

This property will be used to disable/enable the colorpicker widget on the web page.

Bindable: true

Type : boolean

name

Name of the colorpicker widget.

Type : string

placeholder

Placeholder text for the widget.

Bindable: true

Type : string

Default value : 'Select Color'

readonly

This property will be used to make the colorpicker widget non-editable on the web page.

Bindable: true

Type : boolean

required

This property defines if the colorpicker is a required field while form submission.

Bindable: true

Type : boolean

shortcutkey

The shortcut key property specifies a shortcut key to activate/focus an element.

Type : string

show

This property will be used to show/hide the colorpicker widget on the web page.

Bindable: true

Type : boolean

Default value : true

tabindex

This property specifies the tab order of the Colorpicker Widget.

Type : number

Default value : 0

result-matching ""

    No results matching ""