Skip to content
Influence MUI X's 2024 roadmap! Participate in the latest Developer Survey

DateRangeCalendar API

API reference docs for the React DateRangeCalendar component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import { DateRangeCalendar } from '@mui/x-date-pickers-pro/DateRangeCalendar';
// or
import { DateRangeCalendar } from '@mui/x-date-pickers-pro';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

autoFocus

If true, the main element is focused during the first mount. This main element is: - the element chosen by the visible view if any (i.e: the selected day on the day view). - the input element if there is a field rendered.

Type:bool

availableRangePositions

Range positions available for selection. This list is checked against when checking if a next range position can be selected.
Used on Date Time Range pickers with current rangePosition to force a finish selection after just one range position selection.

Type:Array<'end'
| 'start'>

Default:['start', 'end']

calendars

The number of calendars to render.

Type:1
| 2
| 3

Default:2

currentMonthCalendarPosition

Position the current month is rendered in.

Type:1
| 2
| 3

Default:1

dayOfWeekFormatter

Formats the day of week displayed in the calendar header.

Type:func

Default:(_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

Signature:
function(date: TDate) => string
  • date The date of the day of week provided by the adapter.

Returns: The name to display.

defaultRangePosition

The initial position in the edited date range. Used when the component is not controlled.

Type:'end'
| 'start'

Default:'start'

defaultValue

The default selected value. Used when the component is not controlled.

Type:Array<object>

disableAutoMonthSwitching

If true, after selecting start date calendar will not automatically switch to the month of end date.

Type:bool

Default:false

disabled

If true, the picker and text field are disabled.

Type:bool

Default:false

disableDragEditing

If true, editing dates by dragging is disabled.

Type:bool

Default:false

disableFuture

If true, disable values after the current date for date components, time for time components and both for date time components.

Type:bool

Default:false

disableHighlightToday

If true, today's date is rendering without highlighting with circle.

Type:bool

Default:false

disablePast

If true, disable values before the current date for date components, time for time components and both for date time components.

Type:bool

Default:false

displayWeekNumber

If true, the week number will be display in the calendar.

Type:bool

fixedWeekNumber

The day view will show as many weeks as needed after the end of the current month to match this value. Put it to 6 to have a fixed number of weeks in Gregorian calendars

Type:number

Default:undefined

focusedView

Controlled focused view.

Type:'day'

loading

If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.

Type:bool

Default:false

maxDate

Maximal selectable date.

Type:object

minDate

Minimal selectable date.

Type:object

onChange

Callback fired when the value changes.

Type:func

Signature:
function(value: TValue, selectionState: PickerSelectionState | undefined, selectedView: TView | undefined) => void
  • value The new value.
  • selectionState Indicates if the date selection is complete.
  • selectedView Indicates the view in which the selection has been made.
onFocusedViewChange

Callback fired on focused view change.

Type:func

Signature:
function(view: TView, hasFocus: boolean) => void
  • view The new view to focus or not.
  • hasFocus true if the view should be focused.
onMonthChange

Callback fired on month change.

Type:func

Signature:
function(month: TDate) => void
  • month The new month.
onRangePositionChange

Callback fired when the range position changes.

Type:func

Signature:
function(rangePosition: RangePosition) => void
  • rangePosition The new range position.
onViewChange

Callback fired on view change.

Type:func

Signature:
function(view: TView) => void
  • view The new view.
openTo

The default visible view. Used when the component view is not controlled. Must be a valid option from views list.

Type:'day'

rangePosition

The position in the currently edited date range. Used when the component position is controlled.

Type:'end'
| 'start'

readOnly

Make picker read only.

Type:bool

Default:false

reduceAnimations

If true, disable heavy animations.

Type:bool

Default:`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13

referenceDate

The date used to generate the new value when both value and defaultValue are empty.

Type:object

Default:The closest valid date using the validation props, except callbacks such as `shouldDisableDate`.

renderLoading

Component rendered on the "day" view when props.loading is true.

Type:func

Default:() => "..."

Signature:
function() => React.ReactNode

    Returns: The node to render when loading.

    shouldDisableDate

    Disable specific date.
    Warning: This function can be called multiple times (e.g. when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.

    Type:func

    Signature:
    function(day: TDate, position: string) => boolean
    • day The date to test.
    • position The date to test, 'start' or 'end'.

    Returns: Returns true if the date should be disabled.

    showDaysOutsideCurrentMonth

    If true, days outside the current month are rendered:
    - if fixedWeekNumber is defined, renders days to have the weeks requested.
    - if fixedWeekNumber is not defined, renders day to fill the first and last week of the current month.
    - ignored if calendars equals more than 1 on range pickers.

    Type:bool

    Default:false

    slotProps

    The props used for each component slot.

    Type:object

    Default:{}

    slots

    Overridable component slots.

    See Slots API below for more details.

    Type:object

    Default:{}

    sx

    The system prop that allows defining system overrides as well as additional CSS styles.

    See the `sx` page for more details.

    Type:Array<func
    | object
    | bool>
    | func
    | object

    timezone

    Choose which timezone to use for the value. Example: "default", "system", "UTC", "America/New_York". If you pass values from other timezones to some props, they will be converted to this timezone before being used.

    See the timezones documentation for more details.

    Type:string

    Default:The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.

    value

    The selected value. Used when the component is controlled.

    Type:Array<object>

    view

    The visible view. Used when the component view is controlled. Must be a valid option from views list.

    Type:'day'

    views

    Available views.

    Type:Array<'day'>

    The ref is forwarded to the root element.

    Theme default props

    You can use MuiDateRangeCalendar to change the default props of this component with the theme.

    Slots

    calendarHeader

    Custom component for calendar header. Check the PickersCalendarHeader component.

    Default component: PickersCalendarHeader

    day

    Custom component for day in range pickers. Check the DateRangePickersDay component.

    Default component: DateRangePickersDay

    previousIconButton

    Button allowing to switch to the left view.

    Default component: IconButton

    nextIconButton

    Button allowing to switch to the right view.

    Default component: IconButton

    leftArrowIcon

    Icon displayed in the left view switch button.

    Default component: ArrowLeft

    rightArrowIcon

    Icon displayed in the right view switch button.

    Default component: ArrowRight

    switchViewButton

    Button displayed to switch between different calendar views.

    Default component: IconButton

    switchViewIcon

    Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.

    Default component: ArrowDropDown

    CSS classes

    These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

    .MuiDateRangeCalendar-dayDragging

    Styles applied to the day calendar container when dragging

    Rule name:dayDragging

    .MuiDateRangeCalendar-monthContainer

    Styles applied to the container of a month.

    Rule name:monthContainer

    .MuiDateRangeCalendar-root

    Styles applied to the root element.

    Rule name:root


    You can override the style of the component using one of these customization options: