File

projects/components/src/widgets/common/textarea/textarea.component.doc.ts

Description

The wmTextarea component defines the textarea widget.

Index

Methods
Inputs

Methods

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

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

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered

widget any No

Instance of the textarea widget

Returns : void
onChange
onChange($event: Event, widget: any, newVal: string | number, oldVal: string | number)

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

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered

widget any No

Instance of the textarea widget

newVal string | number No

datavalue of the textarea widget

oldVal string | number No

previously selected datavalue of the textarea 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 textarea widget

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

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

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered

widget any No

Instance of the textarea 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 textarea 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 textarea 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 textarea 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 textarea 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 textarea 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 textarea widget

Returns : void

Inputs

autofocus

This property makes the widget get focused automatically when the page loads.

Type : boolean

class

Class of the widget.

Type : string

Default value : 'btn-default'

datavalue

Value of the textarea widget.

Bindable: true

Type : string

disabled

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

Bindable: true

Type : boolean

hint

Hint text is shown for the textarea widget on hover.

Bindable: true

Type : string

maxchars

Maximum number of characters that are allowed in the widget.

Type : number

name

Name of the textarea widget.

Type : string

placeholder

Placeholder for the textarea.

Type : string

readonly

This property doesnot allow to change the value in the textarea widget.

Bindable: false

Type : boolean

Default value : false

required

This property will be used to make the textarea widget readonly on the web page.

Bindable: false

Type : boolean

Default value : false

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

Bindable: true

Type : boolean

Default value : true

tabindex

This property specifies the tab order of the textarea Widget.

Type : number

Default value : 0

updateon

Updates the textarea value based on the event type.

Event Types: blur, keypress

blur: datavalue will be updated on blur event.

keypress: datavalue will be updated on keypress.

Type : string

Default value : 'blur'

result-matching ""

    No results matching ""