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:

Date Range Picker

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
onChange^*	func		Callback fired when the value (the selected date range) changes @DateIOType. Signature: `function(date: DateRange<TDate>, keyboardInputValue: string) => void` date: The new date range. keyboardInputValue: The current value of the keyboard input.
renderInput^*	func		The `renderInput` prop allows you to customize the rendered input. The `startProps` and `endProps` arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the `ref` and `inputProps` keys. Signature: `function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement` startProps: Props that you need to forward to the range start input. endProps: Props that you need to forward to the range end input. returns (React.ReactElement): The range input to render.
value^*	Array<any>		The value of the picker.
acceptRegex	RegExp	/\dap/gi	Regular expression to detect "accepted" symbols.
calendars	1 \| 2 \| 3	2	The number of calendars that render on desktop.
className	string		className applied to the root component.
closeOnSelect	bool	`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).	If `true` the popup or dialog will immediately close after submitting full date.
components	object	{}	Overrideable components.
componentsProps	object	{}	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}`.
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.
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.
disableMaskedInput	bool	false	Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPicker	bool	false	Do not render open picker button (renders only text field with validation).
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
getOpenDialogAriaText	func	(date, utils) => `Choose date, selected date is ${utils.format(date, 'fullDate')}`	Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType Signature: `function(date: TDate \| null, utils: MuiPickersAdapter<TDate>) => string` date: The date from which we want to add an aria-text. utils: The utils to manipulate the date. returns (string): The aria-text to render inside the dialog.
InputAdornmentProps	object		Props to pass to keyboard input adornment.
inputFormat	string		Format string.
inputRef	func \| { current?: object }		Pass a ref to the `input` element.
loading	bool	false	If `true` renders `LoadingComponent` in calendar instead of calendar view. Can be used to preload information and show it in calendar.
localeText	object		Locale for components texts
mask	string	'__/__/____'	Custom mask. Can be used to override generate from format. (e.g. `__/__/____ __:__` or `__/__/____ __:__ _M`).
maxDate	any		Maximal selectable date.
minDate	any		Minimal selectable date.
onAccept	func		Callback fired when date is accepted @DateIOType. Signature: `function(value: TValue) => void` value: The value that was just accepted.
onClose	func		Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onError	func		Callback that fired when input value or new `value` prop validation returns new validation error (or value is valid after error). In case of validation error detected `reason` prop return non-null value and `TextField` must be displayed in `error` state. This can be used to render appropriate form error. Read the guide about form integration and error displaying. Signature: `function(reason: TError, value: TValue) => void` reason: The reason why the current value is not valid. value: The invalid value.
onMonthChange	func		Callback firing on month change @DateIOType. Signature: `function(month: TDate) => void \| Promise` month: The new month. returns (void \| Promise): -
onOpen	func		Callback fired when the popup requests to be opened. Use in controlled mode (see open).
open	bool	false	Control the popup or dialog open state.
OpenPickerButtonProps	object		Props to pass to keyboard adornment button.
readOnly	bool	false	Make picker read only.
reduceAnimations	bool	typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)	Disable heavy animations.
renderLoading	func	() => <span data-mui-test="loading-progress">...</span>	Component displaying when passed `loading` true. Signature: `function() => React.ReactNode` returns (React.ReactNode): The node to render when loading.
rifmFormatter	func		Custom formatter to be passed into Rifm component. Signature: `function(str: string) => string` str: The un-formatted string. returns (string): The formatted string.
shouldDisableDate	func		Disable specific date. @DateIOType 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.
shouldDisableMonth	func		Disable specific month. Signature: `function(month: TDate) => boolean` month: The month to test. returns (boolean): If `true` the month will be disabled.
shouldDisableYear	func		Disable specific year. Signature: `function(year: TDate) => boolean` year: The year to test. returns (boolean): If `true` the year will be disabled.
showDaysOutsideCurrentMonth	bool	false	If `true`, days that have `outsideCurrentMonth={true}` are displayed.
showToolbar	bool	false	If `true`, show the toolbar even in desktop mode.
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.

Slots

Name	Type	Default	Description
ActionBar	elementType	PickersActionBar	Custom component for the action bar, it is placed bellow 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.
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.
OpenPickerIcon	elementType	Calendar or Clock	Icon displayed in the open picker button.
PaperContent	elementType	React.Fragment	Custom component wrapping the views of the desktop and static pickers (it is the direct child of the Paper component).
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.
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'.
Toolbar	elementType		Custom component for the toolbar rendered above the views.

The ref is forwarded to the root element.