Date Range Picker

The Date Range Picker lets the user select a range of dates.

Basic usage

Component composition

The component is built using the MultiInputDateRangeField for the keyboard editing and the DateRangeCalendar for the view editing.

Check-out their documentation page for more information:

• Date Range Field
• Date Range Calendar

You can check the available props of the combined component on the dedicated API page. Some MultiInputDateRangeField props are not available on the Picker component, you can use slotProps.field to pass them to the field.

Uncontrolled vs. controlled value

The value of the component can be uncontrolled or controlled.

Available components

The component is available in four variants:

• The DesktopDateRangePicker component which works best for mouse devices and large screens. It renders the views inside a popover and a field for keyboard editing.

• The MobileDateRangePicker component which works best for touch devices and small screens. It renders the view inside a modal and does not allow editing values with the keyboard in the field.

• The DateRangePicker component which renders DesktopDateRangePicker or MobileDateRangePicker depending on the device it runs on.

• The StaticDateRangePicker component which renders without the popover/modal and field.

By default, the DateRangePicker component renders the desktop version if the media query @media (pointer: fine) matches. This can be customized with the desktopModeMediaQuery prop.

Form props

The component supports the disabled, readOnly and name form props:

Customization

Render 1 to 3 months

You can render up to 3 months at the same time using the calendars prop.

Use a multi input field

You can pass the MultiInputDateRangeField component to the Date Range Picker to use it for keyboard editing. In such case the Picker component can pass the name prop to the input.

Add shortcuts

To simplify range selection, you can add shortcuts.

Customize the field

You can find the documentation in the Custom field page.

Localization

See the Date format and localization and Translated components documentation pages for more details.

Validation

See the Validation documentation page for more details.

Month Range Picker 🚧

The Month Range Picker would let users select a range of months.

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.

• <DateRangeCalendar />
• <DateRangePicker />
• <DateRangePickerDay />
• <DesktopDateRangePicker />
• <MobileDateRangePicker />
• <StaticDateRangePicker />