DateRangePickerDay API
API documentation for the React DateRangePickerDay component. Learn about the available props and the CSS API.
Import
import { DateRangePickerDay } from '@mui/x-date-pickers-pro/DateRangePickerDay';
// or
import { DateRangePickerDay } from '@mui/x-date-pickers-pro';
Component name
The nameMuiDateRangePickerDay
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
day* | any | The date to show. | |
isEndOfHighlighting* | bool | false | Set to true if the day is the end of a highlighted date range. |
isEndOfPreviewing* | bool | false | Set to true if the day is the start of a highlighted date range. |
isHighlighting* | bool | false | Set to true if the day is in a highlighted date range. |
isPreviewing* | bool | false | Set to true if the day is in a preview date range. |
isStartOfHighlighting* | bool | false | Set to true if the day is the start of a highlighted date range. |
isStartOfPreviewing* | bool | false | Set to true if the day is the end of a highlighted date range. |
outsideCurrentMonth* | bool | false | If true , day is outside of month and will be hidden. |
classes | object | Override or extend the styles applied to the component. See CSS 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. |
selected | bool | false | If true , renders as selected. |
showDaysOutsideCurrentMonth | bool | false | If true , days that have outsideCurrentMonth={true} are displayed. |
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. |
The
ref
is forwarded to the root element.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiDateRangePickerDay-root | Styles applied to the root element. |
rangeIntervalDayHighlight | .MuiDateRangePickerDay-rangeIntervalDayHighlight | Styles applied to the root element if isHighlighting=true and outsideCurrentMonth=false . |
rangeIntervalDayHighlightStart | .MuiDateRangePickerDay-rangeIntervalDayHighlightStart | Styles applied to the root element if isStartOfHighlighting=true or day is the start of the month. |
rangeIntervalDayHighlightEnd | .MuiDateRangePickerDay-rangeIntervalDayHighlightEnd | Styles applied to the root element if isEndOfHighlighting=true or day is the end of the month. |
rangeIntervalPreview | .MuiDateRangePickerDay-rangeIntervalPreview | Styles applied to the preview element. |
rangeIntervalDayPreview | .MuiDateRangePickerDay-rangeIntervalDayPreview | Styles applied to the root element if isPreviewing=true and outsideCurrentMonth=false . |
rangeIntervalDayPreviewStart | .MuiDateRangePickerDay-rangeIntervalDayPreviewStart | Styles applied to the root element if isStartOfPreviewing=true or day is the start of the month. |
rangeIntervalDayPreviewEnd | .MuiDateRangePickerDay-rangeIntervalDayPreviewEnd | Styles applied to the root element if isEndOfPreviewing=true or day is the end of the month. |
day | .MuiDateRangePickerDay-day | Styles applied to the day element. |
dayOutsideRangeInterval | .MuiDateRangePickerDay-dayOutsideRangeInterval | Styles applied to the day element if isHighlighting=false . |
dayInsideRangeInterval | .MuiDateRangePickerDay-dayInsideRangeInterval | Styles applied to the day element if selected=false and isHighlighting=true . |
notSelectedDate | .MuiDateRangePickerDay-notSelectedDate | Styles applied to the day element if selected=false . |
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.