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/TimeClock';
// or
import { TimeClock } from '@mui/x-date-pickers';
// or
import { TimeClock } from '@mui/x-date-pickers-pro';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
ampm	bool	utils.is12HourCycleInCurrentLocale()	12h/24h view for hour selection clock.
ampmInClock	bool	false	Display ampm controls under the clock (instead of in the toolbar).
autoFocus	bool	-	If `true`, the main element is focused during the first mount. This main element is: - the element chosen by the visible view if any (i.e: the selected day on the `day` view). - the `input` element if there is a field rendered.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
defaultValue	object	-	The default selected value. Used when the component is not controlled.
disabled	bool	false	If `true`, the picker views and text field are disabled.
disableFuture	bool	false	If `true`, disable values after the current date for date components, time for time components and both for date time components.
disableIgnoringDatePartForTimeValidation	bool	false	Do not ignore date part when validating min/max time.
disablePast	bool	false	If `true`, disable values before the current date for date components, time for time components and both for date time components.
focusedView	'hours' \| 'minutes' \| 'seconds'	-	Controlled focused view.
maxTime	object	-	Maximal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minTime	object	-	Minimal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minutesStep	number	1	Step over minutes.
onChange	func	-	Callback fired when the value changes. Signature:`function(value: TValue, selectionState: PickerSelectionState \| undefined, selectedView: TView \| undefined) => void` `value` The new value. `selectionState` Indicates if the date selection is complete. `selectedView` Indicates the view in which the selection has been made.
onFocusedViewChange	func	-	Callback fired on focused view change. Signature:`function(view: TView, hasFocus: boolean) => void` `view` The new view to focus or not. `hasFocus` `true` if the view should be focused.
onViewChange	func	-	Callback fired on view change. Signature:`function(view: TView) => void` `view` The new view.
openTo	'hours' \| 'minutes' \| 'seconds'	-	The default visible view. Used when the component view is not controlled. Must be a valid option from `views` list.
readOnly	bool	false	If `true`, the picker views and text field are read-only.
referenceDate	object	The closest valid time using the validation props, except callbacks such as `shouldDisableTime`.	The date used to generate the new value when both `value` and `defaultValue` are empty.
shouldDisableTime	func	-	Disable specific time. Signature:`function(value: TDate, view: TimeView) => boolean` `value` The value to check. `view` The clock type of the timeValue. Returns: If `true` the time will be disabled.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<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.
timezone	string	The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.	Choose which timezone to use for the value. Example: "default", "system", "UTC", "America/New_York". If you pass values from other timezones to some props, they will be converted to this timezone before being used. See the timezones documentation for more details.
value	object	-	The selected value. Used when the component is controlled.
view	'hours' \| 'minutes' \| 'seconds'	-	The visible view. Used when the component view is controlled. Must be a valid option from `views` list.
views	Array<'hours' \| 'minutes' \| 'seconds'>	['hours', 'minutes']	Available views.

The ref is forwarded to the root element.

Theme default props

You can use MuiTimeClock to change the default props of this component with the theme.

Slots

Slot name	Default component	Description
leftArrowIcon	`ArrowLeft`	Icon displayed in the left view switch button.
nextIconButton	`IconButton`	Button allowing to switch to the right view.
previousIconButton	`IconButton`	Button allowing to switch to the left view.
rightArrowIcon	`ArrowRight`	Icon displayed in the right view switch button.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiTimeClock-arrowSwitcher	arrowSwitcher	Styles applied to the arrowSwitcher element.
.MuiTimeClock-root	root	Styles applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.