MultiInputDateRangeField API

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

Import

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

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

Component name

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

Props

Name	Type	Default	Description
components	object	{}	Overrideable components.
componentsProps	object	{}	The props used for each component slot.
defaultValue	Array<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.
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).
maxDate	any		Maximal selectable date.
minDate	any		Minimal selectable date.
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.
shouldDisableDate	func		Disable specific date. @DateIOType Signature: `function(day: TDate, position: string) => boolean` day: The date to test. position: The date to test, 'start' or 'end'. returns (boolean): Returns `true` if the date should be disabled.
value	Array<any>		The selected value. Used when the component is controlled.

Slots

Name	Type	Default	Description
Input	elementType	TextField	Input rendered for the start or end date.
Root	elementType	MultiInputDateRangeFieldRoot	Element rendered at the root.
Separator	elementType	MultiInputDateRangeFieldSeparator	Element rendered between the two inputs.

The component cannot hold a ref.

MultiInputDateRangeField API

Import

Component name

Props

Slots

Demos