TimePickerToolbar API

API reference docs for the React TimePickerToolbar 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:

Custom slots and subcomponents

Import

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

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

Props

Name	Type	Default	Description
onViewChange*	func	-	Callback called when a toolbar is clicked Signature:`function(view: TView) => void` `view` The view to open
view*	'hours' \| 'meridiem' \| 'minutes' \| 'seconds'	-	Currently visible picker view.
views*	Array<'hours' \| 'meridiem' \| 'minutes' \| 'seconds'>	-	Available views.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	false	If `true`, the component is disabled. When disabled, the value cannot be changed and no interaction is possible.
hidden	bool	`true` for Desktop, `false` for Mobile.	If `true`, show the toolbar even in desktop mode.
readOnly	bool	false	If `true`, the component is read-only. When read-only, the value cannot be changed but the user can interact with the interface.
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.
toolbarFormat	string	-	Toolbar date format.
toolbarPlaceholder	node	"––"	Toolbar value placeholder—it is displayed when the value is empty.

The component cannot hold a ref.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiTimePickerToolbar-ampmLabel	ampmLabel	Styles applied to the meridiem label element.
.MuiTimePickerToolbar-ampmLandscape	ampmLandscape	Styles applied to the meridiem selection element in landscape mode.
.MuiTimePickerToolbar-ampmSelection	ampmSelection	Styles applied to the meridiem selection element.
.MuiTimePickerToolbar-hourMinuteLabel	hourMinuteLabel	Styles applied to the time sections element.
.MuiTimePickerToolbar-hourMinuteLabelLandscape	hourMinuteLabelLandscape	Styles applied to the time sections element in landscape mode.
.MuiTimePickerToolbar-hourMinuteLabelReverse	hourMinuteLabelReverse	Styles applied to the time sections element in "rtl" theme mode.
.MuiTimePickerToolbar-root	root	Styles applied to the root element.
.MuiTimePickerToolbar-separator	separator	Styles applied to the separator element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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.