Skip to content

StaticTimePicker API

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

Demos

Import

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

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

Props

NameTypeDefaultDescription
ampmboolutils.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).

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.

defaultValueobject-

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.

disablePastboolfalse

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

displayStaticWrapperAs'desktop'
| 'mobile'
"mobile"

Force static wrapper inner components to be rendered in mobile or desktop mode.

localeTextobject-

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

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.

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) => void
  • value The new value.
  • context The context containing the validation result of the current value.
onClosefunc-

Callback fired when component requests to be closed. Can be fired when selecting (by default on desktop mode) or clearing a value.

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

Callback fired on view change.

Signature:function(view: TView) => void
  • view The new view.
openTo'hours'
| '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.

reduceAnimationsbool`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13

If true, disable heavy animations.

referenceDateobjectThe closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.

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.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

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

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'
| 'minutes'
| 'seconds'
-

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

viewRenderers{ hours?: 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.

The ref is forwarded to the root element.

Slots

Slot nameClass nameDefault componentDescription
toolbarTimePickerToolbarCustom component for the toolbar rendered above the views.
previousIconButtonIconButtonButton allowing to switch to the left view.
nextIconButtonIconButtonButton allowing to switch to the right view.
leftArrowIconArrowLeftIcon displayed in the left view switch button.
rightArrowIconArrowRightIcon displayed in the right view switch button.
actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
shortcutsPickersShortcutsCustom component for the shortcuts.
layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.