跳转到内容

MobileTimePicker API

想要学习更多组件属性和 CSS API,可以查阅 React MobileTimePicker 组件的 API 文档。

导入

import MobileTimePicker from '@mui/x-date-pickers-pro/MobileTimePicker';
// 或
import MobileTimePicker from '@mui/x-date-pickers/MobileTimePicker';
// 或
import { MobileTimePicker } from '@mui/x-date-pickers-pro';
// 或
import { MobileTimePicker } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

组件名称

The name MuiMobileTimePicker can be used when providing default props or style overrides in the theme.

属性

名称类型默认值描述
onChange*func
Callback fired when the value (the selected date) changes @DateIOType.

Signature:
function(value: TValue, keyboardInputValue: string) => void
value: The new parsed value.
keyboardInputValue: The current value of the keyboard input.
renderInput*func
The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

Signature:
function(props: MuiTextFieldPropsType) => React.ReactNode
props: The props of the input.
returns (React.ReactNode): The node to render as the input.
acceptRegexRegExp/\dap/gi
Regular expression to detect "accepted" symbols.
ampmbool`utils.is12HourCycleInCurrentLocale()`
12h/24h view for hour selection clock.
ampmInClockboolfalse
Display ampm controls under the clock (instead of in the toolbar).
classNamestring
className applied to the root component.
closeOnSelectbool`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
If true the popup or dialog will immediately close after submitting full date.
componentsobject{}
Overrideable components.
componentsPropsobject{}
The props used for each component slot.
DialogPropsobject
Props applied to the Dialog element.
disabledboolfalse
If true, the picker and text field are disabled.
disableIgnoringDatePartForTimeValidationboolfalse
Do not ignore date part when validating min/max time.
disableMaskedInputboolfalse
Disable mask on the keyboard, this should be used rarely. Consider passing proper mask for your format.
disableOpenPickerboolfalse
Do not render open picker button (renders only text field with validation).
getClockLabelTextfunc<TDate extends any>( view: ClockView, time: TDate | null, adapter: MuiPickersAdapter<TDate>, ) => `Select ${view}. ${ time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}` }`
Accessible text that helps user to understand which time and view is selected.

Signature:
function(view: ClockPickerView, time: TDate | null, adapter: MuiPickersAdapter<TDate>) => string
view: The current view rendered.
time: The current time.
adapter: The current date adapter.
returns (string): The clock label.
getOpenDialogAriaTextfunc(date, utils) => `Choose date, selected date is ${utils.format(utils.date(date), 'fullDate')}`
Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType

Signature:
function(date: TInputDate, utils: MuiPickersAdapter<TDate>) => string
date: The date from which we want to add an aria-text.
utils: The utils to manipulate the date.
returns (string): The aria-text to render inside the dialog.
InputAdornmentPropsobject
Props to pass to keyboard input adornment.
inputFormatstring
Format string.
inputReffunc
| { current?: object }
Pass a ref to the input element.
maskstring
Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M).
maxTimeany
Max time acceptable time. For input validation date part of passed object will be ignored if disableIgnoringDatePartForTimeValidation not specified.
minTimeany
Min time acceptable time. For input validation date part of passed object will be ignored if disableIgnoringDatePartForTimeValidation not specified.
minutesStepnumber1
Step over minutes.
onAcceptfunc
Callback fired when date is accepted @DateIOType.

Signature:
function(value: TValue) => void
value: The value that was just accepted.
onClosefunc
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfunc
Callback that fired when input value or new value prop validation returns new validation error (or value is valid after error). In case of validation error detected reason prop return non-null value and TextField must be displayed in error state. This can be used to render appropriate form error.
Read the guide about form integration and error displaying.

Signature:
function(reason: TError, value: TInputValue) => void
reason: The reason why the current value is not valid.
value: The invalid value.
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChangefunc
Callback fired on view change.

Signature:
function(view: ClockPickerView) => void
view: The new view.
openboolfalse
Control the popup or dialog open state.
OpenPickerButtonPropsobject
Props to pass to keyboard adornment button.
openTo'hours'
| 'minutes'
| 'seconds'
First view to show.
orientation'landscape'
| 'portrait'
Force rendering in particular orientation.
readOnlyboolfalse
Make picker read only.
rifmFormatterfunc
Custom formatter to be passed into Rifm component.

Signature:
function(str: string) => string
str: The un-formatted string.
returns (string): The formatted string.
shouldDisableTimefunc
Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

Signature:
function(timeValue: number, clockType: ClockPickerView) => boolean
timeValue: The value to check.
clockType: The clock type of the timeValue.
returns (boolean): Returns true if the time should be disabled
showToolbarboolfalse
If true, show the toolbar even in desktop mode.
ToolbarComponentelementTypeTimePickerToolbar
Component that will replace default toolbar renderer.
toolbarTitlenode'Select time'
Mobile picker title, displaying in the toolbar.
valueany
The value of the picker.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
Array of views to show.

ref 则会被传递到根元素中。

演示项目