WaveMaker - Widgets API Documentation
  1. Classes
  2. Switch

File

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

Description

The wmSwitch component defines the switch widget.

Index

Methods
Inputs

Methods

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

Callback function which will be triggered when the widget is clicked or 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 switch widget
newVal any No

datavalue of the switch widget
oldVal any No

previously selected datavalue of the switch 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 switch 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 switch 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 switch 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 switch widget
Returns : void

Inputs

checkediconclass
Type : string

CSS class of the checked item.
class
Type : string

Class of the widget.
datafield
Type : string

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

dataset
Type : Array<any> | Object
Default value : 'yes, no, maybe'

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

Bindable: true
datavalue
Type : any
Default value : 'yes'

This property defines the initial selected value of the switch widget.

Bindable: true
disabled
Type : boolean

This property will be used to disable the switch 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 switch options. 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 switch widget when the list is populated using the dataSet property.

hint
Type : string

Hint text is shown for the switch widget on hover.

Bindable: true
iconclass
Type : string

CSS class of the icon.
name
Type : string

Name of the switch widget.
orderby
Type : string

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

required
Type : boolean

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

Bindable: true
show
Type : boolean
Default value : true

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

Bindable: true
tabindex
Type : number
Default value : 0

This property specifies the tab order of the switch widget.

results matching ""

    No results matching ""