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.

Demos

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

Import

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

Component name

The name MuiDateRangePicker can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
autoFocusboolfalse
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.
calendars1
| 2
| 3
2
The number of calendars to render on desktop.
classNamestring
Class name applied to the root element.
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.
componentsobject{}
Overridable components.
componentsPropsobject{}
The props used for each component slot.
dayOfWeekFormatterfunc(day) => day.charAt(0).toUpperCase()
Formats the day of week displayed in the calendar header.

Signature:
function(day: string) => string
day: The day of week provided by the adapter's method getWeekdays.
returns (string): The name to display.
defaultCalendarMonthany
Default calendar month displayed when value={[null, null]}.
defaultRangePosition'end'
| 'start'
'start'
The initial position in the edited date range. Used when the component is not controlled.
defaultValueArray<any>
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.
disableAutoMonthSwitchingboolfalse
If true, after selecting start date calendar will not automatically switch to the month of end date.
disabledboolfalse
If true, the picker and text field are disabled.
disableDragEditingboolfalse
If true, editing dates by dragging is disabled.
disableFutureboolfalse
If true, disable values after the current date for date components, time for time components and both for date time components.
disableHighlightTodayboolfalse
If true, today's date is rendering without highlighting with circle.
disableOpenPickerboolfalse
If true, the open picker button will not be rendered (renders only the field).
disablePastboolfalse
If true, disable values before the current date for date components, time for time components and both for date time components.
displayWeekNumberboolfalse
If true, the week number will be display in the calendar.
fixedWeekNumbernumberundefined
Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars
formatstring
Format of the date when rendered in the input(s). Defaults to localized format based on the used views.
loadingboolfalse
If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.
localeTextobject
Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.
maxDateany
Maximal selectable date.
minDateany
Minimal selectable date.
onAcceptfunc
Callback fired when the value is accepted.

Signature:
function(value: TValue) => void
value: The value that was just accepted.
onChangefunc
Callback fired when the value changes.

Signature:
function(value: TValue, context: FieldChangeHandlerContext<TError>) => void
value: The new value.
context: The context containing the validation result of the current value.
onClosefunc
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfunc
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.
onMonthChangefunc
Callback fired on month change.

Signature:
function(month: TDate) => void
month: The new month.
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onRangePositionChangefunc
Callback fired when the range position changes.

Signature:
function(rangePosition: RangePosition) => void
rangePosition: The new range position.
onSelectedSectionsChangefunc
Callback fired when the selected sections change.

Signature:
function(newValue: FieldSelectedSections) => void
newValue: The new selected sections.
openboolfalse
Control the popup or dialog open state.
rangePosition'end'
| 'start'
The position in the currently edited date range. Used when the component position is controlled.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
Disable heavy animations.
renderLoadingfunc() => "..."
Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.
selectedSections'all'
| 'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'weekDay'
| 'year'
| number
| { endIndex: number, startIndex: number }
The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a startIndex and endIndex properties are provided, the sections between those two indexes will be selected. 3. If a string of type FieldSectionType is provided, the first section with that name will be selected. 4. If null is provided, no section will be selected If not provided, the selected sections will be handled internally.
shouldDisableDatefunc
Disable specific date.

Signature:
function(day: TDate, position: string) => boolean
day: The date to test.
position: The date to test, 'start' or 'end'.
returns (boolean): Returns true if the date should be disabled.
showDaysOutsideCurrentMonthboolfalse
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.
slotPropsobject{}
The props used for each component slot.
slotsobject{}
Overridable component slots.
sxArray<func
| 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.
valueArray<any>
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 the used.

Slots

NameTypeDefaultDescription
ActionBarelementTypePickersActionBar
Custom component for the action bar, it is placed below the picker views.
DayelementTypeDateRangePickersDay
Custom component for day in range pickers. Check the DateRangePickersDay component.
DesktopPaperelementTypePickersPopperPaper
Custom component for the paper rendered inside the desktop picker's Popper.
DesktopTransitionelementTypeGrow from @mui/material
Custom component for the desktop popper Transition.
DesktopTrapFocuselementTypeTrapFocus from @mui/material
Custom component for trapping the focus inside the views on desktop.
DialogelementTypePickersModalDialogRoot
Custom component for the dialog inside which the views are rendered on mobile.
FieldelementType
FieldRootelementType
FieldSeparatorelementType
LayoutelementType
Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
LeftArrowIconelementTypeArrowLeft
Icon displayed in the left view switch button.
MobilePaperelementTypePaper from @mui/material
Custom component for the paper rendered inside the mobile picker's Dialog.
MobileTransitionelementTypeFade from @mui/material
Custom component for the mobile dialog Transition.
NextIconButtonelementTypeIconButton
Button allowing to switch to the right view.
PopperelementTypePopper from @mui/material
Custom component for the popper inside which the views are rendered on desktop.
PreviousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
RightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
ShortcutselementTypePickersShortcuts
Custom component for the shortcuts.
SwitchViewButtonelementTypeIconButton
Button displayed to switch between different calendar views.
SwitchViewIconelementTypeArrowDropDown
Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
TextFieldelementTypeTextField from '@mui/material'
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. Receives the same props as @mui/material/TextField.
ToolbarelementTypeDateTimePickerToolbar
Custom component for the toolbar rendered above the views.
The component cannot hold a ref.