DateInputProps
Represents the props of the KendoReact DateInput component. The generic argument is passed to the onChange property and is used as a target in the DateInputChangeEvent interface.
Definition
Package:@progress/kendo-react-dateinputs
Properties
allowCaretMode?
boolean
Determines if the users should see a blinking caret inside the Date Input when possible.
false
ariaControls?
string
Reference the id of the element that the DateInput controls via ARIA.
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.
ariaExpanded?
boolean
Indicate whether the popup content is expanded.
ariaHasPopup?
boolean | "grid" | "dialog"
Define the interactive popup type for assistive tech.
Use grid (default) or dialog based on context.
grid
ariaLabel?
string
The accessible label of the component.
ariaLabelledBy?
string
Identifies the element(s) which will label the component.
ariaRole?
string
Set the ARIA role of the DateInput root element.
autoCorrectParts?
boolean
Determines whether to autocorrect invalid segments automatically.
true
autoFill?
boolean
Autofill missing parts with the current date 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
className?
string
Set a custom CSS class on the DateInput DOM element.
clearButton?
boolean
Show a clear button that sets value to null and fires onChange.
defaultValue?
null | Date
Set the initial value when the component is uncontrolled.
If value is not set, the component uses this as its starting value.
dir?
string
Represents the dir HTML attribute.
disabled?
boolean
Determines whether the DateInput is disabled (see example).
enableMouseWheel?
boolean
Indicates whether the mouse scroll can be used to increase/decrease the date segments values.
true
fillMode?
"solid" | "flat" | "outline"
Control the fillMode (background) of the DateInput.
The available options are:
- solid
- outline
- flat
undefined (theme-controlled)
format?
string | DateFormatOptions
Specifies the date format which is used for formatting the value (see example). If not set, the default format will be used.
Specifies the descriptions of the format sections in the input field (more information and example).
id?
string
Sets the id of the input DOM element.
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 DateInput.
max?
Date
Specifies the greatest date that is valid (see example).
maxTime?
Date
Specifies the greatest time that is valid (see example).
min?
Date
Specifies the smallest date that is valid (see example).
minTime?
Date
Specifies the smallest time that is valid (see example).
name?
string
Specifies the name property of the input DOM element.
This property is part of the FormComponentProps interface.
onChange?
(event: DateInputChangeEvent<T>) => void
Fires when the user edits the value (see example).
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.
readonly?
boolean
Put the component in read-only mode.
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 DateInput.
The available options are:
- small
- medium
- large
- full
- none
undefined (theme-controlled)
size?
"small" | "medium" | "large"
Control the size of the DateInput.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
spinners?
boolean
Specifies whether the Up and Down spin buttons will be rendered (see example).
Specifies the incremental steps of the DateInput (see example).
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 DateInput.
title?
string
Sets the title of the input element of the DateInput.
twoDigitYearMax?
number
The maximum year to assume to be from the current century when typing two-digit year value (see example). The default value of 68, indicating that typing any value less than 69 will be assumed to be 20xx, while 69 and larger will be assumed to be 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 value of the DateInput.
width?
string | number
Specifies the width of the DateInput.