DateRangePicker API

API documentation for the React DateRangePicker component. Learn about the available props and the CSS API.

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 parsed 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		The components used for each slot. Either a string to use an HTML element or a component.
componentsProps	object		The props used for each slot inside.
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`.
DialogProps	object		Props applied to the `Dialog` element.
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.
disableHighlightToday	bool	false	If `true`, todays 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).
endText	node	'End'	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization Text for end input label and toolbar placeholder.
getOpenDialogAriaText	func	(date, utils) => `Choose date, selected date is ${utils.format(utils.date(date), 'fullDate')}`	Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType Signature: `function(date: TInputDate, 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.
getViewSwitchingButtonText	func		Get aria-label text for switching between views button. Signature: `function(currentView: CalendarPickerView) => string` currentView: The view from which we want to get the button text. returns (string): The label of the view.
InputAdornmentProps	object		Props to pass to keyboard input adornment.
inputFormat	string		Format string.
inputRef	func \| { current?: object }		Pass a ref to the `input` element.
leftArrowButtonText	string		Deprecated Left arrow icon aria-label text.
loading	bool	false	If `true` renders `LoadingComponent` in calendar instead of calendar view. Can be used to preload information and show it in calendar.
mask	string	'__/__/____'	Custom mask. Can be used to override generate from format. (e.g. `__/__/____ __:__` or `__/__/____ __:__ _M`).
maxDate	any		Max selectable date. @DateIOType
minDate	any		Min selectable date. @DateIOType
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: TInputValue) => 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 year. returns (void \| Promise): -
onOpen	func		Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChange	func		Callback fired on view change. Signature: `function(view: CalendarPickerView) => void` view: The new view.
open	bool	false	Control the popup or dialog open state.
OpenPickerButtonProps	object		Props to pass to keyboard adornment button.
PaperProps	object		Paper props passed down to Paper component.
PopperProps	object		Popper props passed down to Popper component.
readOnly	bool	false	Make picker read only.
reduceAnimations	bool	typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)	Disable heavy animations.
renderDay	func		Custom renderer for `<DateRangePicker />` days. @DateIOType Signature: `function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element` day: The day to render. dateRangePickerDayProps: The props of the day to render. returns (JSX.Element): The element representing the day.
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.
rightArrowButtonText	string		Deprecated Right arrow icon aria-label text.
shouldDisableDate	func		Disable specific date. @DateIOType Signature: `function(day: TDate) => boolean` day: The date to check. returns (boolean): If `true` the day will be disabled.
shouldDisableMonth	func		Disable specific months dynamically. Works like `shouldDisableDate` but for month selection view @DateIOType. Signature: `function(month: TDate) => boolean` month: The month to check. returns (boolean): If `true` the month will be disabled.
shouldDisableYear	func		Disable specific years dynamically. Works like `shouldDisableDate` but for year selection view @DateIOType. Signature: `function(year: TDate) => boolean` year: The year to test. returns (boolean): Return `true` if the year should 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.
startText	node	'Start'	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization Text for start input label and toolbar placeholder.
toolbarFormat	string		Date format, that is displaying in toolbar.
toolbarTitle	node	'Select date range'	Mobile picker title, displaying in the toolbar.
TransitionComponent	elementType		Custom component for popper Transition.

The ref is forwarded to the root element.

DateRangePicker API

Import

Component name

Props

Demos