StaticTimePickerAPI

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

演示

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

导入

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

了解更多信息，请阅读有关最小化捆绑包大小的指南。

属性

名称	类型	默认值	描述
ampm	布尔值	utils.is12HourCycleInCurrentLocale()	小时选择时钟的 12 小时/24 小时视图。
ampmInClock	布尔值	桌面端为 true，移动端为 false	在时钟下方（而不是工具栏中）显示 ampm 控件。
autoFocus	布尔值	-	如果为 `true`，则在首次挂载期间聚焦主元素。此主元素是：- 可见视图选择的元素（如果有）（即：`day` 视图上选定的日期）。- 如果渲染了字段，则为 `input` 元素。
defaultValue	对象	-	默认值。当组件不受控制时使用。
disabled	布尔值	false	如果为 `true`，则禁用选择器和文本字段。
disableFuture	布尔值	false	如果为 `true`，则禁用日期组件的当前日期之后的值，时间组件的当前时间之后的值，以及日期时间组件的两者。
disableIgnoringDatePartForTimeValidation	布尔值	false	验证最小/最大时间时，请勿忽略日期部分。
disablePast	布尔值	false	如果为 `true`，则禁用日期组件的当前日期之前的值，时间组件的当前时间之前的值，以及日期时间组件的两者。
displayStaticWrapperAs	'desktop' \| 'mobile'	"mobile"	强制静态包装器内部组件以移动或桌面模式渲染。
localeText	对象	-	组件文本的区域设置。允许覆盖来自 `LocalizationProvider` 和 `theme` 的文本。
maxTime	对象	-	最大可选时间。除非 `props.disableIgnoringDatePartForTimeValidation === true`，否则将忽略对象的日期部分。
minTime	对象	-	最小可选时间。除非 `props.disableIgnoringDatePartForTimeValidation === true`，否则将忽略对象的日期部分。
minutesStep	数字	1	分钟步长。
onAccept	函数	-	当值被接受时触发的回调。签名：`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` 刚被接受的值。 `context` 包含当前值的验证结果的上下文。
onChange	函数	-	当值更改时触发的回调。签名：`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` 新值。 `context` 包含当前值的验证结果的上下文。
onClose	函数	-	当组件请求关闭时触发的回调。可以在选择（默认在 `desktop` 模式下）或清除值时触发。已弃用－请避免使用，因为它将在下一个主要版本中移除。
onError	函数	-	当与当前值关联的错误更改时触发的回调。当检测到验证错误时，`error` 参数包含非空值。这可以用于渲染适当的表单错误。签名：`function(error: TError, value: TValue) => void` `error` 当前值无效的原因。 `value` 与错误关联的值。
onViewChange	函数	-	视图更改时触发的回调。签名：`function(view: TView) => void` `view` 新视图。
openTo	'hours' \| 'minutes' \| 'seconds'	-	默认可见视图。当组件视图不受控制时使用。必须是 `views` 列表中的有效选项。
orientation	'landscape' \| 'portrait'	-	强制以特定方向渲染。
reduceAnimations	布尔值	`@media(prefers-reduced-motion: reduce)` \|\| `navigator.userAgent` 匹配 Android <10 或 iOS <13	如果为 `true`，则禁用繁重的动画。
referenceDate	对象	使用验证属性（除了 `shouldDisable<...>` 等回调）的最接近的有效日期时间。	当 `value` 和 `defaultValue` 都为空时，用于生成新值的日期。
shouldDisableTime	函数	-	禁用特定时间。签名：`function(value: TDate, view: TimeView) => boolean` `value` 要检查的值。 `view` timeValue 的时钟类型。返回值：如果为 `true`，则时间将被禁用。
slotProps	对象	{}	用于每个组件插槽的属性。
slots	对象	{}	可覆盖的组件插槽。有关更多详细信息，请参阅下面的 Slots API。
sx	Array<函数 \| 对象 \| 布尔值> \| 函数 \| 对象	-	允许定义系统覆盖以及其他 CSS 样式的系统属性。有关更多详细信息，请参阅 `sx` 页面。
timezone	字符串	`value` 或 `defaultValue` 属性的时区已定义，否则为“default”。	选择用于值的时区。示例：“default”、“system”、“UTC”、“America/New_York”。如果您将来自其他时区的值传递给某些属性，它们将在使用前转换为此时区。有关更多详细信息，请参阅时区文档。
value	对象	-	选定的值。当组件受控制时使用。
view	'hours' \| 'minutes' \| 'seconds'	-	可见视图。当组件视图受控制时使用。必须是 `views` 列表中的有效选项。
viewRenderers	{ hours?: 函数, minutes?: 函数, seconds?: 函数 }	-	为每个部分定义自定义视图渲染器。如果为 `null`，则该部分将仅具有字段编辑。如果为 `undefined`，则将使用内部定义的视图。
views	Array<'hours' \| 'minutes' \| 'seconds'>	-	可用视图。

ref 被转发到根元素。

插槽

插槽名称	默认组件	描述
actionBar	`PickersActionBar`	操作栏的自定义组件，它位于选择器视图下方。
layout		用于包装布局的自定义组件。它包装了工具栏、视图、操作栏和快捷方式。
leftArrowIcon	`ArrowLeft`	在左视图切换按钮中显示的图标。
nextIconButton	`IconButton`	允许切换到右侧视图的按钮。
previousIconButton	`IconButton`	允许切换到左侧视图的按钮。
rightArrowIcon	`ArrowRight`	在右视图切换按钮中显示的图标。
shortcuts	`PickersShortcuts`	快捷方式的自定义组件。
toolbar	`TimePickerToolbar`	在视图上方渲染的工具栏的自定义组件。

源代码

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