SingleInputTimeRangeField API

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

Import

import { SingleInputTimeRangeField } from '@mui/x-date-pickers-pro/SingleInputTimeRangeField';
// or
import { SingleInputTimeRangeField } 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	adapter.is12HourCycleInCurrentLocale()	12h/24h view for hour selection clock.
areAllSectionsEmpty	bool	-	Is `true` if the current values equals the empty value. For a single item value, it means that `value === null` For a range value, it means that `value === [null, null]`
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.
clearButtonPosition	'end' \| 'start'	'end'	The position at which the clear button is placed. If the field is not clearable, the button is not rendered.
dateSeparator	string	"–"	String displayed between the start and the end dates.
defaultValue	PickerRangeValue	-	The default value. Use when the component is not controlled.
disabled	bool	false	If `true`, the component is disabled. When disabled, the value cannot be changed and no interaction is possible.
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.
endAdornment	node	-	End `InputAdornment` for this component.
error	bool	false	If `true`, the `input` will indicate an error.
fieldRef	{}	-	The ref object used to imperatively interact with the field.
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.
fullWidth	bool	false	If `true`, the input will take up the full width of its container.
helperText	node	-	The helper text content.
id	string	-	The id of the `input` element.
inputRef	ref	-	Pass a ref to the `input` element.
label	node	-	The label content.
maxTime	{}	-	Maximal selectable time. The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
minTime	{}	-	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.
onBlur	func	-	Signature:`function(event: FocusEvent<HTMLDivElement, Element>) => void`
onChange	func	-	Callback fired when the value changes. Signature:`function(value: TValue, context: FieldChangeHandlerContext<TError>) => 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. Signature:`function(event: MouseEvent<Element, MouseEvent>) => void`
onClick	func	-	Signature:`function(event: MouseEvent<HTMLDivElement, MouseEvent>) => void`
onError	func	-	Callback fired when the error associated with the current value changes. When a validation error is detected, the `error` parameter contains a non-null value. This can be used to render an appropriate form error. Signature:`function(error: TError, value: TValue) => void` `error` The reason why the current value is not valid. `value` The value associated with the error.
onFocus	func	-	Signature:`function(event: FocusEvent<HTMLDivElement, Element>) => void`
onInput	func	-	Signature:`function(event: FormEvent<HTMLDivElement>) => void`
onKeyDown	func	-	Signature:`function(event: MuiEvent<KeyboardEvent<HTMLDivElement>>) => void`
onPaste	func	-	Signature:`function(event: ClipboardEvent<HTMLDivElement>) => void`
onSelectedSectionsChange	func	-	Callback fired when the selected sections change. Signature:`function(newValue: FieldSelectedSections) => void` `newValue` The new selected sections.
openPickerButtonPosition	'end' \| 'start'	'end'	The position at which the opening button is placed. If there is no Picker to open, the button is not rendered
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.
referenceDate	{}	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.
selectedSections	'all' \| 'day' \| 'empty' \| 'hours' \| 'meridiem' \| 'minutes' \| 'month' \| 'seconds' \| 'weekDay' \| 'year' \| number	-	The currently selected sections. This prop accepts four formats: 1. If a number is provided, the section at this index will be selected. 2. If a string of type `FieldSectionType` is provided, the first section with that name will be selected. 3. If `"all"` is provided, all the sections 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: PickerValidDate, view: TimeView) => boolean` `value` The value to check. `view` The clock type of the timeValue.
shouldRespectLeadingZeros	bool	false	If `true`, the format will respect the leading zeroes (for example on dayjs, the format `M/D/YYYY` will render `8/16/2018`) If `false`, the format will always add leading zeroes (for example 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 (for example "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.
slotProps	SingleInputTimeRangeFieldSlotProps	{}	The props used for each component slot.
slots	SingleInputTimeRangeFieldSlots	{}	Overridable component slots. See Slots API below for more details.
startAdornment	node	-	Start `InputAdornment` for this component.
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 timezones documentation for more details.
value	PickerRangeValue	-	The selected value. Used when the component is controlled.
variant	'filled' \| 'outlined' \| 'standard'	'outlined'	The variant to use.

The ref is forwarded to the root element.

Theme default props

You can use MuiSingleInputTimeRangeField to change the default props of this component with the theme.

Slots

Slot name	Default component	Description
clearButton	`IconButton`	Button to clear the value.
clearIcon	`ClearIcon`	Icon to display in the button used to clean the value.
inputAdornment	`InputAdornment`	Component displayed on the start or end input adornment used to open the Picker.
textField	`<PickersTextField />`	Form control with an input to render the value.

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.