TimeClock API

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

Component 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.

ampm

12h/24h view for hour selection clock.

Type:bool

Default:`utils.is12HourCycleInCurrentLocale()`

ampmInClock

Display ampm controls under the clock (instead of in the toolbar).

Type:bool

Default:false

autoFocus

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.

Type:bool

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

defaultValue

The default selected value. Used when the component is not controlled.

Type:object

disabled

If true, the picker views and text field are disabled.

Type:bool

Default:false

disableFuture

If true, disable values after the current date for date components, time for time components and both for date time components.

Type:bool

Default:false

disableIgnoringDatePartForTimeValidation

Do not ignore date part when validating min/max time.

Type:bool

Default:false

disablePast

If true, disable values before the current date for date components, time for time components and both for date time components.

Type:bool

Default:false

focusedView

Controlled focused view.

Type:'hours' | 'minutes' | 'seconds'

maxTime

Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

Type:object

minTime

Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

Type:object

minutesStep

Step over minutes.

Type:number

Default:1

onChange

Callback fired when the value changes.

Type:func

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

Callback fired on focused view change.

Type:func

Signature:

function(view: TView, hasFocus: boolean) => void

view The new view to focus or not.
hasFocus true if the view should be focused.

onViewChange

Callback fired on view change.

Type:func

Signature:

function(view: TView) => void

view The new view.

openTo

The default visible view. Used when the component view is not controlled. Must be a valid option from views list.

Type:'hours' | 'minutes' | 'seconds'

readOnly

If true, the picker views and text field are read-only.

Type:bool

Default:false

referenceDate

The date used to generate the new value when both value and defaultValue are empty.

Type:object

Default:The closest valid time using the validation props, except callbacks such as `shouldDisableTime`.

shouldDisableTime

Disable specific time.

Type:func

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

The props used for each component slot.

Type:object

Default:{}

slots

Overridable component slots.

See Slots API below for more details.

Type:object

Default:{}

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

timezone

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.

Type:string

Default:The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.

value

The selected value. Used when the component is controlled.

Type:object

view

The visible view. Used when the component view is controlled. Must be a valid option from views list.

Type:'hours' | 'minutes' | 'seconds'

views

Available views.

Type:Array<'hours' | 'minutes' | 'seconds'>

Default:['hours', 'minutes']

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

previousIconButton

Button allowing to switch to the left view.

Default component: IconButton

nextIconButton

Button allowing to switch to the right view.

Default component: IconButton

leftArrowIcon

Icon displayed in the left view switch button.

Default component: ArrowLeft

rightArrowIcon

Icon displayed in the right view switch button.

Default component: ArrowRight

CSS classes

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

.MuiTimeClock-arrowSwitcher

Styles applied to the arrowSwitcher element.

Rule name:arrowSwitcher

.MuiTimeClock-root

Styles applied to the root element.

Rule name:root

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.