TimeClockAPI

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

演示

有关此 React 组件的用法示例和详细信息，请访问组件演示页面

导入

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

通过阅读本指南，了解有关最小化捆绑包大小的差异。

Props

原生组件的 Props 也可用。

名称	类型	默认值	描述
ampm	布尔值	utils.is12HourCycleInCurrentLocale()	用于小时选择时钟的 12 小时制/24 小时制视图。
ampmInClock	布尔值	false	在时钟下方（而不是在工具栏中）显示 ampm 控件。
autoFocus	布尔值	-	如果为 `true`，则在首次挂载期间主元素将获得焦点。此主元素是：- 可见视图选择的元素（如果有）（即：`day` 视图上选定的日期）。- 如果渲染了字段，则为 `input` 元素。
classes	对象	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参阅下面的 CSS 类 API。
defaultValue	对象	-	默认选定值。当组件不受控制时使用。
disabled	布尔值	false	如果为 `true`，则禁用选择器视图和文本字段。
disableFuture	布尔值	false	如果为 `true`，则禁用日期组件的当前日期之后的值，时间组件的时间以及日期时间组件的两者。
disableIgnoringDatePartForTimeValidation	布尔值	false	在验证最小/最大时间时，请勿忽略日期部分。
disablePast	布尔值	false	如果为 `true`，则禁用日期组件的当前日期之前的值，时间组件的时间以及日期时间组件的两者。
focusedView	'hours' \| 'minutes' \| 'seconds'	-	受控的焦点视图。
maxTime	对象	-	最大可选择时间。除非 `props.disableIgnoringDatePartForTimeValidation === true`，否则将忽略对象的日期部分。
minTime	对象	-	最小可选择时间。除非 `props.disableIgnoringDatePartForTimeValidation === true`，否则将忽略对象的日期部分。
minutesStep	数字	1	分钟步长。
onChange	函数	-	值更改时触发的回调。签名：`function(value: TValue, selectionState: PickerSelectionState \| undefined, selectedView: TView \| undefined) => void` `value` 新值。 `selectionState` 指示日期选择是否完成。 `selectedView` 指示在哪个视图中进行了选择。
onFocusedViewChange	函数	-	焦点视图更改时触发的回调。签名：`function(view: TView, hasFocus: boolean) => void` `view` 要聚焦或不聚焦的新视图。 `hasFocus` 如果视图应聚焦，则为 `true`。
onViewChange	函数	-	视图更改时触发的回调。签名：`function(view: TView) => void` `view` 新视图。
openTo	'hours' \| 'minutes' \| 'seconds'	-	默认可见视图。当组件视图不受控制时使用。必须是 `views` 列表中的有效选项。
readOnly	布尔值	false	如果为 `true`，则选择器视图和文本字段为只读。
referenceDate	对象	使用验证 props 的最接近的有效时间，但回调（如 `shouldDisableTime`）除外。	当 `value` 和 `defaultValue` 都为空时，用于生成新值的日期。
shouldDisableTime	函数	-	禁用特定时间。签名：`function(value: TDate, view: TimeView) => boolean` `value` 要检查的值。 `view` timeValue 的时钟类型。返回值：如果为 `true`，则时间将被禁用。
slotProps	对象	{}	用于每个组件插槽的 props。
slots	对象	{}	可覆盖的组件插槽。有关更多详细信息，请参阅下面的插槽 API。
sx	Array<函数 \| 对象 \| 布尔值> \| 函数 \| 对象	-	允许定义系统覆盖以及其他 CSS 样式的系统 prop。有关更多详细信息，请参阅 `sx` 页面。
timezone	字符串	定义了 `value` 或 `defaultValue` prop 的时区，否则为“default”。	选择要用于值的时区。示例：“default”、“system”、“UTC”、“America/New_York”。如果您将其他时区的值传递给某些 props，它们将在使用前转换为此时区。有关更多详细信息，请参阅时区文档。
value	对象	-	选定值。当组件受控制时使用。
view	'hours' \| 'minutes' \| 'seconds'	-	可见视图。当组件视图受控制时使用。必须是 `views` 列表中的有效选项。
views	Array<'hours' \| 'minutes' \| 'seconds'>	['hours', 'minutes']	可用视图。

ref 被转发到根元素。

主题默认 props

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

插槽

插槽名称	默认组件	描述
leftArrowIcon	`ArrowLeft`	在左侧视图切换按钮中显示的图标。
nextIconButton	`IconButton`	允许切换到右侧视图的按钮。
previousIconButton	`IconButton`	允许切换到左侧视图的按钮。
rightArrowIcon	`ArrowRight`	在右侧视图切换按钮中显示的图标。

CSS 类

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

类名	规则名称	描述
.MuiTimeClock-arrowSwitcher	arrowSwitcher	应用于 arrowSwitcher 元素的样式。
.MuiTimeClock-root	root	应用于根元素的样式。

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

使用全局类名。
在自定义主题中，使用规则名称作为组件 styleOverrides 属性的一部分。

源代码

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