WaveMaker - Widgets API Documentation
  1. Classes
  2. Button

File

projects/components/widgets/input/default/src/button/button.component.doc.ts

Description

The wmButton component defines the button 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 button 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 button 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 button widget
Returns : void
onDoubletap
onDoubletap($event: TouchEvent, widget: any)

Callback function which will be triggered when the double tap event occurs on button widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the button 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 button 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 button 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 button 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 button 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 button 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 button widget
Returns : void
onTap
onTap($event: TouchEvent, widget: any)

Callback function which will be triggered when the tap event occurs on button widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the button widget
Returns : void

Inputs

badgevalue
Type : string

This property specifies the value to be displayed along with the label of the button.

Bindable: true
caption
Type : string

This property specifies the label of the button.

Bindable: true
class
Type : string
Default value : 'btn-default'

Class of the widget.
conditionalclass
Type : string

This property allows user to bind expression to class property.

Bindable: true
disabled
Type : boolean

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

Bindable: true
hint
Type : string

Hint text is shown for the button widget on hover.

Bindable: true
iconclass
Type : string

CSS class of the icon.
iconheight
Type : string

height of the icon.
iconmargin
Type : string

margin of the icon.
iconposition
Type : string

Property to set the position of icon in the widget.

Allowed Values: left, top, right

left: Positions icon to the left.

top: Positions icon on the top.

right: Positions icon to the right.
iconurl
Type : string

url of the icon.
iconwidth
Type : string

width of the icon.
name
Type : string

Name of the button widget.
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 button widget on the web page.

Bindable: true
tabindex
Type : number
Default value : 0

This property specifies the tab order of the Button Widget.
type
Type : string

Type of the button widget.

Allowed Values: button, submit, reset

button: Just a button.

reset: Resets data in the current form.

submit: Submits the current form data.

results matching ""

    No results matching ""