New to Kendo UI for Angular? Start a free 30-day trial

DatePickerComponent

Component

Represents the Kendo UI DatePicker component for Angular. Provides a user-friendly way to select dates with a calendar popup (see example).

Definition

Package:@progress/kendo-angular-dateinputs

Selector:kendo-datepicker

Export Name:Accessible in templates as #kendo-datepickerInstance="kendo-datepicker"

Syntax:

@Component({
  selector: 'my-app',
  template: `
    <kendo-datepicker
      [value]="selectedDate"
    </kendo-datepicker>
  `
})
export class AppComponent {
  selectedDate = new Date();
}

Inputs

activeView

CalendarView

Specifies the active view that the Calendar initially renders (see example).

You have to set activeView within the topView-bottomView range.

adaptiveMode

AdaptiveMode

Specifies whether to enable adaptive rendering. When enabled, the DatePicker automatically switches between a calendar popup on larger screens and an ActionSheet on mobile devices.

Default:

'none'

adaptiveSubtitle

string

Sets the subtitle text rendered in the header of the popup(action sheet). Applicable only when AdaptiveMode is set to auto.

Default:

adaptiveTitle

string

Sets the title of the input element of the DatePicker and the title text rendered in the header of the popup(action sheet). Applicable only when AdaptiveMode is set to auto.

Default:

allowCaretMode

boolean

Determines if the users should see a blinking caret inside the Date Input when possible.

Default:

false

animateCalendarNavigation

boolean

Determines whether to enable animation when navigating to previous/next Calendar view. Applies to the classic Calendar only.

This feature uses the Web Animations API. In order to run the animation in browsers that do not support it, you need the web-animations-js polyfill.

Default:

false

autoCorrectParts

boolean

Determines whether to autocorrect invalid segments automatically.

Default:

true

autoFill

boolean

When enabled, the DatePicker will autofill the rest of the date to the current date when the component loses focus.

Default:

false

autoSwitchKeys

string[]

A string array representing custom keys, which will move the focus to the next date format segment.

Default:

[]

autoSwitchParts

boolean

Determines whether to automatically move to the next segment after the user completes the current one.

Default:

true

bottomView

CalendarView

Specifies the bottommost Calendar view to which you can navigate (see example).

calendarType

CalendarType

Specifies the Calendar type.

Default:

'infinite'

clearButton

boolean

Renders a clear button when set to true after the input text or DatePicker value changes. Click this button to reset the component value to null and trigger the valueChange event.

Default:

false

Specifies or gets the disabled property of the DatePicker and determines whether the component is active (see example). To learn how to disable the component in reactive forms, refer to the article on Forms Support.

Default:

false

disabledDates

Date[] | Day[] | (date: Date) => boolean

Sets the dates of the DatePicker that will be disabled (see example).

disabledDatesValidation

boolean

Determines whether the built-in validator for disabled date ranges is enforced when validating a form (see example).

Default:

true

enableMouseWheel

boolean

Indicates whether the mouse scroll can be used to increase/decrease the time segments values.

Default:

true

fillMode

DateInputFillMode

Specifies the fillMode of the component. The default value is set by the Kendo theme.

focusedDate

Date

Specifies the focused date of the Calendar component (see example).

Default:

null

boolean

Controls the visibility of the Calendar footer.

Default:

false

format

string | FormatSettings

Specifies the date format that is used to display the input value (see example).

Format value options include string to provide a single format that is used regardless whether the input is focused or blurred. FormatSettings can be used to display different formats when the component is focused or blurred by providing a settings object with specified inputFormat and displayFormat values.

Default:

DEFAULT_FORMAT

formatPlaceholder

DateInputFormatPlaceholder

Defines the descriptions of the format sections in the input field. (more information and examples).

incompleteDateValidation

boolean

Determines whether the built-in validation for incomplete dates is to be enforced when a form is being validated.

Default:

false

inputAttributes

{ [key: string]: string }

Specifies the HTML attributes of the inner focusable input element. You cannot change attributes that are essential for certain component functionalities.

max

Date

Specifies the biggest valid date (see example).

min

Date

Specifies the smallest valid date (see example).

boolean

Sets or gets the navigation property of the Calendar and determines whether the navigation side-bar is displayed. (see example).

placeholder

string

Specifies the hint the DatePicker displays when its value is null. (more information and exaples).

popupSettings

PopupSettings

Configures the popup options of the DatePicker.

The available options are animate which controls the popup animation and by default, the open and close animations are enabled. The appendTo option controls the popup container and by default, the popup will be appended to the root component. The popupClass option specifies a list of CSS classes that are used to style the popup.

rangeValidation

boolean

Determines whether the built-in min or max validators are enforced when validating a form.

Default:

true

readonly

boolean

Specifies the read-only state of the DatePicker (see example).

Default:

false

readOnlyInput

boolean

Sets the read-only state of the DatePicker input field (see example).

If you set the readonly property value to true, the input will be rendered in a read-only state regardless of the readOnlyInput value.

Default:

false

rounded

DateInputRounded

Specifies the border radius of the component. The default value is set by the Kendo theme.

showOtherMonthDays

boolean

Shows the days that fall outside the current month in the Calendar (see example). The default value is false for infinite Calendar type and true for classic Calendar type.

size

DateInputSize

Sets the size of the component. The default value is set by the Kendo theme.

tabindex

number

Sets the tabindex of the DatePicker. This property is used to set the order in which the DatePicker will receive focus when navigating through the page using the Tab key.

Default: