File

projects/components/src/widgets/common/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

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

Bindable: true

Type : string

caption

This property specifies the label of the button.

Bindable: true

Type : string

class

Class of the widget.

Type : string

Default value : 'btn-default'

conditionalclass

This property allows user to bind expression to class property.

Bindable: true

Type : string

disabled

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

Bindable: true

Type : boolean

hint

Hint text is shown for the button widget on hover.

Bindable: true

Type : string

iconclass

CSS class of the icon.

Type : string

iconheight

height of the icon.

Type : string

iconmargin

margin of the icon.

Type : string

iconposition

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.

Type : string

iconurl

url of the icon.

Type : string

iconwidth

width of the icon.

Type : string

name

Name of the button widget.

Type : string

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

Bindable: true

Type : boolean

Default value : true

tabindex

This property specifies the tab order of the Button Widget.

Type : number

Default value : 0

type

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.

Type : string

result-matching ""

    No results matching ""