Skip to content

DateRangePicker API

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



import { DateRangePicker } from '@mui/x-date-pickers-pro/DateRangePicker';
// or
import { DateRangePicker } from '@mui/x-date-pickers-pro';

Learn about the difference by reading this guide on minimizing bundle size.



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.

| 2
| 3

The number of calendars to render on desktop.

closeOnSelectbool`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).

If true, the popover or modal will close after submitting the full date.

| 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 value. Used when the component is not controlled.

desktopModeMediaQuerystring'@media (pointer: fine)'

CSS media query when Mobile mode will be changed to Desktop.


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, the open picker button will not be rendered (renders only the field).


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


Format of the date when rendered in the input(s). Defaults to localized format based on the used views.

| 'spacious'

Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.


Pass a ref to the input element. Ignored if the field has several inputs.


The label content. Ignored if the field has several inputs.


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


Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.


Maximal selectable date.


Minimal selectable date.


Name attribute used by the input element in the Field. Ignored if the field has several inputs.


Callback fired when the value is accepted.

Signature:function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The value that was just accepted.
  • context The context containing the validation result of the current value.

Callback fired when the value changes.

Signature:function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The new value.
  • context The context containing the validation result of the current value.

Callback fired when the popup requests to be closed. Use in controlled mode (see open).


Callback fired when the error associated to the current value changes. If the error has a non-null value, then the TextField will be rendered in error state.

Signature:function(error: TError, value: TValue) => void
  • error The new error describing why the current value is not valid.
  • value The value associated to the error.

Callback fired on month change.

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

Callback fired when the popup requests to be opened. Use in controlled mode (see open).


Callback fired when the range position changes.

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

Callback fired when the selected sections change.

Signature:function(newValue: FieldSelectedSections) => void
  • newValue The new selected sections.

Control the popup or dialog open state.

| 'start'

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

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

If true, disable heavy animations.

referenceDateobjectThe closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.

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.

    | 'day'
    | 'empty'
    | 'hours'
    | 'meridiem'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'weekDay'
    | 'year'
    | number

    The currently selected sections. This prop accepts four formats: 1. If a number is provided, the section at this index will be selected. 2. If a string of type FieldSectionType is provided, the first section with that name will be selected. 3. If "all" is provided, all the sections will be selected. 4. If null is provided, no section will be selected. If not provided, the selected sections will be handled internally.


    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.

    viewRenderers{ day?: func }-

    Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be used.

    The ref is forwarded to the root element.


    Slot nameClass nameDefault componentDescription
    toolbarDateTimePickerToolbarCustom component for the toolbar rendered above the views.
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    dayDateRangePickersDayCustom component for day in range pickers. Check the DateRangePickersDay component.
    previousIconButtonIconButtonButton allowing to switch to the left view.
    nextIconButtonIconButtonButton allowing to switch to the right view.
    leftArrowIconArrowLeftIcon displayed in the left view switch button.
    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".
    actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
    shortcutsPickersShortcutsCustom component for the shortcuts.
    layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
    fieldRootElement rendered at the root. Ignored if the field has only one input.
    fieldSeparatorElement rendered between the two inputs. Ignored if the field has only one input.
    textFieldTextField from '@mui/material' or PickersTextField if `enableAccessibleFieldDOMStructure` is `true`.Form control with an input to render a date or time inside the default field. It is rendered twice: once for the start element and once for the end element.
    clearIconClearIconIcon to display inside the clear button.
    clearButtonIconButtonButton to clear the value.
    desktopPaperPickersPopperPaperCustom component for the paper rendered inside the desktop picker's Popper.
    desktopTransitionGrow or Fade from '@mui/material' when `reduceAnimations` is `true`.Custom component for the desktop popper Transition.
    desktopTrapFocusFocusTrap from '@mui/base'.Custom component for trapping the focus inside the views on desktop.
    popperPopper from '@mui/material'.Custom component for the popper inside which the views are rendered on desktop.
    dialogPickersModalDialogRootCustom component for the dialog inside which the views are rendered on mobile.
    mobilePaperPaper from '@mui/material'.Custom component for the paper rendered inside the mobile picker's Dialog.
    mobileTransitionFade from '@mui/material'.Custom component for the mobile dialog Transition.