SingleInputDateRangeField API

API reference docs for the React SingleInputDateRangeField 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 { SingleInputDateRangeField } from '@mui/x-date-pickers-pro/SingleInputDateRangeField';
// or
import { SingleInputDateRangeField } 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
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.
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.
dateSeparator	string	"–"	String displayed between the start and the end dates.
defaultValue	Array<object>	-	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.
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. Deprecated－Use `slotProps.formHelperText` instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
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`. Deprecated－Use `slotProps.inputLabel` instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
inputProps	object	-	Attributes applied to the `input` element. Deprecated－Use `slotProps.htmlInput` instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
InputProps	object	-	Props applied to the Input element. It will be a `FilledInput`, `OutlinedInput` or `Input` component depending on the `variant` prop value. Deprecated－Use `slotProps.input` instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
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.
maxDate	object	2099-12-31	Maximal selectable date.
minDate	object	1900-01-01	Minimal selectable date.
name	string	-	Name attribute of the `input` element.
onChange	func	-	Callback fired when the value changes. Signature:`function(value: TValue, context: FieldChangeHandlerContext<TError>) => void` `value: TValue` 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 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: TError` The reason why the current value is not valid. `value: TValue` The value associated with the error.
onSelectedSectionsChange	func	-	Callback fired when the selected sections change. Signature:`function(newValue: FieldSelectedSections) => void` `newValue` The new selected sections.
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	Array<object> \| 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	-	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.
shouldDisableDate	func	-	Disable specific date. Warning: This function can be called multiple times (for example when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance. Signature:`function(day: PickerValidDate, position: string) => boolean` `day` The date to test. `position` The date to test, 'start' or 'end'.
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.
size	'medium' \| 'small'	'medium'	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	Array<object>	-	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 MuiSingleInputDateRangeField 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 />, or <TextField /> from '@mui/material' if `enableAccessibleFieldDOMStructure` is `false`.	Form control with an input to render the value.

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
.MuiSingleInputDateRangeField-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.

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.