StaticNextTimePicker API

API documentation for the React StaticNextTimePicker component. Learn about the available props and the CSS API.

Import

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

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiStaticNextTimePicker can be used when providing default props or style overrides in the theme.

Props

Name	Type	Default	Description
ampm	bool	`utils.is12HourCycleInCurrentLocale()`	12h/24h view for hour selection clock.
ampmInClock	bool	false	Display ampm controls under the clock (instead of in the toolbar).
className	string		Class name applied to the root element.
components	object	{}	Overrideable components.
componentsProps	object	{}	The props used for each component slot.
defaultValue	any		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 before 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 after 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	any		Maximal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minTime	any		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) => void` value: The value that was just accepted.
onChange	func		Callback fired when the value changes. Signature: `function(value: TValue, The: FieldChangeHandlerContext<TError>) => void` value: The new value. The: context containing the validation result of the current value.
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: View) => void` view: The new view.
openTo	'hours' \| 'minutes' \| 'seconds'		First view to show.
orientation	'landscape' \| 'portrait'		Force rendering in particular orientation.
shouldDisableTime	func		Disable specific time. Signature: `function(timeValue: number, view: TimeView) => boolean` timeValue: The value to check. view: The clock type of the timeValue. returns (boolean): If `true` the time will be disabled.
showToolbar	bool	`true` for mobile, `false` for desktop	If `true`, the toolbar will be visible.
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.
value	any		The selected value. Used when the component is controlled.
views	Array<'hours' \| 'minutes' \| 'seconds'>		Array of views to show.

Slots

Name	Type	Default	Description
ActionBar	elementType	PickersActionBar	Custom component for the action bar, it is placed bellow the picker views.
LeftArrowIcon	elementType	ArrowLeft	Icon displayed in the left view switch button.
NextIconButton	elementType	IconButton	Button allowing to switch to the right view.
PaperContent	elementType	React.Fragment	Custom component wrapping the views of the desktop and static pickers (it is the direct child of the Paper component).
PreviousIconButton	elementType	IconButton	Button allowing to switch to the left view.
RightArrowIcon	elementType	ArrowRight	Icon displayed in the right view switch button.
Toolbar	elementType	TimePickerToolbar	Custom component for the toolbar rendered above the views.

The ref is forwarded to the root element.

StaticNextTimePicker API

Import

Component name

Props

Slots

Demos