TimeField API

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

Import

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

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

Component name

The name MuiTimeField 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.
components	object	{}	Overrideable components.
componentsProps	object	{}	The props used for each component slot.
defaultValue	any		The default value. Use when the component is not controlled.
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.
format	string		Format of the date when rendered in the input(s).
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.
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. Signature: `function(error: TError, value: TValue) => void` error: The new error. value: The value associated to the error.
onSelectedSectionsChange	func		Callback fired when the selected sections change. Signature: `function(newValue: FieldSelectedSections) => void` newValue: The new selected sections.
readOnly	bool	false	It prevents the user from changing the value of the field (not from interacting with the field).
selectedSections	'day' \| 'hours' \| 'meridiem' \| 'minutes' \| 'month' \| 'seconds' \| 'year' \| number \| { endIndex: number, startIndex: number }		The currently selected sections. This prop accept four formats: 1. If a number is provided, the section at this index will be selected. 2. If an object with a `startIndex` and `endIndex` properties are provided, the sections between those two indexes will be selected. 3. If a string of type `MuiDateSectionName` is provided, the first section with that name will be selected. 4. If `null` is provided, no section will be selected If not provided, the selected sections will be handled internally.
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.
value	any		The selected value. Used when the component is controlled.

Slots

Name	Type	Default	Description
Input	elementType	TextField	Input rendered.

The component cannot hold a ref.

TimeField API

Import

Component name

Props

Slots

Demos