DateRangePickerDay API

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
day*	object	-	The date to show.
isEndOfHighlighting*	bool	-	Set to `true` if the `day` is the end of a highlighted date range.
isEndOfPreviewing*	bool	-	Set to `true` if the `day` is the end of a previewing date range.
isFirstVisibleCell*	bool	-	If `true`, day is the first visible cell of the month. Either the first day of the month or the first day of the week depending on `showDaysOutsideCurrentMonth`.
isHighlighting*	bool	-	Set to `true` if the `day` is in a highlighted date range.
isLastVisibleCell*	bool	-	If `true`, day is the last visible cell of the month. Either the last day of the month or the last day of the week depending on `showDaysOutsideCurrentMonth`.
isPreviewing*	bool	-	Set to `true` if the `day` is in a preview date range.
isStartOfHighlighting*	bool	-	Set to `true` if the `day` is the start of a highlighted date range.
isStartOfPreviewing*	bool	-	Set to `true` if the `day` is the start of a previewing date range.
outsideCurrentMonth*	bool	-	If `true`, day is outside of month and will be hidden.
action	func \| { current?: { focusVisible: func } }	-	A ref for imperative actions. It currently only supports `focusVisible()` action.
centerRipple	bool	false	If `true`, the ripples are centered. They won't start at the cursor interaction position.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	false	If `true`, renders as disabled.
disableHighlightToday	bool	false	If `true`, today's date is rendering without highlighting with circle.
disableMargin	bool	false	If `true`, days are rendering without margin. Useful for displaying linked range of days.
disableRipple	bool	false	If `true`, the ripple effect is disabled. ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the `.Mui-focusVisible` class.
disableTouchRipple	bool	false	If `true`, the touch ripple effect is disabled.
draggable	bool	false	If `true`, the day can be dragged to change the current date range.
focusRipple	bool	false	If `true`, the base button will have a keyboard focus ripple.
focusVisibleClassName	string	-	This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a `focus-visible` class to other components if needed.
isVisuallySelected	bool	-	Indicates if the day should be visually selected.
onFocusVisible	func	-	Callback fired when the component is focused with a keyboard. We trigger a `onFocus` callback too.
selected	bool	false	If `true`, renders as selected.
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.
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.
today	bool	false	If `true`, renders as today date.
TouchRippleProps	object	-	Props applied to the `TouchRipple` element.
touchRippleRef	func \| { current?: { pulsate: func, start: func, stop: func } }	-	A ref that points to the `TouchRipple` element.

The ref is forwarded to the root element.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiDateRangePickerDay-day	day	Styles applied to the day element.
.MuiDateRangePickerDay-dayInsideRangeInterval	dayInsideRangeInterval	Styles applied to the day element if `selected=false` and `isHighlighting=true`.
.MuiDateRangePickerDay-dayOutsideRangeInterval	dayOutsideRangeInterval	Styles applied to the day element if `isHighlighting=false`.
.MuiDateRangePickerDay-endOfMonth	endOfMonth	Styles applied to the root element if `day` is the end of the month.
.MuiDateRangePickerDay-firstVisibleCell	firstVisibleCell	Styles applied to the root element if `day` is the first visible cell of the month.
.MuiDateRangePickerDay-hiddenDayFiller	hiddenDayFiller	Styles applied to the root element if it is an empty cell used to fill the week.
.MuiDateRangePickerDay-lastVisibleCell	lastVisibleCell	Styles applied to the root element if `day` is the last visible cell of the month.
.MuiDateRangePickerDay-notSelectedDate	notSelectedDate	Styles applied to the day element if `selected=false`.
.MuiDateRangePickerDay-outsideCurrentMonth	outsideCurrentMonth	Styles applied to the root element if `outsideCurrentMonth=true`
.MuiDateRangePickerDay-rangeIntervalDayHighlight	rangeIntervalDayHighlight	Styles applied to the root element if `isHighlighting=true`.
.MuiDateRangePickerDay-rangeIntervalDayHighlightEnd	rangeIntervalDayHighlightEnd	Styles applied to the root element if `isEndOfHighlighting=true`.
.MuiDateRangePickerDay-rangeIntervalDayHighlightStart	rangeIntervalDayHighlightStart	Styles applied to the root element if `isStartOfHighlighting=true`.
.MuiDateRangePickerDay-rangeIntervalDayPreview	rangeIntervalDayPreview	Styles applied to the root element if `isPreviewing=true`.
.MuiDateRangePickerDay-rangeIntervalDayPreviewEnd	rangeIntervalDayPreviewEnd	Styles applied to the root element if `isEndOfPreviewing=true`.
.MuiDateRangePickerDay-rangeIntervalDayPreviewStart	rangeIntervalDayPreviewStart	Styles applied to the root element if `isStartOfPreviewing=true`.
.MuiDateRangePickerDay-rangeIntervalPreview	rangeIntervalPreview	Styles applied to the preview element.
.MuiDateRangePickerDay-root	root	Styles applied to the root element.
.MuiDateRangePickerDay-startOfMonth	startOfMonth	Styles applied to the root element if `day` is the start of the month.

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.