Skip to content

TimePicker API

API documentation for the React TimePicker component. Learn about the available props and the CSS API.

Import

import TimePicker from '@mui/lab/TimePicker';
// or
import { TimePicker } from '@mui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
onChange*func
Callback fired when the value (the selected date) changes @DateIOType.
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.
acceptRegexRegExp/\dap/gi
Regular expression to detect "accepted" symbols.
ampmboolfalse
12h/24h view for hour selection clock.
ampmInClockboolfalse
Display ampm controls under the clock (instead of in the toolbar).
cancelTextnode'Cancel'
Cancel text message.
classNamestring
className applied to the root component.
clearableboolfalse
If true, it shows the clear action in the picker dialog.
clearTextnode'Clear'
Clear text message.
components{ OpenPickerIcon?: elementType }
The components used for each slot. Either a string to use a HTML element or a component.
desktopModeMediaQuerystring'@media (pointer: fine)'
CSS media query when Mobile mode will be changed to Desktop.
DialogPropsobject
Props applied to the Dialog element.
disableCloseOnSelectbool`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.
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.
getOpenDialogAriaTextfunc(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`
Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType
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.
okTextnode'OK'
Ok button text.
onAcceptfunc
Callback fired when date is accepted @DateIOType.
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.
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onViewChangefunc
Callback fired on view change.
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.
PaperPropsobject
Paper props passed down to Paper component.
PopperPropsobject
Popper props passed down to Popper component.
readOnlyboolfalse
Make picker read only.
rifmFormatterfunc
Custom formatter to be passed into Rifm component.
shouldDisableTimefunc
Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.
showTodayButtonboolfalse
If true, the today button is displayed. Note that showClearButton has a higher priority.
showToolbarboolfalse
If true, show the toolbar even in desktop mode.
todayTextnode'Today'
Today text message.
ToolbarComponentelementTypeTimePickerToolbar
Component that will replace default toolbar renderer.
toolbarFormatstring
Date format, that is displaying in toolbar.
toolbarPlaceholdernode'–'
Mobile picker date value placeholder, displaying if value === null.
toolbarTitlenode'Select time'
Mobile picker title, displaying in the toolbar.
TransitionComponentelementType
Custom component for popper Transition.
valueany
| Date
| number
| string
The value of the picker.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
Array of views to show.

The ref is forwarded to the root element.

Demos