Skip to content

DateRangeCalendar API

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



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 of the native component are also available.


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.

| 'start'>
['start', 'end']

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.

| 2
| 3

The number of calendars to render.


Override or extend the styles applied to the component.

See CSS classes API below for more details.

| 2
| 3

Position the current month is rendered in.

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

Formats the day of week displayed in the calendar header.

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

Returns: The name to display.

| 'start'

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


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


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


If true, the picker and text field are disabled.


If true, editing dates by dragging is disabled.


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


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


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


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


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


Controlled focused view.


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


Maximal selectable date.


Minimal selectable date.


Callback fired when the value changes.

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.

Callback fired on focused view change.

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

Callback fired on month change.

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

Callback fired when the range position changes.

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

Callback fired on view change.

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

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

| 'start'

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


Make picker read only.

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

If true, disable heavy animations.

referenceDateobjectThe closest valid date using the validation props, except callbacks such as `shouldDisableDate`.

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

renderLoadingfunc() => "..."

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

Signature:function() => React.ReactNode

    Returns: The node to render when loading.


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

    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.


    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.


    The props used for each component slot.


    Overridable component slots.

    See Slots API below for more details.

    | object
    | bool>
    | func
    | object

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

    See the `sx` page for more details.

    timezonestringThe timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.

    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.


    The selected value. Used when the component is controlled.


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


    Available views.

    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.


    Slot nameClass nameDefault componentDescription
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    dayDateRangePickersDayCustom component for day in range pickers. Check the DateRangePickersDay component.
    leftArrowIconArrowLeftIcon displayed in the left view switch button.
    nextIconButtonIconButtonButton allowing to switch to the right view.
    previousIconButtonIconButtonButton allowing to switch to the left view.
    rightArrowIconArrowRightIcon displayed in the right view switch button.
    switchViewButtonIconButtonButton displayed to switch between different calendar views.
    switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is "year".

    CSS classes

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

    Class nameRule nameDescription
    .MuiDateRangeCalendar-dayDraggingdayDraggingStyles applied to the day calendar container when dragging
    .MuiDateRangeCalendar-monthContainermonthContainerStyles applied to the container of a month.
    .MuiDateRangeCalendar-rootrootStyles applied to the root element.

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