TimeField API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

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

Props

Props of the native component are also available.

Name	Type	Default	Description
ampm	bool	`utils.is12HourCycleInCurrentLocale()`	12h/24h view for hour selection clock.
autoFocus	bool	false	If `true`, the `input` element is focused during the first mount.
clearable	bool	false	If `true`, a clear button will be shown in the field allowing value clearing.
color	'error' \| 'info' \| 'primary' \| 'secondary' \| 'success' \| 'warning'	'primary'	The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
defaultValue	object		The default value. Use when the component is not controlled.
disabled	bool	false	If `true`, the component is 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.
focused	bool		If `true`, the component is displayed in focused state.
format	string		Format of the date when rendered in the input(s).
formatDensity	'dense' \| 'spacious'	"dense"	Density of the format when rendered in the input. Setting `formatDensity` to `"spacious"` will add a space before and after each `/`, `-` and `.` character.
FormHelperTextProps	object		Props applied to the `FormHelperText` element.
fullWidth	bool	false	If `true`, the input will take up the full width of its container.
helperText	node		The helper text content.
hiddenLabel	bool	false	If `true`, the label is hidden. This is used to increase density for a `FilledInput`. Be sure to add `aria-label` to the `input` element.
id	string		The id of the `input` element. Use this prop to make `label` and `helperText` accessible for screen readers.
InputLabelProps	object		Props applied to the `InputLabel` element. Pointer events like `onClick` are enabled if and only if `shrink` is `true`.
inputProps	object		Attributes applied to the `input` element.
InputProps	object		Props applied to the Input element. It will be a `FilledInput`, `OutlinedInput` or `Input` component depending on the `variant` prop value.
inputRef	ref		Pass a ref to the `input` element.
label	node		The label content.
margin	'dense' \| 'none' \| 'normal'	'none'	If `dense` or `normal`, will adjust vertical spacing of this and contained components.
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.
name	string		Name attribute of the `input` element.
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.
onClear	func		Callback fired when the clear button is clicked.
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).
referenceDate	object	The closest valid date using the validation props, except callbacks such as `shouldDisableDate`. Value is rounded to the most granular section used.	The date used to generate a part of the new value that is not present in the format when both `value` and `defaultValue` are empty. For example, on time fields it will be used to determine the date to set.
required	bool	false	If `true`, the label is displayed as required and the `input` element is required.
selectedSections	'all' \| 'day' \| 'empty' \| 'hours' \| 'meridiem' \| 'minutes' \| 'month' \| 'seconds' \| 'weekDay' \| '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 `FieldSectionType` 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(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.
shouldRespectLeadingZeros	bool	`false`	If `true`, the format will respect the leading zeroes (e.g: on dayjs, the format `M/D/YYYY` will render `8/16/2018`) If `false`, the format will always add leading zeroes (e.g: on dayjs, the format `M/D/YYYY` will render `08/16/2018`) Warning n°1: Luxon is not able to respect the leading zeroes when using macro tokens (e.g: "DD"), so `shouldRespectLeadingZeros={true}` might lead to inconsistencies when using `AdapterLuxon`. Warning n°2: When `shouldRespectLeadingZeros={true}`, the field will add an invisible character on the sections containing a single digit to make sure `onChange` is fired. If you need to get the clean value from the input, you can remove this character using `input.value.replace(/\u200e/g, '')`. Warning n°3: When used in strict mode, dayjs and moment require to respect the leading zeros. This mean that when using `shouldRespectLeadingZeros={false}`, if you retrieve the value directly from the input (not listening to `onChange`) and your format contains tokens without leading zeros, the value will not be parsed by your library.
size	'medium' \| 'small'		The size of the component.
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.
unstableFieldRef	func \| object		The ref object used to imperatively interact with the field.
value	object		The selected value. Used when the component is controlled.
variant	'filled' \| 'outlined' \| 'standard'	'outlined'	The variant to use.

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
.MuiTimeField-root	root	Styles applied to the root 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.