Skip to content

Latest commit

 

History

History
127 lines (69 loc) · 6.14 KB

DateTimePicker.md

File metadata and controls

127 lines (69 loc) · 6.14 KB
title description api_reference slug
DateTimePicker API
API Index | DateTimePicker
true
api_datetimepickercomponent_wrapper

DateTimePicker

Directive

kendo-datetimepicker

Props

animation Boolean | Object

Configures the opening and closing animations of the calendar popup (animation in Kendo UI for jQuery). The supported composite props are available in [AnimationProps]({% slug api_datetimepicker_animationprops_wrapper %}).

Setting the animation option to false disables the opening and closing animations. As a result, the Calendar popup will open and close instantly.

aria-template String

Specifies a template for populating the value of the aria-label attribute (ARIATemplate in Kendo UI for jQuery).

culture String

Specifies the culture information that is used by the DateTimePicker (culture in Kendo UI for jQuery).

date-input Boolean

Specifies if the DateTimePicker will use a DateInput as an editor for its value (dateInput in Kendo UI for jQuery).

dates Array

Specifies a list of dates which will be passed to the month template (dates in Kendo UI for jQuery).

depth String

Specifies the navigation depth (depth in Kendo UI for jQuery).

The supported settings are:

  • month—Shows the days of the month.
  • year—Shows the months of the year.
  • decade—Shows the years of the decade.
  • century—Shows the decades from the century.

disable-dates Array | Function

An array or a function for determining which dates in the Calendar will be disabled (disableDates in Kendo UI for jQuery).

footer String

The template which renders the footer of the Calendar (footer in Kendo UI for jQuery). If footer is set to false, the footer will not be rendered.

format String

Specifies the format for formatting the value which is displayed by the DateTimePicker (format in Kendo UI for jQuery).

interval Number

Specifies the interval (in minutes) between the values in the popup list (interval in Kendo UI for jQuery).

max Date

Specifies the maximum date which the Calendar will show (max in Kendo UI for jQuery).

min Date

Specifies the minimum date which the Calendar will show (min in Kendo UI for jQuery).

month Object

Defines the templates for the cells that are rendered in the month view (month in Kendo UI for jQuery)). The supported composite props are available in [MonthProps]({% slug api_datetimepicker_monthprops_wrapper %}).

week-number Boolean

If week-number is set to true, a week of the year will be shown on the left side of the Calendar (weekNumber in Kendo UI for jQuery). To customize what the DateTimePicker displays, define a template.

parse-formats Array

Specifies a list of date formats for parsing the value which is set with the value() method or by a direct user input (parseFormats in Kendo UI for jQuery). If parse-formats is not set, the DateTimePicker will use options.format and options.timeFormat. The values of the format and the timeFormat (if set) options are always used during parsing.

start String

Specifies the start view (start in Kendo UI for jQuery).

The supported settings are:

  • month—Shows the days of the month.
  • year—Shows the months of the year.
  • decade—Shows the years of the decade.
  • century—Shows the decades from the century.

time-format String

Specifies the format which the DateTimePicker uses to format the values in the time drop-down list (timeFormat in Kendo UI for jQuery).

value Date

Specifies the selected value (value in Kendo UI for jQuery).

Events

change: Function

Fires when the underlying value of the DateTimePicker is changed (change in Kendo UI for jQuery).

close: Function

Fires when the Calendar or the time drop-down list is closed (close in Kendo UI for jQuery).

open: Function

Fires when the Calendar or the time drop-down list is opened (open in Kendo UI for jQuery).

Methods

For more details about the methods available in the component's API please check its Kendo UI for jQuery API documentation.

kendoWidget

returns

Returns the Kendo UI DateTimePicker instance.