New to KendoReactStart a free 30-day trial

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.

Default:

false

Set the subtitle text in the adaptive popup (action sheet). Use only when adaptive is true.

Set the title text in the adaptive popup (action sheet). Use only when adaptive is true. If not set, it matches the label.

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 calendarSettings property is set, its allowReverse will take precedence.

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.

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

autoFocus?

boolean

Apply the autoFocus attribute to the first input.

Default:

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

Sets the className of the DateRangePicker.

Show a clear button for start and end inputs. Clicking resets the range and fires onChange.

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

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 startDateInputSettings or endDateInputSettings are set, their format will 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.

Parameters:eventFocusEvent​<any, Element>

onCancel?

(event: MouseEvent​<HTMLButtonElement, MouseEvent>) => void

Fires when the popup is about to cancel in (adaptive mode).

Parameters:eventMouseEvent​<HTMLButtonElement, MouseEvent>

Fires when the user changes part of the range (see example).

Fires when the popup closes.

onFocus?

(event: FocusEvent​<any, Element>) => void

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

Parameters:eventFocusEvent​<any, Element>

Fires when the popup opens.

Parameters:eventDateRangePickerOpenEvent

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.

Determines whether the DateRangePicker will display a Swap Value button (see example).

The DateRangePicker will display the swap button only if the allowReverse property is also set to true.

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.