Date Inputs / API / DateRangePickerCalendarSettings
material theme

DateRangePickerCalendarSettings

Represents the settings that can be passed to the MultiViewCalendar inside the DateRangePicker.

activeRangeEnd? SelectionRangeEnd

Specifies which end of the defined selection range will be marked as active.

If the selection range is undefined, the value is ignored.

allowReverse? boolean

If set to true, the component skips the validation of whether the from value is after the to value.

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.

bottomView? ActiveView

Defines the bottommost view to which the user can navigate.

cell? React.ComponentType<CalendarCellProps>

Enables the customization or the override of the default MultiViewCalendar cell (see example).

className? string

Sets the className of the MultiViewCalendar.

defaultActiveView? ActiveView

Sets the default active view of the MultiViewCalendar. If not set, the MultiViewCalendar displays the month view.

disabled? boolean

Determines whether the MultiViewCalendar is disabled.

focusedDate? Date

Sets the initial focused date of the MultiViewCalendar.

headerTitle? React.ComponentType<CalendarHeaderTitleProps>

Enables the customization or the override of the default header title in the MultiViewCalendar (see example).

id? string

Sets the id of the MultiViewCalendar.

max? Date

Sets the maximum allowed date of the MultiViewCalendar. Defaults to 2099-12-31.

min? Date

Sets the minimum allowed date of the MultiViewCalendar. Defaults to 1900-1-1.

mode? MultiViewCalendarMode

Sets the selection mode of the MultiViewCalendar.

The available modes are:

  • (Default) single—Renders a single-date selection.
  • multiple—Renders a multiple-date selection.
  • range—Renders a date-range selection.

onBlur? (event: FocusEvent<any>) => void

Fires each time the MultiViewCalendar is blurred.

onFocus? (event: FocusEvent<any>) => void

Fires each time the MultiViewCalendar is focused.

tabIndex? number

Sets the tabIndex property of the MultiViewCalendar.

topView? ActiveView

Defines the topmost view to which the user can navigate.

views? number

Sets the views property of the MultiViewCalendar and defines the number of rendered views.

weekCell? React.ComponentType<CalendarWeekCellProps>

Enables the customization or the override of the default week cell in the MultiViewCalendar (see example).

weekNumber? boolean

Determines if the week number column will be displayed.