Skip to content
Edit this page

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 '/packages/x-date-pickers/src/TimeClock';
// or
import { TimeClock } from '/packages/x-date-pickers/src';
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
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
components

Overridable components.

Type:

object

Default:

{}
componentsProps

The props used for each component slot.

Type:

object

Default:

{}
defaultValue

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

Type:

any
disabled

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

Type:

bool
disableFuture

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

Type:

bool
disableIgnoringDatePartForTimeValidation

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

Type:

bool
disablePast

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

Type:

bool
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:

any
minTime

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

Type:

any
minutesStep

Step over minutes.

Type:

number

Default:

1
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TDate | null, 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
referenceDate

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

Type:

any

Default:

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

Disable specific clock time.

Type:

func

Signature:

function(clockValue: number, view: TimeView) => boolean
  • clockValue The value to check.
  • view The clock type of the timeValue.

Returns: If true the time will be disabled.

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.

Type:

object

Default:

{}
sx

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 documention 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:

any
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'>
The ref is forwarded to the root element.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiTimeClock-rootroot

Styles applied to the root element.

.MuiTimeClock-arrowSwitcherarrowSwitcher

Styles applied to the arrowSwitcher element.

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

Slots

leftArrowIcon

Default: ArrowLeft

Description: Icon displayed in the left view switch button.

nextIconButton

Default: IconButton

Description: Button allowing to switch to the right view.

previousIconButton

Default: IconButton

Description: Button allowing to switch to the left view.

rightArrowIcon

Default: ArrowRight

Description: Icon displayed in the right view switch button.

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