WaveMaker - Widgets API Documentation
  1. Classes
  2. Date

File

projects/components/widgets/input/epoch/date/src/date.component.doc.ts

Description

The wmDate component defines the date 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 date widget
Returns : void
onChange
onChange($event: MouseEvent, widget: any, newVal: string, oldVal: string)

Callback function which will be triggered when the widget value changes.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the date widget
newVal string No

New value of the widget
oldVal string No

Old value of the widget
Returns : void
onClick
onClick($event: MouseEvent, widget: any)

Callback function which will be triggered when the widget is clicked. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the date 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 date widget
Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse enters the widget. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the date widget
Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse leaves the widget. This is not available in mobile.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the date 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 date widget
Returns : void

Inputs

autofocus
Type : boolean
Default value : false

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

datavalue
Type : string

This property defines the value of the date widget.

Bindable: true
datepattern
Type : string
Default value : 'yyyy-MM-dd'

This property is used to set the display pattern of the date widget. This is not available in mobile.

Allowed Values: Standard Patterns like 'MM-dd-yy', 'yyyy-MM-dd', 'mm/dd/yyyy', etc.

disabled
Type : boolean
Default value : false

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

Bindable: true
excludedates
Type : string

This property specifies the dates which are to be excluded. This is not available in mobile.

Bindable: true
excludedays
Type : string

This property specifies the days which are to be excluded. This is not available in mobile.

Allowed Values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

hint
Type : string

Hint text is shown for the date widget on hover. This is not available in mobile.

Bindable: true
maxdate
Type : string

This property is used to specify the maximum date to end with.

Bindable: true
mindate
Type : string

This property is used to specify the minimum date to start with.

Bindable: true
name
Type : string

Name of the date widget.
outputformat
Type : string
Default value : 'yyyy-MM-dd'

This property is used to set the output format of the date widget.

Allowed Values: Standard Patterns like 'MM-dd-yy', 'yyyy-MM-dd', 'mm/dd/yyyy', etc.

placeholder
Type : string
Default value : 'Select Date'

Placeholder for the date field.

Bindable: true
readonly
Type : boolean
Default value : false

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

Bindable: true
required
Type : boolean
Default value : false

If the required property is set to true, required class is applied to the label[an asterik will be displayed next to the content of the label'].

Bindable: true
shortcutkey
Type : string

The shortcut key property specifies a shortcut key to activate/focus an element. This is not available in mobile.
show
Type : boolean
Default value : true

This property will be used to show/hide the date widget on the web page.

Bindable: true
showbuttonbar
Type : boolean
Default value : true

This property, when set, displays button bar in date-picker UI.

Bindable: true
showweeks
Type : boolean
Default value : false

This property, when set, displays week number in date-picker UI. This is not available in mobile.
tabindex
Type : number
Default value : 0

This property specifies the tab order of the date Widget. This is not available in mobile.

results matching ""

    No results matching ""