ClockPicker API

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

Import

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

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

Component name

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

Props

Name	Type	Default	Description
date^*	any		Selected date @DateIOType.
onChange^*	func		On change callback @DateIOType.
ampm	bool	false	12h/24h view for hour selection clock.
ampmInClock	bool	false	Display ampm controls under the clock (instead of in the toolbar).
autoFocus	bool	false	Set to `true` if focus should be moved to clock picker.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
components	object	{}	Overrideable components.
componentsProps	object	{}	The props used for each component slot.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableIgnoringDatePartForTimeValidation	bool	false	Do not ignore date part when validating min/max time.
getClockLabelText	func	<TDate extends any>( view: ClockView, time: TDate \| null, adapter: MuiPickersAdapter<TDate>, ) => `Select ${view}. ${ time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}` }`	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Accessible text that helps user to understand which time and view is selected. Signature: `function(view: ClockPickerView, time: TDate \| null, adapter: MuiPickersAdapter<TDate>) => string` view: The current view rendered. time: The current time. adapter: The current date adapter. returns (string): The clock label.
getHoursClockNumberText	func	(hours: string) => `${hours} hours`	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Get clock number aria-text for hours. Signature: `function(hours: string) => string` hours: The hours to format. returns (string): the formatted hours text.
getMinutesClockNumberText	func	(minutes: string) => `${minutes} minutes`	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Get clock number aria-text for minutes. Signature: `function(minutes: string) => string` minutes: The minutes to format. returns (string): the formatted minutes text.
getSecondsClockNumberText	func	(seconds: string) => `${seconds} seconds`	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Get clock number aria-text for seconds. Signature: `function(seconds: string) => string` seconds: The seconds to format. returns (string): the formatted seconds text.
leftArrowButtonText	string	'open previous view'	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Left arrow icon aria-label text.
maxTime	any		Max time acceptable time. For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
minTime	any		Min time acceptable time. For input validation date part of passed object will be ignored if `disableIgnoringDatePartForTimeValidation` not specified.
minutesStep	number	1	Step over minutes.
onViewChange	func		Callback fired on view change. Signature: `function(view: ClockPickerView) => void` view: The new view.
openTo	'hours' \| 'minutes' \| 'seconds'	'hours'	Initially open view.
readOnly	bool	false	Make picker read only.
rightArrowButtonText	string	'open next view'	Deprecated - Use the `localeText` prop of `LocalizationProvider` instead, see https://mui.com/x/react-date-pickers/localization/. Right arrow icon aria-label text.
shouldDisableTime	func		Dynamically check if time is disabled or not. If returns `false` appropriate time point will ot be acceptable. Signature: `function(timeValue: number, clockType: ClockPickerView) => boolean` timeValue: The value to check. clockType: The clock type of the timeValue. returns (boolean): Returns `true` if the time should be disabled
view	'hours' \| 'minutes' \| 'seconds'		Controlled open view.
views	Array<'hours' \| 'minutes' \| 'seconds'>	['hours', 'minutes']	Views for calendar picker.

Slots

Name	Type	Default	Description
LeftArrowButton	elementType	IconButton	Button allowing to switch to the left view.
LeftArrowIcon	elementType	ArrowLeft	Icon displayed in the left view switch button.
RightArrowButton	elementType	IconButton	Button allowing to switch to the right view.
RightArrowIcon	elementType	ArrowRight	Icon displayed in the right view switch button.

The ref is forwarded to the root element.

CSS

Rule name	Global class	Description
root	.MuiClockPicker-root	Styles applied to the root element.
arrowSwitcher	.MuiClockPicker-arrowSwitcher	Styles applied to the arrowSwitcher 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.

ClockPicker API

Import

Component name

Props

Slots

CSS

Demos