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

Name	Type	Default	Description
autoFocus	bool	false	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.
calendars	1 \| 2 \| 3	2	The number of calendars to render on desktop.
className	string		Class name applied to the root element.
closeOnSelect	bool	`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.
components	object	{}	Deprecated - Please use `slots`. Overridable components.
componentsProps	object	{}	Deprecated - Please use `slotProps`. The props used for each component slot.
dayOfWeekFormatter	func	(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.
defaultCalendarMonth	any		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.
defaultValue	Array<any>		The default value. Used when the component is not controlled.
desktopModeMediaQuery	string	'@media (pointer: fine)'	CSS media query when `Mobile` mode will be changed to `Desktop`.
disableAutoMonthSwitching	bool	false	If `true`, after selecting `start` date calendar will not automatically switch to the month of `end` date.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableDragEditing	bool	false	If `true`, editing dates by dragging is disabled.
disableFuture	bool	false	If `true`, disable values after the current date for date components, time for time components and both for date time components.
disableHighlightToday	bool	false	If `true`, today's date is rendering without highlighting with circle.
disableOpenPicker	bool	false	If `true`, the open picker button will not be rendered (renders only the field).
disablePast	bool	false	If `true`, disable values before the current date for date components, time for time components and both for date time components.
displayWeekNumber	bool	false	If `true`, the week number will be display in the calendar.
fixedWeekNumber	number	undefined	Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars
format	string		Format of the date when rendered in the input(s). Defaults to localized format based on the used `views`.
loading	bool	false	If `true`, calls `renderLoading` instead of rendering the day calendar. Can be used to preload information and show it in calendar.
localeText	object		Locale for components texts. Allows overriding texts coming from `LocalizationProvider` and `theme`.
maxDate	any		Maximal selectable date.
minDate	any		Minimal selectable date.
onAccept	func		Callback fired when the value is accepted. Signature: `function(value: TValue) => void` value: The value that was just accepted.
onChange	func		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.
onClose	func		Callback fired when the popup requests to be closed. Use in controlled mode (see `open`).
onError	func		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.
onMonthChange	func		Callback fired on month change. Signature: `function(month: TDate) => void` month: The new month.
onOpen	func		Callback fired when the popup requests to be opened. Use in controlled mode (see `open`).
onRangePositionChange	func		Callback fired when the range position changes. Signature: `function(rangePosition: RangePosition) => void` rangePosition: The new range position.
onSelectedSectionsChange	func		Callback fired when the selected sections change. Signature: `function(newValue: FieldSelectedSections) => void` newValue: The new selected sections.
open	bool	false	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.
reduceAnimations	bool	typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)	Disable heavy animations.
renderLoading	func	() => "..."	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.
shouldDisableDate	func		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.
showDaysOutsideCurrentMonth	bool	false	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.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots.
sx	Array<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.
value	Array<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

Name	Type	Default	Description
ActionBar	elementType	PickersActionBar	Custom component for the action bar, it is placed below the picker views.
Day	elementType	DateRangePickersDay	Custom component for day in range pickers. Check the DateRangePickersDay component.
DesktopPaper	elementType	PickersPopperPaper	Custom component for the paper rendered inside the desktop picker's Popper.
DesktopTransition	elementType	Grow from @mui/material	Custom component for the desktop popper Transition.
DesktopTrapFocus	elementType	TrapFocus from @mui/material	Custom component for trapping the focus inside the views on desktop.
Dialog	elementType	PickersModalDialogRoot	Custom component for the dialog inside which the views are rendered on mobile.
Field	elementType
FieldRoot	elementType
FieldSeparator	elementType
Layout	elementType		Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
LeftArrowIcon	elementType	ArrowLeft	Icon displayed in the left view switch button.
MobilePaper	elementType	Paper from @mui/material	Custom component for the paper rendered inside the mobile picker's Dialog.
MobileTransition	elementType	Fade from @mui/material	Custom component for the mobile dialog Transition.
NextIconButton	elementType	IconButton	Button allowing to switch to the right view.
Popper	elementType	Popper from @mui/material	Custom component for the popper inside which the views are rendered on desktop.
PreviousIconButton	elementType	IconButton	Button allowing to switch to the left view.
RightArrowIcon	elementType	ArrowRight	Icon displayed in the right view switch button.
Shortcuts	elementType	PickersShortcuts	Custom component for the shortcuts.
SwitchViewButton	elementType	IconButton	Button displayed to switch between different calendar views.
SwitchViewIcon	elementType	ArrowDropDown	Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
TextField	elementType	TextField 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`.
Toolbar	elementType	DateTimePickerToolbar	Custom component for the toolbar rendered above the views.

The component cannot hold a ref.