WaveMaker - Widgets API Documentation
  1. Classes
  2. Select

File

projects/components/widgets/input/select/src/select.component.doc.ts

Description

The wmSelect component defines the select 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 select widget
Returns : void
onChange
onChange($event: MouseEvent, widget: any, newVal: any, oldVal: any)

Callback function which will be triggered when the widget is clicked or when datavalue has changed.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the select widget
newVal any No

datavalue of the select widget
oldVal any No

previously selected datavalue of the select 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 select widget
Returns : void
onDblclick
onDblclick($event: MouseEvent, widget: any)

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

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the select 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 select widget
Returns : void
onKeydown
onKeydown($event: KeyboardEvent, widget: any)

Callback function which will be triggered whenever a key is pressed down.

Parameters :
Name Type Optional Description
$event KeyboardEvent No

DOM event on which call back is triggered
widget any No

Instance of the select widget
Returns : void
onKeypress
onKeypress($event: KeyboardEvent, widget: any)

Callback function which will be triggered whenever a key is pressed.

Parameters :
Name Type Optional Description
$event KeyboardEvent No

DOM event on which call back is triggered
widget any No

Instance of the select widget
Returns : void
onKeyup
onKeyup($event: KeyboardEvent, widget: any)

Callback function which will be triggered whenever a key is released.

Parameters :
Name Type Optional Description
$event KeyboardEvent No

DOM event on which call back is triggered
widget any No

Instance of the select widget
Returns : void

This method does not return anything
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 select 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 select 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 select widget
Returns : void

Inputs

autofocus
Type : boolean

This property makes the element get focused automatically when the page loads.
class
Type : string

Class of the widget.
datafield
Type : string

This property sets the dataValue to be returned by the select widget when the list is populated using the dataSet property.

dataset
Type : Array<any> | Object

This property accepts the options to create the select widget. These options can be array of values, array of objects, object containing key-value pairs.

Bindable: true
datavalue
Type : any

This property defines the initial selected value of the select widget.
Only when multiple is set to true, datavalue accepts array of values.

Bindable: true
disabled
Type : boolean

This property will be used to disable the select widget. If the disabled property is true (checked), the widget becomes display-only.

Bindable: true
displayexpression
Type : string

This is an advanced property that gives more control over what is displayed in the drop-down select list. A Display Expression uses a JavaScript expression to format exactly what is shown

Bindable: true
displayfield
Type : string

This property sets the displayValue to show in the select widget when the list is populated using the dataSet property.

hint
Type : string

Hint text is shown of the select widget on hover.

Bindable: true
multiple
Type : boolean

When this value is set to true multiple options can be selected from select widget.

name
Type : string

Name of the select widget.
orderby
Type : string

Allows to display the data in asc or desc order based on this property

placeholder
Type : string

This property specifies the placeholder for the select.

Bindable: true
readonly
Type : boolean

This property will be used to make the select widget non-editable.

Bindable: true
required
Type : boolean

This property will be used to validate the state of the select widget when used inside a form widget.

Bindable: true
shortcutkey
Type : string

The shortcut key property specifies a shortcut key to activate/focus an element.
show
Type : boolean
Default value : true

This property will be used to show/hide the select widget.

Bindable: true
tabindex
Type : number
Default value : 0

This property specifies the tab order of the select widget.

results matching ""

    No results matching ""