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

DatePicker

Component

Represents the Kendo UI for Vue DatePicker component. Use the DatePicker to let the user type a date or select it from a popup Calendar.

Definition

Package:@progress/kendo-vue-dateinputs

Properties Interface:DatePickerProps

Syntax:

vue
<DatePicker :default-value="new Date()" :format="'dd/MM/yyyy'" />

Properties

Sets the aria-label attribute of the DatePicker input.

Lets you customize or replace the default Calendar of the DatePicker (see example).

Lets you customize or replace the default DateInput of the DatePicker (see example).

Sets whether the popup of the DatePicker is open on the first render (see example).

Default:

false

Sets the initial value of the DatePicker when you do not set value (see example).

disabled?

boolean

When you set it to true, the DatePicker is disabled (see example).

Default:

false

fillMode?

string

Configures the fillMode of the DatePicker.

The available options are:

  • solid
  • outline
  • flat
  • link
  • null—Does not set a fillMode class.
Default:

solid

Sets the focused date of the DatePicker (see example).

format?

string | DateFormatOptions

Sets the date format that the DatePicker uses to show the input value (see example).

Default:

'd'

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

id?

string

Sets the id of the input element of the DatePicker. The floating label uses it to point to the input.

Sets the built-in HTML attributes of the inner focusable input element. You cannot change the attributes that the component needs to work.

label?

string

Renders a floating label for the DatePicker.

max?

Date

Sets the latest valid date (see example).

min?

Date

Sets the earliest valid date (see example).

name?

string

Sets the name property of the input DOM element.

onBlur?

(event: any) => void

Fires each time any element of the DatePicker loses focus. The event name is blur.

Parameters:eventany

Fires each time the user selects a new value. The event name is change (see example).

Parameters:eventDatePickerChangeEvent

onFocus?

(event: any) => void

Fires each time the user focuses any element of the DatePicker. The event name is focus.

Parameters:eventany

onIconclick?

(event: any) => void

Fires when the user clicks the calendar icon. The event name is iconclick.

Parameters:eventany

Lets you customize or replace the default wrapper around the DateInput and the ToggleButton of the DatePicker (see example).

Sets the placeholder text of the DatePicker.

Lets you customize or replace the default Popup of the DatePicker (see example).

Configures the popup options of the DatePicker.

The available options are:

  • animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled.
  • appendTo: — Sets the container to which the Popup is appended. Defaults to body.
  • popupClass: String—Sets a list of CSS classes that style the popup.
Default:

{}

required?

boolean

Sets whether null is a valid value for the component.

rounded?

string

Configures the roundness of the DatePicker.

The available options are:

  • small
  • medium
  • large
  • circle
  • full
  • null—Does not set a rounded class.
Default:

medium

show?

boolean

Sets whether the DatePicker shows the Calendar (see example).

size?

"small" | "medium" | "large"

Configures the size of the DatePicker.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size class.
Default:

medium

tabIndex?

number

Sets the tabIndex property of the DatePicker.

Default:

0

title?

string

Sets the title of the input element of the DatePicker.

Default:

''

Lets you customize or replace the default toggle button of the DatePicker (see example).

valid?

boolean

Overrides the validity state of the component. When you set valid, the component ignores the required property.

validate?

boolean

Sets whether the DatePicker validates its value.

Sets the form error message of the component. If you set it to an empty string, the component shows no error.

Shows or hides the invalid state styles of the component. When you set it to false, the component shows no invalid state styles.

value?

Date

Sets the value of the DatePicker (see example).

The value must be a valid JavaScript Date instance.

When you set it to true, the Calendar shows a week number column in the month view (see example).

width?

string | number

Sets the width of the DatePicker.