Skip to content
Edit this page

DateRangePicker API

API reference docs for the React DateRangePicker 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 DateRangePicker from '/packages/x-date-pickers-pro/src/DateRangePicker';
// or
import { DateRangePicker } from '/packages/x-date-pickers-pro/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

autoFocus

If true, the main element is focused during the first mount. This main element is: - the element chosen by the visible view if any (i.e: the selected day on the day view). - the input element if there is a field rendered.

Type:

bool
calendars

The number of calendars to render on desktop.

Type:

1 | 2 | 3

Default:

2
className

Class name applied to the root element.

Type:

string
closeOnSelect

If true, the popover or modal will close after submitting the full date.

Type:

bool

Default:

`true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
components

Overridable components.

Type:

object

Default:

{}
componentsProps

The props used for each component slot.

Type:

object

Default:

{}
currentMonthCalendarPosition

Position the current month is rendered in.

Type:

1 | 2 | 3

Default:

1
dayOfWeekFormatter

Formats the day of week displayed in the calendar header.

Type:

func

Default:

(day) => day.charAt(0).toUpperCase()

Signature:

function(day: string) => string
  • day The day of week provided by the adapter's method getWeekdays.

Returns: The name to display.

defaultCalendarMonth

Default calendar month displayed when value={[null, null]}.

Type:

any
defaultRangePosition

The initial position in the edited date range. Used when the component is not controlled.

Type:

'end' | 'start'

Default:

'start'
defaultValue

The default value. Used when the component is not controlled.

Type:

Array<any>
desktopModeMediaQuery

CSS media query when Mobile mode will be changed to Desktop.

Type:

string

Default:

'@media (pointer: fine)'
disableAutoMonthSwitching

If true, after selecting start date calendar will not automatically switch to the month of end date.

Type:

bool
disabled

If true, the picker and text field are disabled.

Type:

bool
disableDragEditing

If true, editing dates by dragging is disabled.

Type:

bool
disableFuture

If true, disable values after the current date for date components, time for time components and both for date time components.

Type:

bool
disableHighlightToday

If true, today's date is rendering without highlighting with circle.

Type:

bool
disableOpenPicker

If true, the open picker button will not be rendered (renders only the field).

Type:

bool
disablePast

If true, disable values before the current date for date components, time for time components and both for date time components.

Type:

bool
displayWeekNumber

If true, the week number will be display in the calendar.

Type:

bool
fixedWeekNumber

Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars

Type:

number

Default:

undefined
format

Format of the date when rendered in the input(s). Defaults to localized format based on the used views.

Type:

string
formatDensity

Density of the format when rendered in the input. Setting formatDensity to "spacious" will add a space before and after each /, - and . character.

Type:

'dense' | 'spacious'

Default:

"dense"
inputRef

Pass a ref to the input element. Ignored if the field has several inputs.

Type:

func | { current?: object }
label

The label content. Ignored if the field has several inputs.

Type:

node
loading

If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.

Type:

bool
localeText

Locale for components texts. Allows overriding texts coming from LocalizationProvider and theme.

Type:

object
maxDate

Maximal selectable date.

Type:

any
minDate

Minimal selectable date.

Type:

any
onAccept

Callback fired when the value is accepted.

Type:

func

Signature:

function(value: TValue) => void
  • value The value that was just accepted.
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TValue, context: FieldChangeHandlerContext) => void
  • value The new value.
  • context The context containing the validation result of the current value.
onClose

Callback fired when the popup requests to be closed. Use in controlled mode (see open).

Type:

func
onError

Callback fired when the error associated to the current value changes. If the error has a non-null value, then the TextField will be rendered in error state.

Type:

func

Signature:

function(error: TError, value: TValue) => void
  • error The new error describing why the current value is not valid.
  • value The value associated to the error.
onMonthChange

Callback fired on month change.

Type:

func

Signature:

function(month: TDate) => void
  • month The new month.
onOpen

Callback fired when the popup requests to be opened. Use in controlled mode (see open).

Type:

func
onRangePositionChange

Callback fired when the range position changes.

Type:

func

Signature:

function(rangePosition: RangePosition) => void
  • rangePosition The new range position.
onSelectedSectionsChange

Callback fired when the selected sections change.

Type:

func

Signature:

function(newValue: FieldSelectedSections) => void
  • newValue The new selected sections.
open

Control the popup or dialog open state.

Type:

bool
rangePosition

The position in the currently edited date range. Used when the component position is controlled.

Type:

'end' | 'start'
reduceAnimations

Disable heavy animations.

Type:

bool

Default:

typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
renderLoading

Component displaying when passed loading true.

Type:

func

Default:

() => "..."

Signature:

function() => React.ReactNode

    Returns: The node to render when loading.

    selectedSections

    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.

    Type:

    'all' | 'day' | 'hours' | 'meridiem' | 'minutes' | 'month' | 'seconds' | 'weekDay' | 'year' | number | { endIndex: number, startIndex: number }
    shouldDisableDate

    Disable specific date.

    Type:

    func

    Signature:

    function(day: TDate, position: string) => boolean
    • day The date to test.
    • position The date to test, 'start' or 'end'.

    Returns: Returns true if the date should be disabled.

    showDaysOutsideCurrentMonth

    If true, days outside the current month are rendered:
    - if fixedWeekNumber is defined, renders days to have the weeks requested.
    - if fixedWeekNumber is not defined, renders day to fill the first and last week of the current month.
    - ignored if calendars equals more than 1 on range pickers.

    Type:

    bool
    slotProps

    The props used for each component slot.

    Type:

    object

    Default:

    {}
    slots

    Overridable component slots.

    Type:

    object

    Default:

    {}
    sx

    The system prop that allows defining system overrides as well as additional CSS styles.

    See the `sx` page for more details.

    Type:

    Array<func | object | bool> | func | object
    timezone

    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 documention for more details.

    Type:

    string

    Default:

    The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
    value

    The selected value. Used when the component is controlled.

    Type:

    Array<any>
    viewRenderers

    Define custom view renderers for each section. If null, the section will only have field editing. If undefined, internally defined view will be the used.

    Type:

    { day?: func }
    The ref is forwarded to the root element.

    Slots

    actionBar

    Default: PickersActionBar

    Description: Custom component for the action bar, it is placed below the picker views.

    day

    Default: DateRangePickersDay

    Description: Custom component for day in range pickers. Check the DateRangePickersDay component.

    desktopPaper

    Default: PickersPopperPaper

    Description: Custom component for the paper rendered inside the desktop picker's Popper.

    desktopTransition

    Default: Grow from '@mui/material'.

    Description: Custom component for the desktop popper Transition.

    desktopTrapFocus

    Default: TrapFocus from '@mui/material'.

    Description: Custom component for trapping the focus inside the views on desktop.

    dialog

    Default: PickersModalDialogRoot

    Description: Custom component for the dialog inside which the views are rendered on mobile.

    field

    Default:

    fieldRoot

    Default:

    Description: Element rendered at the root. Ignored if the field has only one input.

    fieldSeparator

    Default:

    Description: Element rendered between the two inputs. Ignored if the field has only one input.

    layout

    Default:

    Description: Custom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.

    leftArrowIcon

    Default: ArrowLeft

    Description: Icon displayed in the left view switch button.

    mobilePaper

    Default: Paper from '@mui/material'.

    Description: Custom component for the paper rendered inside the mobile picker's Dialog.

    mobileTransition

    Default: Fade from '@mui/material'.

    Description: Custom component for the mobile dialog Transition.

    nextIconButton

    Default: IconButton

    Description: Button allowing to switch to the right view.

    popper

    Default: Popper from '@mui/material'.

    Description: Custom component for the popper inside which the views are rendered on desktop.

    previousIconButton

    Default: IconButton

    Description: Button allowing to switch to the left view.

    rightArrowIcon

    Default: ArrowRight

    Description: Icon displayed in the right view switch button.

    shortcuts

    Default: PickersShortcuts

    Description: Custom component for the shortcuts.

    switchViewButton

    Default: IconButton

    Description: Button displayed to switch between different calendar views.

    switchViewIcon

    Default: ArrowDropDown

    Description: Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.

    textField

    Default: TextField from '@mui/material'

    Description: Form control with an input to render a date or time inside the default field. It is rendered twice: once for the start element and once for the end element. Receives the same props as @mui/material/TextField.

    toolbar

    Default: DateTimePickerToolbar

    Description: Custom component for the toolbar rendered above the views.

    You can override the style of the component using one of these customization options: