Skip to content

TimeClock API

API reference docs for the React TimeClock 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 { TimeClock } from '@mui/x-date-pickers-pro/TimeClock';
// or
import { TimeClock } from '@mui/x-date-pickers/TimeClock';
// or
import { TimeClock } from '@mui/x-date-pickers-pro';
// or
import { TimeClock } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

NameTypeDefaultDescription
ampmbool`utils.is12HourCycleInCurrentLocale()`
12h/24h view for hour selection clock.
ampmInClockboolfalse
Display ampm controls under the clock (instead of in the toolbar).
autoFocusboolfalse
Set to true if focus should be moved to clock picker.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentsobject{}
Overrideable components.
componentsPropsobject{}
The props used for each component slot.
defaultValueany
The default selected value. Used when the component is not controlled.
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.
disablePastboolfalse
If true, disable values before the current date for date components, time for time components and both for date time components.
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.
onChangefunc
Callback fired when the value changes.

Signature:
function(value: TDate | null, selectionState: PickerSelectionState | undefined) => void
value: The new value.
selectionState: Indicates if the date selection is complete.
onViewChangefunc
Callback fired on view change.

Signature:
function(view: TimeView) => void
view: The new view.
openTo'hours'
| 'minutes'
| 'seconds'
'hours'
Initially open view.
readOnlyboolfalse
Make picker read only.
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.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
valueany
The selected value. Used when the component is controlled.
view'hours'
| 'minutes'
| 'seconds'
Controlled open view.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
['hours', 'minutes']
Views for calendar picker.

Slots

NameTypeDefaultDescription
LeftArrowIconelementTypeArrowLeft
Icon displayed in the left view switch button.
NextIconButtonelementTypeIconButton
Button allowing to switch to the right view.
PreviousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
RightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiTimeClock-rootStyles applied to the root element.
arrowSwitcher.MuiTimeClock-arrowSwitcherStyles applied to the arrowSwitcher element.

You can override the style of the component using one of these customization options: