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/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

Name	Type	Default	Description
ampm	bool	utils.is12HourCycleInCurrentLocale()	12h/24h view for hour selection clock.
ampmInClock	bool	true on desktop, false on mobile	Display ampm controls under the clock (instead of in the toolbar).
autoFocus	bool	-	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.
defaultValue	object	-	The default value. Used when the component is not controlled.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableFuture	bool	false	If `true`, disable values after the current date for date components, time for time components and both for date time components.
disableIgnoringDatePartForTimeValidation	bool	false	Do not ignore date part when validating min/max time.
disablePast	bool	false	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.
localeText	object	-	Locale for components texts. Allows overriding texts coming from `LocalizationProvider` and `theme`.
maxTime	object	-	Maximal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minTime	object	-	Minimal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minutesStep	number	1	Step over minutes.
onAccept	func	-	Callback fired when the value is accepted. Signature:`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` The value that was just accepted. `context` The context containing the validation result of the current value.
onChange	func	-	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.
onClose	func	-	Callback fired when component requests to be closed. Can be fired when selecting (by default on `desktop` mode) or clearing a value. Deprecated－Please avoid using as it will be removed in next major version.
onError	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. 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.
onViewChange	func	-	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.
reduceAnimations	bool	`@media(prefers-reduced-motion: reduce)` \|\| `navigator.userAgent` matches Android <10 or iOS <13	If `true`, disable heavy animations.
referenceDate	object	The 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.
shouldDisableTime	func	-	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.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<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.
timezone	string	The 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.
value	object	-	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 used.
views	Array<'hours' \| 'minutes' \| 'seconds'>	-	Available views.

The ref is forwarded to the root element.

Slots

Slot name	Default component	Description
actionBar	`PickersActionBar`	Custom component for the action bar, it is placed below the picker views.
layout		Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.
leftArrowIcon	`ArrowLeft`	Icon displayed in the left view switch button.
nextIconButton	`IconButton`	Button allowing to switch to the right view.
previousIconButton	`IconButton`	Button allowing to switch to the left view.
rightArrowIcon	`ArrowRight`	Icon displayed in the right view switch button.
shortcuts	`PickersShortcuts`	Custom component for the shortcuts.
toolbar	`TimePickerToolbar`	Custom component for the toolbar rendered above the views.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.