Skip to content

DateTimeRangePicker API

API reference docs for the React DateTimeRangePicker component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import { DateTimeRangePicker } from '@mui/x-date-pickers-pro/DateTimeRangePicker';
// or
import { DateTimeRangePicker } from '@mui/x-date-pickers-pro';
Learn about the difference by reading this guide on minimizing bundle size.

Props

ampm

12h/24h view for hour selection clock.

Type:bool

Default:`utils.is12HourCycleInCurrentLocale()`


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:1


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


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: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

Signature:
function(date: TDate) => string
  • date The date of the day of week provided by the adapter.

Returns: The name to display.


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<object>


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

Default:false


disabled

If true, the picker and text field are disabled.

Type:bool

Default:false


disableDragEditing

If true, editing dates by dragging is disabled.

Type:bool

Default:false


disableFuture

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

Type:bool

Default:false


disableHighlightToday

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

Type:bool

Default:false


disableIgnoringDatePartForTimeValidation

Do not ignore date part when validating min/max time.

Type:bool

Default:false


disableOpenPicker

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

Type:bool

Default:false


disablePast

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

Type:bool

Default:false


displayWeekNumber

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

Type:bool


fixedWeekNumber

The day view will show as many weeks as needed after the end of the current month to match this value. Put it to 6 to have a fixed number of weeks 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

Default:false


localeText

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

Type:object


maxDate

Maximal selectable date.

Type:object


maxDateTime

Maximal selectable moment of time with binding to date, to set max time in each day use maxTime.

Type:object


maxTime

Maximal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

Type:object


minDate

Minimal selectable date.

Type:object


minDateTime

Minimal selectable moment of time with binding to date, to set min time in each day use minTime.

Type:object


minTime

Minimal selectable time. The date part of the object will be ignored unless props.disableIgnoringDatePartForTimeValidation === true.

Type:object


minutesStep

Step over minutes.

Type:number

Default:1


name

Name attribute used by the input element in the Field. Ignored if the field has several inputs.

Type:string


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.

onViewChange

Callback fired on view change.

Type:func

Signature:
function(view: TView) => void
  • view The new view.

open

Control the popup or dialog open state.

Type:bool

Default:false


openTo

The default visible view. Used when the component view is not controlled. Must be a valid option from views list.

Type:'day'
| 'hours'
| 'minutes'
| 'seconds'


rangePosition

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

Type:'end'
| 'start'


reduceAnimations

If true, disable heavy animations.

Type:bool

Default:`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13


referenceDate

The date used to generate the new value when both value and defaultValue are empty.

Type:object

Default:The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.


renderLoading

Component rendered on the "day" view when props.loading is 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'
    | 'empty'
    | 'hours'
    | 'meridiem'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'weekDay'
    | 'year'
    | number
    | { endIndex: number, startIndex: number }


    shouldDisableDate

    Disable specific date.
    Warning: This function can be called multiple times (e.g. when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.

    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.


    shouldDisableTime

    Disable specific time.

    Type:func

    Signature:
    function(value: TDate, view: TimeView) => boolean
    • value The value to check.
    • view The clock type of the timeValue.

    Returns: If true the time will 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

    Default:false


    skipDisabled

    If true, disabled digital clock items will not be rendered.

    Type:bool

    Default:false


    slotProps

    The props used for each component slot.

    Type:object

    Default:{}


    slots

    Overridable component slots.

    See Slots API below for more details.

    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


    thresholdToRenderTimeInASingleColumn

    Amount of time options below or at which the single column time renderer is used.

    Type:number

    Default:24


    timeSteps

    The time steps between two time unit options. For example, if timeStep.minutes = 8, then the available minute options will be [0, 8, 16, 24, 32, 40, 48, 56]. When single column time renderer is used, only timeStep.minutes will be used.

    Type:{ hours?: number, minutes?: number, seconds?: number }

    Default:{ hours: 1, minutes: 5, seconds: 5 }


    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 documentation 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<object>


    view

    The visible view. Used when the component view is controlled. Must be a valid option from views list.

    Type:'day'
    | 'hours'
    | 'meridiem'
    | 'minutes'
    | 'seconds'


    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, hours?: func, meridiem?: func, minutes?: func, seconds?: func }


    views

    Available views.

    Type:Array<'day'
    | 'hours'
    | 'minutes'
    | 'seconds'>


    The component cannot hold a ref.

    Slots

    tabs

    Tabs enabling toggling between date and time pickers.

    Default component: DateTimeRangePickerTabs


    toolbar

    Custom component for the toolbar rendered above the views.

    Default component: DateTimeRangePickerToolbar


    calendarHeader

    Custom component for calendar header. Check the PickersCalendarHeader component.

    Default component: PickersCalendarHeader


    day

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

    Default component: DateRangePickersDay


    previousIconButton

    Button allowing to switch to the left view.

    Default component: IconButton


    nextIconButton

    Button allowing to switch to the right view.

    Default component: IconButton


    leftArrowIcon

    Icon displayed in the left view switch button.

    Default component: ArrowLeft


    rightArrowIcon

    Icon displayed in the right view switch button.

    Default component: ArrowRight


    switchViewButton

    Button displayed to switch between different calendar views.

    Default component: IconButton


    switchViewIcon

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

    Default component: ArrowDropDown


    digitalClockItem

    Component responsible for rendering a single digital clock item.

    Default component: MenuItem from '@mui/material'


    digitalClockSectionItem

    Component responsible for rendering a single multi section digital clock section item.

    Default component: MenuItem from '@mui/material'


    actionBar

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

    Default component: PickersActionBar


    shortcuts

    Custom component for the shortcuts.

    Default component: PickersShortcuts


    layout

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


    fieldRoot

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


    fieldSeparator

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


    textField

    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.

    Default component: TextField from '@mui/material'


    clearIcon

    Icon to display inside the clear button.

    Default component: ClearIcon


    clearButton

    Button to clear the value.

    Default component: IconButton


    desktopPaper

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

    Default component: PickersPopperPaper


    desktopTransition

    Custom component for the desktop popper Transition.

    Default component: Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.


    desktopTrapFocus

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

    Default component: FocusTrap from '@mui/base'.


    popper

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

    Default component: Popper from '@mui/material'.


    field

    dialog

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

    Default component: PickersModalDialogRoot


    mobilePaper

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

    Default component: Paper from '@mui/material'.


    mobileTransition

    Custom component for the mobile dialog Transition.

    Default component: Fade from '@mui/material'.