Skip to content
Edit this page

TimePicker API

API reference docs for the React TimePicker 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 TimePicker from '/packages/x-date-pickers/src/TimePicker';
// or
import { TimePicker } from '/packages/x-date-pickers/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

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:

true on desktop, false on mobile
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
className

Class name applied to the root element.

Type:

string
closeOnSelect

If true, the popover or modal will close after submitting the full date.

Type:

bool

Default:

`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
components

Overridable components.

Type:

object

Default:

{}
componentsProps

The props used for each component slot.

Type:

object

Default:

{}
defaultValue

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

Type:

any
desktopModeMediaQuery

CSS media query when Mobile mode will be changed to Desktop.

Type:

string

Default:

'@media (pointer: fine)'
disabled

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

If true, the open picker button will not be rendered (renders only the field).

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
format

Format of the date when rendered in the input(s). Defaults to localized format based on the used views.

Type:

string
formatDensity

Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.

Type:

'dense' | 'spacious'

Default:

"dense"
inputRef

Pass a ref to the input element.

Type:

func | { current?: object }
label

The label content.

Type:

node
localeText

Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.

Type:

object
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
onAccept

Callback fired when the value is accepted.

Type:

func

Signature:

function(value: TValue) => void
  • value The value that was just accepted.
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The new value.
  • context The context containing the validation result of the current value.
onClose

Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Type:

func
onError

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.

Type:

func

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

Callback fired when the popup requests to be opened. Use in controlled mode (see open).

Type:

func
onSelectedSectionsChange

Callback fired when the selected sections change.

Type:

func

Signature:

function(newValue: FieldSelectedSections) => void
  • newValue The new selected sections.
onViewChange

Callback fired on view change.

Type:

func

Signature:

function(view: TView) => void
  • view The new view.
open

Control the popup or dialog open state.

Type:

bool
openTo

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

Type:

'hours' | 'meridiem' | 'minutes' | 'seconds'
orientation

Force rendering in particular orientation.

Type:

'landscape' | 'portrait'
selectedSections

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.

Type:

'all' | 'day' | 'hours' | 'meridiem' | 'minutes' | 'month' | 'seconds' | 'weekDay' | 'year' | number | { endIndex: number, startIndex: number }
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.

skipDisabled

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

Type:

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

Amount of time options below or at which the single column time renderer is used.

Type:

number

Default:

24
timeSteps

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.

Type:

{ hours?: number, minutes?: number, seconds?: number }

Default:

{ hours: 1, minutes: 5, seconds: 5 }
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' | 'meridiem' | 'minutes' | 'seconds'
viewRenderers

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.

Type:

{ hours?: func, meridiem?: func, minutes?: func, seconds?: func }
views

Available views.

Type:

Array<'hours' | 'minutes' | 'seconds'>
The component cannot hold a ref.

Slots

actionBar

Default: PickersActionBar

Description: Custom component for the action bar, it is placed below the picker views.

desktopPaper

Default: PickersPopperPaper

Description: Custom component for the paper rendered inside the desktop picker's Popper.

desktopTransition

Default: Grow from '@mui/material'.

Description: Custom component for the desktop popper Transition.

desktopTrapFocus

Default: TrapFocus from '@mui/material'.

Description: Custom component for trapping the focus inside the views on desktop.

dialog

Default: PickersModalDialogRoot

Description: Custom component for the dialog inside which the views are rendered on mobile.

digitalClockItem

Default: MenuItem from '@mui/material'

Description: Component responsible for rendering a single digital clock item.

digitalClockSectionItem

Default: MenuItem from '@mui/material'

Description: Component responsible for rendering a single multi section digital clock section item.

field

Default:

Description: Component used to enter the date with the keyboard.

inputAdornment

Default: InputAdornment

Description: Component displayed on the start or end input adornment used to open the picker on desktop.

layout

Default:

Description: Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.

leftArrowIcon

Default: ArrowLeft

Description: Icon displayed in the left view switch button.

mobilePaper

Default: Paper from '@mui/material'.

Description: Custom component for the paper rendered inside the mobile picker's Dialog.

mobileTransition

Default: Fade from '@mui/material'.

Description: Custom component for the mobile dialog Transition.

nextIconButton

Default: IconButton

Description: Button allowing to switch to the right view.

openPickerButton

Default: IconButton

Description: Button to open the picker on desktop.

openPickerIcon

Default:

Description: Icon displayed in the open picker button on desktop.

popper

Default: Popper from '@mui/material'.

Description: Custom component for the popper inside which the views are rendered on desktop.

previousIconButton

Default: IconButton

Description: Button allowing to switch to the left view.

rightArrowIcon

Default: ArrowRight

Description: Icon displayed in the right view switch button.

shortcuts

Default: PickersShortcuts

Description: Custom component for the shortcuts.

textField

Default: TextField from '@mui/material'

Description: Form control with an input to render the value inside the default field. Receives the same props as @mui/material/TextField.

toolbar

Default: TimePickerToolbar

Description: Custom component for the toolbar rendered above the views.

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