File

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

Description

The wmCurrency component defines the currency 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 currency widget

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

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

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the currency widget

newVal number No

New value of the currency widget

oldVal number No

Previous value of the currency 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 currency 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 currency 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 currency 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 currency 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 currency widget

Returns : void

Inputs

class
Type : string

Class of the widget.

currency
Type : string
Default value : 'USD'

Currency symbol to be shown in the currency.

Allowed Values: Standard currencies like USD, INR, GBP etc

datavalue
Type : string

Value to be shown in the currency.

Bindable: true

disabled
Type : boolean

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

Bindable: true

hint
Type : string

Hint text is shown for the currency widget on hover.

Bindable: true

maxvalue
Type : number

Maximum value for currency.

Bindable: true

minvalue
Type : number

Minimum value for currency.

Bindable: true

name
Type : string

Name of the currency widget.

placeholder
Type : string
Default value : 'Enter value'

Placeholder text for the widget.

Bindable: true

readonly
Type : boolean

This property will be used to make the currency widget non-editable on the web page.

Bindable: true

required
Type : boolean

This property defines if the currency is a required field while form submission.

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

Bindable: true

step
Type : number

This property will be used to increment/decrement the currency value by the specified step interval.

tabindex
Type : number
Default value : 0

This property specifies the tab order of the Currency Widget.

result-matching ""

    No results matching ""