Skip to content

DesktopTimePicker API

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

Component name

The name MuiDesktopTimePicker 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.
ampmInClockbooltrue on desktop, false on mobile
Display ampm controls under the clock (instead of in the toolbar).
autoFocusboolfalse
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.
classNamestring
Class name applied to the root element.
closeOnSelectbool`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
If true, the popover or modal will close after submitting the full date.
componentsobject{}
Overridable components.
componentsPropsobject{}
The props used for each component slot.
defaultValueany
The default 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.
disableOpenPickerboolfalse
If true, the open picker button will not be rendered (renders only the field).
disablePastboolfalse
If true, disable values before the current date for date components, time for time components and both for date time components.
formatstring
Format of the date when rendered in the input(s). Defaults to localized format based on the used views.
formatDensity'dense'
| 'spacious'
"dense"
Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.
inputReffunc
| { current?: object }
Pass a ref to the input element.
labelnode
The label content.
localeTextobject
Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.
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.
onAcceptfunc
Callback fired when the value is accepted.

Signature:
function(value: TValue) => void
value: The value that was just accepted.
onChangefunc
Callback fired when the value changes.

Signature:
function(value: TValue, context: FieldChangeHandlerContext<TError>) => void
value: The new value.
context: The context containing the validation result of the current value.
onClosefunc
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
onErrorfunc
Callback fired when the error associated to the current value changes. If the error has a non-null value, then the TextField will be rendered in error state.

Signature:
function(error: TError, value: TValue) => void
error: The new error describing why the current value is not valid.
value: The value associated to the error.
onOpenfunc
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
onSelectedSectionsChangefunc
Callback fired when the selected sections change.

Signature:
function(newValue: FieldSelectedSections) => void
newValue: The new selected sections.
onViewChangefunc
Callback fired on view change.

Signature:
function(view: TView) => void
view: The new view.
openboolfalse
Control the popup or dialog open state.
openTo'hours'
| 'meridiem'
| 'minutes'
| 'seconds'
The default visible view. Used when the component view is not controlled. Must be a valid option from views list.
orientation'landscape'
| 'portrait'
Force rendering in particular orientation.
selectedSections'all'
| 'day'
| 'hours'
| 'meridiem'
| 'minutes'
| 'month'
| 'seconds'
| 'weekDay'
| 'year'
| number
| { endIndex: number, startIndex: number }
The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a startIndex and endIndex properties are provided, the sections between those two indexes will be selected. 3. If a string of type FieldSectionType is provided, the first section with that name will be selected. 4. If null is provided, no section will be selected If not provided, the selected sections will be handled internally.
shouldDisableClockfunc
Disable specific clock time.

Signature:
function(clockValue: number, view: TimeView) => boolean
clockValue: The value to check.
view: The clock type of the timeValue.
returns (boolean): If true the time will be disabled.
shouldDisableTimefunc
Disable specific time.

Signature:
function(value: TDate, view: TimeView) => boolean
value: The value to check.
view: The clock type of the timeValue.
returns (boolean): 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{}
Overridable component slots.
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.
thresholdToRenderTimeInASingleColumnnumber24
Amount of time options below or at which the single column time renderer is used.
timeSteps{ hours?: number, minutes?: number, seconds?: number }{ hours: 1, minutes: 5, seconds: 5 }
The time steps between two time unit options. For example, if timeStep.minutes = 8, then the available minute options will be [0, 8, 16, 24, 32, 40, 48, 56]. When single column time renderer is used, only timeStep.minutes will be used.
valueany
The selected value. Used when the component is controlled.
view'hours'
| 'meridiem'
| 'minutes'
| 'seconds'
The visible view. Used when the component view is controlled. Must be a valid option from views list.
viewRenderers{ hours?: func, meridiem?: func, minutes?: func, seconds?: func }
Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be the used.
viewsArray<'hours'
| 'minutes'
| 'seconds'>
Available views.

Slots

NameTypeDefaultDescription
ActionBarelementTypePickersActionBar
Custom component for the action bar, it is placed below the picker views.
DesktopPaperelementTypePickersPopperPaper
Custom component for the paper rendered inside the desktop picker's Popper.
DesktopTransitionelementTypeGrow from @mui/material
Custom component for the desktop popper Transition.
DesktopTrapFocuselementTypeTrapFocus from @mui/material
Custom component for trapping the focus inside the views on desktop.
DigitalClockItemelementTypeMenuItem from '@mui/material'
Component responsible for rendering a single digital clock item.
DigitalClockSectionItemelementTypeMenuItem from '@mui/material'
Component responsible for rendering a single multi section digital clock section item.
FieldelementType
Component used to enter the date with the keyboard.
InputAdornmentelementTypeInputAdornment
Component displayed on the start or end input adornment used to open the picker on desktop.
LayoutelementType
Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
LeftArrowIconelementTypeArrowLeft
Icon displayed in the left view switch button.
NextIconButtonelementTypeIconButton
Button allowing to switch to the right view.
OpenPickerButtonelementTypeIconButton
Button to open the picker on desktop.
OpenPickerIconelementType
Icon displayed in the open picker button on desktop.
PopperelementTypePopper from @mui/material
Custom component for the popper inside which the views are rendered on desktop.
PreviousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
RightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
ShortcutselementTypePickersShortcuts
Custom component for the shortcuts.
TextFieldelementTypeTextField from '@mui/material'
Form control with an input to render the value inside the default field. Receives the same props as @mui/material/TextField.
ToolbarelementTypeTimePickerToolbar
Custom component for the toolbar rendered above the views.
The ref is forwarded to the root element.