跳到内容

DateRangePickerDayAPI

React DateRangePickerDay 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

import { DateRangePickerDay } from '@mui/x-date-pickers-pro/DateRangePickerDay';
// or
import { DateRangePickerDay } from '@mui/x-date-pickers-pro';

通过阅读此关于最小化 bundle size 的指南,了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
day*object-

要显示的日期。

isEndOfHighlighting*bool-

如果 day 是高亮日期范围的结束日期,则设置为 true

isEndOfPreviewing*bool-

如果 day 是预览日期范围的结束日期,则设置为 true

isFirstVisibleCell*bool-

如果为 true,则 day 是月份的第一个可见单元格。取决于 showDaysOutsideCurrentMonth,可能是当月的第一天或当周的第一天。

isHighlighting*bool-

如果 day 在高亮日期范围内,则设置为 true

isLastVisibleCell*bool-

如果为 true,则 day 是月份的最后一个可见单元格。取决于 showDaysOutsideCurrentMonth,可能是当月的最后一天或当周的最后一天。

isPreviewing*bool-

如果 day 在预览日期范围内,则设置为 true

isStartOfHighlighting*bool-

如果 day 是高亮日期范围的开始日期,则设置为 true

isStartOfPreviewing*bool-

如果 day 是预览日期范围的开始日期,则设置为 true

outsideCurrentMonth*bool-

如果为 true,则 day 在月份之外,将被隐藏。

actionfunc
| { current?: { focusVisible: func } }
-

用于命令式操作的 ref。当前仅支持 focusVisible() 操作。

centerRippleboolfalse

如果为 true,则涟漪居中。它们不会从光标交互位置开始。

classesobject-

覆盖或扩展应用于组件的样式。

有关更多详细信息,请参见下方的 CSS 类 API

disabledboolfalse

如果为 true,则渲染为禁用状态。

disableHighlightTodayboolfalse

如果为 true,则今天的日期在渲染时不会用圆圈高亮显示。

disableMarginboolfalse

如果为 true,则日期在渲染时没有外边距。用于显示链接的日期范围很有用。

disableRippleboolfalse

如果为 true,则禁用涟漪效果。
⚠️ 如果没有涟漪,则默认情况下没有 :focus-visible 的样式。请务必通过使用 .Mui-focusVisible 类应用单独的样式来突出显示元素。

disableTouchRippleboolfalse

如果为 true,则禁用触摸涟漪效果。

draggableboolfalse

如果为 true,则可以拖动日期以更改当前日期范围。

focusRippleboolfalse

如果为 true,则基本按钮将具有键盘焦点涟漪。

focusVisibleClassNamestring-

此 prop 可以帮助识别哪个元素具有键盘焦点。当元素通过键盘交互获得焦点时,将应用类名。它是 CSS :focus-visible 选择器 的 polyfill。使用此功能的理由 在此处进行了解释。如果需要,可以使用 polyfillfocus-visible 类应用于其他组件。

isVisuallySelectedbool-

指示日期是否应在视觉上被选中。

onFocusVisiblefunc-

当组件通过键盘获得焦点时触发的回调。我们也会触发 onFocus 回调。

selectedboolfalse

如果为 true,则渲染为选中状态。

showDaysOutsideCurrentMonthboolfalse

如果为 true,则渲染当前月份之外的日期
- 如果定义了 fixedWeekNumber,则渲染日期以具有请求的周数。
- 如果未定义 fixedWeekNumber,则渲染日期以填充当前月份的第一周和最后一周。
- 如果范围选择器上的 calendars 等于多个 1,则忽略。

sxArray<func
| object
| bool>
| func
| object
-

允许定义系统覆盖以及其他 CSS 样式的系统 prop。

有关更多详细信息,请参见 `sx` 页面

todayboolfalse

如果为 true,则渲染为今天的日期。

TouchRipplePropsobject-

应用于 TouchRipple 元素的 Props。

touchRippleReffunc
| { current?: { pulsate: func, start: func, stop: func } }
-

指向 TouchRipple 元素的 ref。

ref 被转发到根元素。

CSS 类

这些类名对于使用 CSS 设置样式很有用。当触发特定状态时,它们将应用于组件的插槽。

类名规则名称描述
.MuiDateRangePickerDay-dayday应用于日期元素的样式。
.MuiDateRangePickerDay-dayInsideRangeIntervaldayInsideRangeInterval如果 selected=falseisHighlighting=true,则应用于日期元素的样式。
.MuiDateRangePickerDay-dayOutsideRangeIntervaldayOutsideRangeInterval如果 isHighlighting=false,则应用于日期元素的样式。
.MuiDateRangePickerDay-endOfMonthendOfMonth如果 day 是月末,则应用于根元素的样式。
.MuiDateRangePickerDay-firstVisibleCellfirstVisibleCell如果 day 是月份的第一个可见单元格,则应用于根元素的样式。
.MuiDateRangePickerDay-hiddenDayFillerhiddenDayFiller如果它是用于填充星期的空单元格,则应用于根元素的样式。
.MuiDateRangePickerDay-lastVisibleCelllastVisibleCell如果 day 是月份的最后一个可见单元格,则应用于根元素的样式。
.MuiDateRangePickerDay-notSelectedDatenotSelectedDate如果 selected=false,则应用于日期元素的样式。
.MuiDateRangePickerDay-outsideCurrentMonthoutsideCurrentMonth如果 outsideCurrentMonth=true,则应用于根元素的样式
.MuiDateRangePickerDay-rangeIntervalDayHighlightrangeIntervalDayHighlight如果 isHighlighting=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalDayHighlightEndrangeIntervalDayHighlightEnd如果 isEndOfHighlighting=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalDayHighlightStartrangeIntervalDayHighlightStart如果 isStartOfHighlighting=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalDayPreviewrangeIntervalDayPreview如果 isPreviewing=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalDayPreviewEndrangeIntervalDayPreviewEnd如果 isEndOfPreviewing=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalDayPreviewStartrangeIntervalDayPreviewStart如果 isStartOfPreviewing=true,则应用于根元素的样式。
.MuiDateRangePickerDay-rangeIntervalPreviewrangeIntervalPreview应用于预览元素的样式。
.MuiDateRangePickerDay-rootroot应用于根元素的样式。
.MuiDateRangePickerDay-startOfMonthstartOfMonth如果 day 是月初,则应用于根元素的样式。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中找不到所需的信息,请考虑查看组件的实现以获取更多详细信息。