Represents the Essential JS 2 VueJS DateTimePicker Component.
<ejs-datetimepicker v-bind:value='dateTime'></ejs-datetimepicker> boolean
Support for
allowEdithas been provided fromv16.2.46. Specifies whether the input textbox is editable or not. Here the user can select the value from the popup and cannot edit in the input textbox.
Defaults to true
string
Gets or sets the Calendar’s Type like gregorian or islamic.
Defaults to Gregorian
string
Specifies the root CSS class of the DatePicker that allows to customize the appearance by overriding the styles.
Defaults to null
string
Specifies the format of the day that to be displayed in header. By default, the format is ‘short’. Possible formats are:
Short - Sets the short format of day name (like Su ) in day header.Narrow - Sets the single character of day name (like S ) in day header.Abbreviated - Sets the min format of day name (like Sun ) in day header.Wide - Sets the long format of day name (like Sunday ) in day header.Defaults to Short
string
Sets the maximum level of view such as month, year, and decade in the Calendar. Depth view should be smaller than the start view to restrict its view navigation.
Defaults to Month
> For more details about depth refer to view Description Month Calendar view shows up to the days of the month. Year Calendar view shows up to the months of the year. Decade Calendar view shows up to the years of the decade. calendarViewdocumentation.
boolean
Enable or disable persisting component’s state between page reloads. If enabled, following list of states will be persisted.
Defaults to false
boolean
Enable or disable rendering component in right to left direction.
Defaults to false
boolean
Specifies the component to be disabled or not.
Defaults to true
number
Gets or sets the Calendar’s first day of the week. By default, the first day of the week will be based on the current culture.
Defaults to 0
FloatLabelType | string
Specifies the placeholder text to be floated. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.
Defaults to Syncfusion.EJ2.Inputs.FloatLabelType.Never
string | FormatObject
Specifies the format of the value that to be displayed in component. By default, the format is based on the culture.
Defaults to null
Object
You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value.
Defaults to {}
Object
Customizes the key actions in DateTimePicker. For example, when using German keyboard, the key actions can be customized using these shortcuts. Input Navigation
|
Key action |
Key |
|
altUpArrow |
alt+uparrow |
|
altDownArrow |
alt+downarrow |
|
escape |
escape |
Calendar Navigation (Use the following list of keys to navigate the currently focused Calendar after the popup has opened).
|
Key action |
Key |
|
controlUp |
ctrl+38 |
|
controlDown |
ctrl+40 |
|
moveDown |
downarrow |
|
moveUp |
uparrow |
|
moveLeft |
leftarrow |
|
moveRight |
rightarrow |
|
select |
enter |
|
home |
home |
|
end |
end |
|
pageUp |
pageup |
|
pageDown |
pagedown |
|
shiftPageUp |
shift+pageup |
|
shiftPageDown |
shift+pagedown |
|
controlHome |
ctrl+home |
|
controlEnd |
ctrl+end |
|
altUpArrow |
alt+uparrow |
|
spacebar |
space |
|
altRightArrow |
alt+rightarrow |
|
altLeftArrow |
alt+leftarrow |
TimePicker Navigation (Use the below list of shortcut keys to interact with the TimePicker after the TimePicker Popup has opened).
|
Key action |
Key |
|
down |
downarrow |
|
up |
uparrow |
|
left |
leftarrow |
|
right |
rightarrow |
Defaults to null
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ”
Date
Gets or sets the maximum date that can be selected in the Calendar.
Defaults to new Date(2099, 11, 31)
Date
Gets or sets the minimum date that can be selected in the Calendar.
Defaults to new Date(1900, 00, 01)
string
Specifies the placeholder text that to be is displayed in textbox.
Defaults to null
boolean
Specifies the component in readonly state. When the Component is readonly it does not allow user input.
Defaults to false
Date
Specifies the scroll bar position if there is no value is selected in the timepicker popup list or the given value is not present in the timepicker popup list.
Defaults to null
number
By default, the date value will be processed based on system time zone.
If you want to process the initial date value using server time zone
then specify the time zone value to serverTimezoneOffset property.
boolean
Specifies whether to show or hide the clear icon in textbox.
Defaults to true
boolean
Specifies whether the today button is to be displayed or not.
Defaults to true
string
Specifies the initial view of the Calendar when it is opened. With the help of this property, initial view can be changed to year or decade view.
Defaults to Month
> For more details about start refer toView Description Month Calendar view shows the days of the month. Year Calendar view shows the months of the year. Decade Calendar view shows the years of the decade. calendarViewdocumentation.
number
Specifies the time interval between the two adjacent time values in the time popup list .
Defaults to 30
boolean
Specifies the component to act as strict. So that, it allows to enter only a valid date and time value within a specified range or else it will resets to previous value. By default, strictMode is in false. it allows invalid or out-of-range value with highlighted error class.
Defaults to false> For more details refer toStrict Mode documentation.
string
Specifies the format of the time value that to be displayed in time popup list.
Defaults to null
Date
Gets or sets the selected date of the Calendar.
Defaults to null
boolean
Determines whether the week number of the year is to be displayed in the calendar or not.
Defaults to false> For more details about weekNumber refer toCalendar with week numberdocumentation.
number | string
Specifies the width of the DatePicker component.
Defaults to null
number
specifies the z-index value of the popup element.
Defaults to 1000
This method is used to add the single or multiple dates to the values property of the Calendar.
| Parameter | Type | Description |
|---|---|---|
| dates | Date | Date[] |
Specifies the date or dates to be added to the values property of the Calendar. |
Returns void
Gets the current view of the DatePicker.
Returns string
To destroy the widget.
Returns void
Sets the focus to widget for interaction.
Returns void
Remove the focus from widget, if the widget is in focus state.
Returns void
Gets the properties to be maintained upon browser refresh.
Returns string
Navigates to specified month or year or decade view of the DatePicker.
| Parameter | Type | Description |
|---|---|---|
| view | string |
Specifies the view of the calendar. |
| date | Date |
Specifies the focused date in a view. |
Returns void
This method is used to remove the single or multiple dates from the values property of the Calendar.
| Parameter | Type | Description |
|---|---|---|
| dates | Date | Date[] |
Specifies the date or dates which need to be removed from the values property of the Calendar. |
Returns void
EmitType<Object>
Triggers when input loses the focus.
EmitType<ChangedEventArgs>
Triggers when the Calendar value is changed.
EmitType<Object>
Triggers when popup is closed.
EmitType<Object>
Triggers when DateTimePicker is created.
EmitType<Object>
Triggers when DateTimePicker is destroyed.
EmitType<Object>
Triggers when input gets focus.
EmitType<NavigatedEventArgs>
Triggers when the Calendar is navigated to another level or within the same level of view.
EmitType<Object>
Triggers when popup is opened.
EmitType<RenderDayCellEventArgs>
Triggers when each day cell of the Calendar is rendered.