DateTimePickerProps
Represents the props of the KendoReact DateTimePicker component.
Definition
Package:@progress/kendo-react-dateinputs
Properties
adaptive?
boolean
Enable adaptive popup rendering based on viewport width.
false
adaptiveSubtitle?
string
Set the subtitle text in the adaptive popup (action sheet). Use only when adaptive is true.
adaptiveTitle?
string
Set the title text in the adaptive popup (action sheet). Use only when adaptive is true.
If not set, it matches the label.
allowCaretMode?
boolean
Determines if the users should see a blinking caret inside the Date Input when possible.
false
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.
autoCorrectParts?
boolean
Determines whether to autocorrect invalid segments automatically.
true
autoFill?
boolean
Autofill missing date or time parts with the current date/time on blur.
false
autoFocus?
boolean
Apply the autoFocus attribute to the internal input.
false
autoSwitchKeys?
string[]
A string array representing custom keys, which will move the focus to the next date format segment.
[]
autoSwitchParts?
boolean
Determines whether to automatically move to the next segment after the user completes the current one.
true
calendar?
ComponentType<CalendarProps<any>>
Enables the customization or the override of the default Calendar which is rendered by the DateTimePicker (see example).
cancelButton?
boolean
Determines whether to display the Cancel button in the popup.
className?
string
Sets the className of the DateTimePicker.
dateInput?
ComponentType<DateInputProps<any>>
Enables the customization or the override of the default DateInput which is rendered by the DateTimePicker (see example).
defaultShow?
boolean
Sets if the calendar popup is opened upon initial render. For more information, refer to the article on uncontrolled components in React.
defaultValue?
null | Date
Set the initial value when uncontrolled (see example).
See also uncontrolled components.
disabled?
boolean
Determines whether the DateTimePicker is disabled (see example).
enableMouseWheel?
boolean
Enable mouse wheel to increment or decrement segments.
true
fillMode?
"solid" | "flat" | "outline"
Control the fillMode (background) of the DateTimePicker.
The available options are:
- solid
- outline
- flat
undefined (theme-controlled)
focusedDate?
Date
Specifies the initial focusedDate of the Calendar inside the DateTimePicker (see example).
format?
string | DateFormatOptions
Specifies the date format that is used to display the input value (see example).
Defines the descriptions of the format sections in the input field (more information and examples).
id?
string
Specifies the id of the DateTimePicker.
inputAttributes?
InputHTMLAttributes<HTMLInputElement>
Pass HTML attributes to the internal focusable input. Attributes required for core logic are ignored.
label?
ReactNode
Renders a floating label for the DateTimePicker.
max?
Date
Specifies the greatest valid date (see example).
maxTime?
Date
Specifies the greatest valid time within the day (see example).
min?
Date
Specifies the smallest valid date (see example).
minTime?
Date
Specifies the smallest valid time within the day (see example).
name?
string
Specifies the name property of the input DOM element.
onBlur?
(event: FocusEvent<HTMLDivElement | HTMLSpanElement, Element>) => void
Fires each time any of the DateTimePicker elements gets blurred.
onChange?
(event: DateTimePickerChangeEvent) => void
Fires when the user selects a new value (see example).
onClose?
(event: DateTimePickerCloseEvent) => void
Fires when the popup closes.
onFocus?
(event: FocusEvent<HTMLDivElement | HTMLSpanElement, Element>) => void
Fires each time the user focuses any of the DateTimePicker elements.
onOpen?
(event: DateTimePickerOpenEvent) => void
Fires when the popup opens.
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?
ComponentType<PopupProps>
Enables the customization or the override of the default Popup which is rendered by the DateTimePicker (see example).
required?
boolean
Specifies if null is a valid value for the component.
This property is part of the FormComponentProps interface.
rounded?
"small" | "medium" | "large" | "full" | "none"
Control the corner rounded style of the DateTimePicker.
The available options are:
- small
- medium
- large
- full
- none
undefined (theme-controlled)
show?
boolean
Specifies if the popup will be displayed (see example).
size?
"small" | "medium" | "large"
Control the size of the DateTimePicker.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
Specifies the incremental steps of the DateInput and the internal TimePart (see examples).
The available options are:
year: Number—Controls the incremental step of the year value.month: Number—Controls the incremental step of the month value.day: Number—Controls the incremental step of the day value.hour: Number—Controls the incremental step of the hour value.minute: Number—Controls the incremental step of the minute value.second: Number—Controls the incremental step of the second value.
tabIndex?
number
Sets the tabIndex property of the DateTimePicker.
title?
string
Sets the title of the input element of the DateTimePicker.
twoDigitYearMax?
number
Set the upper threshold for interpreting a two-digit year as part of the current century (see example).
Values smaller than (twoDigitYearMax + 1) map to 20xx. Larger map to 19xx.
68
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
Set the current value (see example).
Provide a valid Date or null.
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.
weekNumber?
boolean
Determines whether to display a week number column of the Calendar inside the DateTimePicker (see example).
width?
string | number
Specifies the width of the DateTimePicker.