New to KendoReactLearn about KendoReact Free.

DateTimePickerProps

Represents the props of the KendoReact DateTimePicker component.

NameTypeDefaultDescription

adaptive?

boolean

false

Enable adaptive popup rendering based on viewport width.

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

false

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

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.

ariaLabelledBy?

string

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

autoCorrectParts?

boolean

true

Determines whether to autocorrect invalid segments automatically.

autoFill?

boolean

false

Autofill missing date or time parts with the current date/time on blur.

autoFocus?

boolean

false

Apply the autoFocus attribute to the internal input.

autoSwitchKeys?

string[]

[]

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

autoSwitchParts?

boolean

true

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

calendar?

React.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?

React.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

true

Enable mouse wheel to increment or decrement segments.

fillMode?

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

solid

Control the fillMode (background) of the DateTimePicker.

The available options are:

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

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).

formatPlaceholder?

DateInputFormatPlaceholder

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

id?

string

Specifies the id of the DateTimePicker.

inputAttributes?

React.InputHTMLAttributes<HTMLInputElement>

Pass HTML attributes to the internal focusable input. Attributes required for core logic are ignored.

label?

React.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>) => 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>) => 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.

React.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?

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

medium

Control the corner rounded style of the DateTimePicker.

The available options are:

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

show?

boolean

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

size?

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

medium

/**

  • Control the size of the DateTimePicker.
  • The available options are:
    • small
    • medium
    • large
    • null—Does not set a size className.

steps?

DateInputIncrementalSteps

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

68

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.

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.

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.

Not finding the help you need?
Contact Support