DateRangeCalendar API

API reference docs for the React DateRangeCalendar 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 { DateRangeCalendar } from '@mui/x-date-pickers-pro/DateRangeCalendar';
// or
import { DateRangeCalendar } from '@mui/x-date-pickers-pro';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

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.
components	object	{}	Deprecated - Please use `slots`. Overridable components.
componentsProps	object	{}	Deprecated - Please use `slotProps`. The props used for each component slot.
currentMonthCalendarPosition	1 \| 2 \| 3	1	Position the current month is rendered in.
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 selected value. Used when the component is not controlled.
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.
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
loading	bool	false	If `true`, calls `renderLoading` instead of rendering the day calendar. Can be used to preload information and show it in calendar.
maxDate	any		Maximal selectable date.
minDate	any		Minimal selectable date.
onChange	func		Callback fired when the value changes. Signature: `function(value: DateRange<TDate>, selectionState: PickerSelectionState \| undefined) => void` value: The new value. selectionState: Indicates if the date range selection is complete.
onMonthChange	func		Callback fired on month change. Signature: `function(month: TDate) => void` month: The new month.
onRangePositionChange	func		Callback fired when the range position changes. Signature: `function(rangePosition: RangePosition) => void` rangePosition: The new range position.
rangePosition	'end' \| 'start'		The position in the currently edited date range. Used when the component position is controlled.
readOnly	bool	false	Make picker read only.
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.
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.
timezone	string	The 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 documention for more details.
value	Array<any>		The selected value. Used when the component is controlled.

Slots

Name	Type	Default	Description
day	elementType	DateRangePickersDay	Custom component for day in range pickers. Check the DateRangePickersDay component.
leftArrowIcon	elementType	ArrowLeft	Icon displayed in the left view switch button.
nextIconButton	elementType	IconButton	Button allowing to switch to the right view.
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'.

The ref is forwarded to the root element.

CSS

Rule name	Global class	Description
root	.MuiDateRangeCalendar-root	Styles applied to the root element.
monthContainer	.MuiDateRangeCalendar-monthContainer	Styles applied to the container of a month.
dayDragging	.MuiDateRangeCalendar-dayDragging	Styles applied to the day calendar container when dragging

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.