DateRangePickerProps
Represents the props of the KendoReact DateRangePicker 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.
allowReverse?
boolean
If allowReverse is set to true, the component skips the validation of whether the from value is after the to value (see example).
If the
calendarSettingsproperty is set, itsallowReversewill take precedence.
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.
autoFocus?
boolean
Apply the autoFocus attribute to the first input.
false
calendar?
ComponentType<MultiViewCalendarProps<any>>
Enables the customization or the override of the default Calendar which is rendered by the DateRangePicker.
Represents the additional props that can be passed to the MultiViewCalendar inside the DateRangePicker (see example).
className?
string
Sets the className of the DateRangePicker.
clearButton?
boolean
Show a clear button for start and end inputs. Clicking resets the range and fires onChange.
defaultShow?
boolean
Sets the default state of the DateRangePicker upon render (see example).
Set the initial value when uncontrolled (see example).
disabled?
boolean
Determines whether the DateRangePicker is disabled (see example).
endDateInput?
ComponentType<DateInputProps<any>>
Enables the customization or the override of the default end DateInput which is rendered by the DateRangePicker (see example).
Represents the additional props that can be passed to the end-date DateInput inside the DateRangePicker (see example).
focusedDate?
Date
Specifies the focused date of the DateRangePicker (see example).
format?
string | DateFormatOptions
Specifies the date format which is used for formatting the value of the DateInput (see example).
If
startDateInputSettingsorendDateInputSettingsare set, theirformatwill take precedence.
id?
string
Specifies the id of the DateRangePicker.
inputAttributes?
InputHTMLAttributes<HTMLInputElement>
Pass HTML attributes to the internal focusable input elements. Attributes required for core logic are ignored.
max?
Date
Specifies the greatest valid date (see example).
min?
Date
Specifies the smallest valid date (see example).
onBlur?
(event: FocusEvent<any, Element>) => void
Fires each time any of the DateRangePicker elements gets blurred.
onCancel?
(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
Fires when the popup is about to cancel in (adaptive mode).
onChange?
(event: DateRangePickerChangeEvent) => void
Fires when the user changes part of the range (see example).
onClose?
(event: DateRangePickerCloseEvent) => void
Fires when the popup closes.
onFocus?
(event: FocusEvent<any, Element>) => void
Fires each time the user focuses any of the DateRangePicker elements.
onOpen?
(event: DateRangePickerOpenEvent) => void
Fires when the popup opens.
popup?
ComponentType<PopupProps>
Enables the customization or the override of the default Popup which is rendered by the DateRangePicker (see example).
Represents the additional props that will be passed to the Popup inside the DateRangePicker (see example).
show?
boolean
Specifies if the calendar will be displayed (see example).
startDateInput?
ComponentType<DateInputProps<any>>
Enables the customization or the override of the default start DateInput which is rendered by the DateRangePicker (see example).
Represents the additional props that will be passed to the start-date DateInput inside the DateRangePicker (see example).
style?
CSSProperties
Specifies the additional styles that will be applied to the wrapping DateRangePicker element.
swapButton?
boolean
Determines whether the DateRangePicker will display a Swap Value button (see example).
The DateRangePicker will display the swap button only if the
allowReverseproperty is also set totrue.
tabIndex?
number
Sets the tabIndex property of the DatePicker.
valid?
boolean
Override the validity state.
If valid is set, ignore required.
Part of FormComponentProps.
Set the selected range (see example).
Provide start and end valid Date values or null.
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.