TimePicker API
API reference docs for the React TimePicker component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import { TimePicker } from '@mui/x-date-pickers/TimePicker';
// or
import { TimePicker } from '@mui/x-date-pickers';
// or
import { TimePicker } from '@mui/x-date-pickers-pro';Props of the native component are also available.
Display ampm controls under the clock (instead of in the toolbar).
Type:bool
Default:true on desktop, false on mobile
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
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).
CSS media query when Mobile mode will be changed to Desktop.
Type:string
Default:'@media (pointer: fine)'
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
Do not ignore date part when validating min/max time.
Type:bool
Default:false
If true, the open picker button will not be rendered (renders only the field).
Type:bool
Default:false
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
Format of the date when rendered in the input(s). Defaults to localized format based on the used views.
Type:string
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"
Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.
Type:object
Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
Type:any
Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.
Type:any
Callback fired when the value is accepted.
Type:func
function(value: TValue) => voidvalueThe value that was just accepted.
Callback fired when the value changes.
Type:func
function(value: TValue, context: FieldChangeHandlerContext) => void valueThe new value.contextThe context containing the validation result of the current value.
Callback fired when the popup requests to be closed. Use in controlled mode (see open).
Type:func
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
function(error: TError, value: TValue) => voiderrorThe new error describing why the current value is not valid.valueThe value associated to the error.
Callback fired when the popup requests to be opened. Use in controlled mode (see open).
Type:func
Callback fired when the selected sections change.
Type:func
function(newValue: FieldSelectedSections) => voidnewValueThe new selected sections.
Callback fired on view change.
Type:func
function(view: TView) => voidviewThe new view.
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'
If true, disable heavy animations.
Type:bool
Default:`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13
The date used to generate the new value when both value and defaultValue are empty.
Type:any
Default:The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.
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 }
Disable specific clock time.
Type:func
function(clockValue: number, view: TimeView) => booleanclockValueThe value to check.viewThe clock type of the timeValue.
Returns: If true the time will be disabled.
Disable specific time.
Type:func
function(value: TDate, view: TimeView) => booleanvalueThe value to check.viewThe clock type of the timeValue.
Returns: If true the time will be disabled.
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
Amount of time options below or at which the single column time renderer is used.
Type:number
Default:24
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 }
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.
The visible view. Used when the component view is controlled. Must be a valid option from views list.
Type:'hours'
| 'meridiem'
| 'minutes'
| 'seconds'
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 }
Custom component for the action bar, it is placed below the picker views.
Default component: PickersActionBar
Custom component for the paper rendered inside the desktop picker's Popper.
Default component: PickersPopperPaper
Custom component for the desktop popper Transition.
Default component: Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.
Custom component for trapping the focus inside the views on desktop.
Default component: FocusTrap from '@mui/base'.
Custom component for the dialog inside which the views are rendered on mobile.
Default component: PickersModalDialogRoot
Component responsible for rendering a single digital clock item.
Default component: MenuItem from '@mui/material'
Component responsible for rendering a single multi section digital clock section item.
Default component: MenuItem from '@mui/material'
Component displayed on the start or end input adornment used to open the picker on desktop.
Default component: InputAdornment
Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
Custom component for the paper rendered inside the mobile picker's Dialog.
Default component: Paper from '@mui/material'.
Custom component for the mobile dialog Transition.
Default component: Fade from '@mui/material'.
Custom component for the popper inside which the views are rendered on desktop.
Default component: Popper from '@mui/material'.
Form control with an input to render the value inside the default field. Receives the same props as @mui/material/TextField.
Default component: TextField from '@mui/material'