Skip to content

DigitalClock API

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

Demos

Import

import { DigitalClock } from '@mui/x-date-pickers/DigitalClock';
// or
import { DigitalClock } from '@mui/x-date-pickers';
// or
import { DigitalClock } from '@mui/x-date-pickers-pro';

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

Props

NameTypeDefaultDescription
ampmbool`utils.is12HourCycleInCurrentLocale()`

12h/24h view for hour selection clock.

autoFocusbool-

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.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

defaultValueobject-

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

disabledboolfalse

If true, the picker views 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.

focusedView'hours'-

Controlled focused view.

maxTimeobject-

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

minTimeobject-

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: 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.
onFocusedViewChangefunc-

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

Callback fired on view change.

Signature:function(view: TView) => void
  • view The new view.
openTo'hours'-

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

readOnlyboolfalse

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

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

shouldDisableTimefunc-

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.

skipDisabledboolfalse

If true, disabled digital clock items will not be rendered.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overrideable component slots.

See Slots API below for more details.

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.

timeStepnumber30

The time steps between two time options. For example, if timeStep = 45, then the available time options will be [00:00, 00:45, 01:30, 02:15, 03:00, etc.].

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

valueobject-

The selected value. Used when the component is controlled.

view'hours'-

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

viewsArray<'hours'>['hours']

Available views.

The ref is forwarded to the root element.

Slots

Slot nameClass nameDefault componentDescription
digitalClockItemMenuItem from '@mui/material'Component responsible for rendering a single digital clock item.

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 nameRule nameDescription
.MuiDigitalClock-itemitemStyles applied to the list item (by default: MenuItem) element.
.MuiDigitalClock-listlistStyles applied to the list (by default: MenuList) element.
.MuiDigitalClock-rootrootStyles applied to the root element.

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