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

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { StaticTimePicker } from '@mui/x-date-pickers-pro/StaticTimePicker';
// or
import { StaticTimePicker } from '@mui/x-date-pickers/StaticTimePicker';
// or
import { StaticTimePicker } from '@mui/x-date-pickers-pro';
// or
import { StaticTimePicker } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiStaticTimePicker 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.
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.
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.
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 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.
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.
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.
valueany
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.

Slots

NameTypeDefaultDescription
ActionBarelementTypePickersActionBar
Custom component for the action bar, it is placed below the picker views.
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.
PreviousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
RightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
ShortcutselementTypePickersShortcuts
Custom component for the shortcuts.
ToolbarelementTypeTimePickerToolbar
Custom component for the toolbar rendered above the views.
The ref is forwarded to the root element.