跳到内容

DigitalClockAPI

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

演示

导入

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

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

Props

原生组件的 Props 也可用。

名称类型默认值描述
ampmboolutils.is12HourCycleInCurrentLocale()

小时选择时钟的 12小时/24小时视图。

autoFocusbool-

如果 true,则在首次挂载期间,主元素会获得焦点。此主元素是:- 可见视图选择的元素(如果有)(即:day 视图上选定的日期)。- 如果渲染了字段,则为 input 元素。

classesobject-

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

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

defaultValueobject-

默认选定的值。当组件不受控制时使用。

disabledboolfalse

如果 true,则禁用选择器视图和文本字段。

disableFutureboolfalse

如果 true,则禁用日期组件的当前日期之后的值,时间组件的当前时间之后的值,以及日期时间组件的两者。

disableIgnoringDatePartForTimeValidationboolfalse

验证最小/最大时间时,不要忽略日期部分。

disablePastboolfalse

如果 true,则禁用日期组件的当前日期之前的值,时间组件的当前时间之前的值,以及日期时间组件的两者。

focusedView'hours'-

受控的焦点视图。

maxTimeobject-

最大可选择时间。除非 props.disableIgnoringDatePartForTimeValidation === true,否则将忽略对象的日期部分。

minTimeobject-

最小可选择时间。除非 props.disableIgnoringDatePartForTimeValidation === true,否则将忽略对象的日期部分。

minutesStepnumber1

分钟步长。

onChangefunc-

值更改时触发的回调。

签名:function(value: TValue, selectionState: PickerSelectionState | undefined, selectedView: TView | undefined) => void
  • value 新值。
  • selectionState 指示日期选择是否完成。
  • selectedView 指示进行选择的视图。
onFocusedViewChangefunc-

焦点视图更改时触发的回调。

签名:function(view: TView, hasFocus: boolean) => void
  • view 要聚焦或不聚焦的新视图。
  • hasFocus 如果视图应获得焦点,则为 true
onViewChangefunc-

视图更改时触发的回调。

签名:function(view: TView) => void
  • view 新视图。
openTo'hours'-

默认可见视图。当组件视图不受控制时使用。必须是 views 列表中的有效选项。

readOnlyboolfalse

如果 true,则选择器视图和文本字段为只读。

referenceDateobject使用验证 props 的最接近有效时间,回调(如 `shouldDisableTime`)除外。

valuedefaultValue 都为空时,用于生成新值的日期。

shouldDisableTimefunc-

禁用特定时间。

签名:function(value: TDate, view: TimeView) => boolean
  • value 要检查的值。
  • view timeValue 的时钟类型。

返回值:如果为 true,则时间将被禁用。

skipDisabledboolfalse

如果 true,则不会渲染禁用的数字时钟项。

slotPropsobject{}

用于每个组件插槽的 props。

slotsobject{}

可覆盖的组件插槽。

有关更多详细信息,请参阅下方的 Slots API

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

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

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

timeStepnumber30

两个时间选项之间的时间步长。例如,如果 timeStep = 45,则可用的时间选项将为 [00:00, 00:45, 01:30, 02:15, 03:00, 等等]

timezonestring`value` 或 `defaultValue` prop 的时区已定义,否则为“default”。

选择用于值的时区。示例:“default”、“system”、“UTC”、“America/New_York”。如果您将来自其他时区的值传递给某些 props,它们将在使用前转换为此时区。

有关更多详细信息,请参阅 时区文档

valueobject-

选定的值。当组件受控制时使用。

view'hours'-

可见视图。当组件视图受控制时使用。必须是 views 列表中的有效选项。

viewsArray<'hours'>['hours']

可用视图。

ref 被转发到根元素。

主题默认 Props

您可以使用 MuiDigitalClock 通过主题更改此组件的默认 props。

插槽

插槽名称类名默认组件描述
digitalClockItem来自 '@mui/material' 的 MenuItem负责渲染单个数字时钟项的组件。

CSS 类

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

类名规则名称描述
.MuiDigitalClock-itemitem应用于列表项(默认情况下:MenuItem)元素的样式。
.MuiDigitalClock-listlist应用于列表(默认情况下:MenuList)元素的样式。
.MuiDigitalClock-rootroot应用于根元素的样式。

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

源代码

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