• What is KendoReact
  • Getting Started
  • Server Components
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Chartsupdated
    • Common Utilities
    • Conversational UIupdated
    • Data Gridupdated
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdownsupdated
    • Editor
    • Excel Export
    • File Saver
    • Formupdated
    • Ganttupdated
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
    • ListBox
    • ListView
    • Map
    • Notification
    • OrgChartnew
    • PDF Processing
    • PDFViewer
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • Spreadsheetupdated
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeViewupdated
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting

DatePickerProps

Represents the props of the KendoReact DatePicker component.

NameTypeDefaultDescription

adaptive?

boolean

Providing different rendering of the popup element based on the screen dimensions.

adaptiveTitle?

string

Specifies the text that is rendered as title in the adaptive popup.

ariaDescribedBy?

string

Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.

ariaLabel?

string

The accessible label of the component.

ariaLabelledBy?

string

Identifies the element(s) which will label the component.

calendar?

ComponentType<CalendarProps<any>> | ComponentType<MultiViewCalendarProps<any>>

Enables the customization or the override of the default Calendar which is rendered by the DatePicker (see example).

className?

string

Sets the className of the DatePicker.

dateInput?

React.ComponentType<DateInputProps<any>>

Enables the customization or the override of the default DateInput which is rendered by the DatePicker (see example).

defaultShow?

boolean

Sets the default state of the DatePicker upon render (see example).

defaultValue?

"null" | Date

Sets the default value of the DatePicker (see example).

disabled?

boolean

Determines whether the DatePicker is disabled (see example).

fillMode?

"null" | "flat" | "solid" | "outline"

solid

Configures the fillMode of the DatePicker.

The available options are:

  • solid
  • outline
  • flat
  • null—Does not set a fillMode className.

focusedDate?

Date

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

format?

string | DateFormatOptions

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

formatPlaceholder?

DateInputFormatPlaceholder

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

id?

string

Specifies the id of the DatePicker.

label?

string

Renders a floating label for the DatePicker.

max?

Date

Specifies the greatest valid date (see example).

min?

Date

Specifies the smallest valid date (see example).

name?

string

Specifies the name property of the input DOM element.

onBlur?

(event: FocusEvent<undefined>) => void

Fires each time any of the DatePicker elements gets blurred.

onChange?

(event: DatePickerChangeEvent) => void

Fires each time the user selects a new value (see example).

onClose?

(event: DatePickerCloseEvent) => void

Fires each time the popup is closed.

onFocus?

(event: FocusEvent<undefined>) => void

Fires each time the user focuses any of the DatePicker elements.

onOpen?

(event: DatePickerOpenEvent) => void

Fires each time the popup is opened.

pickerWrap?

React.ComponentType<PickerWrapProps>

placeholder?

"null" | string

Specifies the hint the DateInput displays when its value is null or there is no partial selection. For more information, refer to the article on placeholders.

popup?

React.ComponentType<PopupProps>

Enables the customization or the override of the default Popup which is rendered by the DatePicker (see example).

popupSettings?

DateInputsPopupSettings

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: — Defines the container to which the Popup will be appended. Defaults to body.
  • popupClass: String—Specifies a list of CSS classes that are used to style the popup.

required?

boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

rounded?

"null" | "small" | "large" | "medium" | "full"

medium

Configures the roundness of the DatePicker.

The available options are:

  • small
  • medium
  • large
  • full
  • null—Does not set a rounded className.

show?

boolean

Specifies if the calendar will be displayed (see example).

size?

"null" | "small" | "large" | "medium"

medium

Configures the size of the DatePicker.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

tabIndex?

number

Sets the tabIndex property of the DatePicker.

title?

string

Sets the title of the input element of the DatePicker.

toggleButton?

React.ComponentType<ToggleButtonProps>

Enables the customization or the override of the default Toggle button which is rendered by the DatePicker (see example).

valid?

boolean

Overrides the validity state of the component. If valid is set, the required property will be ignored.

This property is part of the FormComponentProps interface.

validationMessage?

string

Controls the form error message of the component. If set to an empty string, no error will be thrown.

This property is part of the FormComponentProps interface.

validityStyles?

boolean

If set to false, no visual representation of the invalid state of the component will be applied.

This property is part of the FormComponentProps interface.

value?

"null" | Date

Specifies the value of the DatePicker (see example).

The value has to be a valid JavaScript Date instance.

weekNumber?

boolean

Determines whether to display a week number column in the month view of the Calendar (see example).

width?

string | number

Specifies the width of the DatePicker.