Skip to content

TimePicker API

API reference docs for the React TimePicker component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Component name

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

Props

NameTypeDefaultDescription
onChange*func
Callback fired when the value (the selected date) changes @DateIOType.

Signature:
function(value: TValue, keyboardInputValue: string) => void
value: The new 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.
desktopModeMediaQuerystring'@media (pointer: fine)'
CSS media query when Mobile mode will be changed to Desktop.
disabledboolfalse
If true, the picker and text field are disabled.
disableFutureboolfalse
If true, disable values after the current date for date components, time for time components and both for date time components.
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).
disablePastboolfalse
If true, disable values before the current date for date components, time for time components and both for date time components.
getOpenDialogAriaTextfunc(date, utils) => `Choose date, selected date is ${utils.format(date, 'fullDate')}`
Get aria-label text for control that opens picker dialog. Aria-label text must include selected date. @DateIOType

Signature:
function(date: TDate | null, 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.
localeTextobject
Locale for components texts
maskstring
Custom mask. Can be used to override generate from format. (e.g. __/__/____ __:__ or __/__/____ __:__ _M).
maxTimeany
Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
minTimeany
Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
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: TValue) => 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: TimeView) => 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'
'hours'
First view to show. Must be a valid option from views list
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
Disable specific time.

Signature:
function(timeValue: number, view: TimeView) => boolean
timeValue: The value to check.
view: The clock type of the timeValue.
returns (boolean): If true the time will be disabled.
showToolbarboolfalse
If true, show the toolbar even in desktop mode.
valueany
The value of the picker.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
['hours', 'minutes']
Array of views to show.

Slots

NameTypeDefaultDescription
ActionBarelementTypePickersActionBar
Custom component for the action bar, it is placed bellow the picker views.
DesktopPaperelementTypePickersPopperPaper
Custom component for the paper rendered inside the desktop picker's Popper.
DesktopTransitionelementTypeGrow from @mui/material
Custom component for the desktop popper Transition.
DesktopTrapFocuselementTypeTrapFocus from @mui/material
Custom component for trapping the focus inside the views on desktop.
DialogelementTypePickersModalDialogRoot
Custom component for the dialog inside which the views are rendered on mobile.
LeftArrowIconelementTypeArrowLeft
Icon displayed in the left view switch button.
MobilePaperelementTypePaper from @mui/material
Custom component for the paper rendered inside the mobile picker's Dialog.
MobileTransitionelementTypeFade from @mui/material
Custom component for the mobile dialog Transition.
NextIconButtonelementTypeIconButton
Button allowing to switch to the right view.
OpenPickerIconelementTypeCalendar or Clock
Icon displayed in the open picker button.
PaperContentelementTypeReact.Fragment
Custom component wrapping the views of the desktop and static pickers (it is the direct child of the Paper component).
PopperelementTypePopper from @mui/material
Custom component for the popper inside which the views are rendered on desktop.
PreviousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
RightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
ToolbarelementTypeTimePickerToolbar
Custom component for the toolbar rendered above the views.
The ref is forwarded to the root element.