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.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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
calendars

The number of calendars to render.

Type:

1 | 2 | 3

Default:

2
components

Overridable components.

Type:

object

Default:

{}
componentsProps

The props used for each component slot.

Type:

object

Default:

{}
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(day: string, date: TDate) => string
  • day The day of week provided by the adapter. Deprecated, will be removed in v7: Use date instead.
  • date The date of the day of week provided by the adapter.

Returns: The name to display.

defaultCalendarMonth

Default calendar month displayed when value={[null, null]}.

Type:

any
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<any>
disableAutoMonthSwitching

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

Type:

bool
disabled

If true, the picker and text field are disabled.

Type:

bool
disableDragEditing

If true, editing dates by dragging is disabled.

Type:

bool
disableFuture

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

Type:

bool
disableHighlightToday

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

Type:

bool
disablePast

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

Type:

bool
displayWeekNumber

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

Type:

bool
fixedWeekNumber

Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars

Type:

number

Default:

undefined
loading

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

Type:

bool
maxDate

Maximal selectable date.

Type:

any
minDate

Minimal selectable date.

Type:

any
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: DateRange, selectionState: PickerSelectionState | undefined) => void
  • value The new value.
  • selectionState Indicates if the date range selection is complete.
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.
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
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:

any

Default:

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

Component displaying when passed loading 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
    slotProps

    The props used for each component slot.

    Type:

    object

    Default:

    {}
    slots

    Overridable component slots.

    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 documention 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<any>
    The ref is forwarded to the root element.

    CSS

    The following class names are useful for styling with CSS (the state classes are marked).
    To learn more, visit the component customization page.


    .MuiDateRangeCalendar-rootroot

    Styles applied to the root element.

    .MuiDateRangeCalendar-monthContainermonthContainer

    Styles applied to the container of a month.

    .MuiDateRangeCalendar-dayDraggingdayDragging

    Styles applied to the day calendar container when dragging

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

    Slots

    day

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

    Default: DateRangePickersDay

    leftArrowIcon

    Icon displayed in the left view switch button.

    Default: ArrowLeft

    nextIconButton

    Button allowing to switch to the right view.

    Default: IconButton

    previousIconButton

    Button allowing to switch to the left view.

    Default: IconButton

    rightArrowIcon

    Icon displayed in the right view switch button.

    Default: ArrowRight

    switchViewButton

    Button displayed to switch between different calendar views.

    Default: IconButton

    switchViewIcon

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

    Default: ArrowDropDown

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