Skip to content
Edit this page

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 '/packages/x-date-pickers-pro/src/DateRangePickerDay';
// or
import { DateRangePickerDay } from '/packages/x-date-pickers-pro/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

dayRequired

The date to show.

Type:

any
isEndOfHighlightingRequired

Set to true if the day is the end of a highlighted date range.

Type:

bool
isEndOfPreviewingRequired

Set to true if the day is the end of a previewing date range.

Type:

bool
isFirstVisibleCellRequired

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.

Type:

bool
isHighlightingRequired

Set to true if the day is in a highlighted date range.

Type:

bool
isLastVisibleCellRequired

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.

Type:

bool
isPreviewingRequired

Set to true if the day is in a preview date range.

Type:

bool
isStartOfHighlightingRequired

Set to true if the day is the start of a highlighted date range.

Type:

bool
isStartOfPreviewingRequired

Set to true if the day is the start of a previewing date range.

Type:

bool
outsideCurrentMonthRequired

If true, day is outside of month and will be hidden.

Type:

bool
action

A ref for imperative actions. It currently only supports focusVisible() action.

Type:

func | { current?: { focusVisible: func } }
centerRipple

If true, the ripples are centered. They won't start at the cursor interaction position.

Type:

bool
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
disabled

If true, renders as disabled.

Type:

bool
disableHighlightToday

If true, today's date is rendering without highlighting with circle.

Type:

bool
disableMargin

If true, days are rendering without margin. Useful for displaying linked range of days.

Type:

bool
disableRipple

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.

Type:

bool
disableTouchRipple

If true, the touch ripple effect is disabled.

Type:

bool
focusRipple

If true, the base button will have a keyboard focus ripple.

Type:

bool
focusVisibleClassName

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.

Type:

string
isVisuallySelected

Indicates if the day should be visually selected.

Type:

bool
onFocusVisible

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

Type:

func
selected

If true, renders as selected.

Type:

bool
showDaysOutsideCurrentMonth

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.

Type:

bool
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
today

If true, renders as today date.

Type:

bool
TouchRippleProps

Props applied to the TouchRipple element.

Type:

object
touchRippleRef

A ref that points to the TouchRipple element.

Type:

func | { current?: { pulsate: func, start: func, stop: func } }
The ref is forwarded to the root element.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiDateRangePickerDay-rootroot

Styles applied to the root element.

.MuiDateRangePickerDay-rangeIntervalDayHighlightrangeIntervalDayHighlight

Styles applied to the root element if isHighlighting=true.

.MuiDateRangePickerDay-rangeIntervalDayHighlightStartrangeIntervalDayHighlightStart

Styles applied to the root element if isStartOfHighlighting=true.

.MuiDateRangePickerDay-rangeIntervalDayHighlightEndrangeIntervalDayHighlightEnd

Styles applied to the root element if isEndOfHighlighting=true.

.MuiDateRangePickerDay-rangeIntervalPreviewrangeIntervalPreview

Styles applied to the preview element.

.MuiDateRangePickerDay-rangeIntervalDayPreviewrangeIntervalDayPreview

Styles applied to the root element if isPreviewing=true.

.MuiDateRangePickerDay-rangeIntervalDayPreviewStartrangeIntervalDayPreviewStart

Styles applied to the root element if isStartOfPreviewing=true.

.MuiDateRangePickerDay-rangeIntervalDayPreviewEndrangeIntervalDayPreviewEnd

Styles applied to the root element if isEndOfPreviewing=true.

.MuiDateRangePickerDay-outsideCurrentMonthoutsideCurrentMonth

Styles applied to the root element if `outsideCurrentMonth=true`

.MuiDateRangePickerDay-startOfMonthstartOfMonth

Styles applied to the root element if day is the start of the month.

.MuiDateRangePickerDay-endOfMonthendOfMonth

Styles applied to the root element if day is the end of the month.

.MuiDateRangePickerDay-firstVisibleCellfirstVisibleCell

Styles applied to the root element if day is the first visible cell of the month.

.MuiDateRangePickerDay-lastVisibleCelllastVisibleCell

Styles applied to the root element if day is the last visible cell of the month.

.MuiDateRangePickerDay-hiddenDayFillerhiddenDayFiller

Styles applied to the root element if it is an empty cell used to fill the week.

.MuiDateRangePickerDay-dayday

Styles applied to the day element.

.MuiDateRangePickerDay-dayOutsideRangeIntervaldayOutsideRangeInterval

Styles applied to the day element if isHighlighting=false.

.MuiDateRangePickerDay-dayInsideRangeIntervaldayInsideRangeInterval

Styles applied to the day element if selected=false and isHighlighting=true.

.MuiDateRangePickerDay-notSelectedDatenotSelectedDate

Styles applied to the day element if selected=false.

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