Skip to content

StaticDateRangePicker API

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



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

Learn about the difference by reading this guide on minimizing bundle size.



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.

| 2
| 3
1 if `displayStaticWrapperAs === 'mobile'`, 2 otherwise.

The number of calendars to render.

| 2
| 3

Position the current month is rendered in.

dayOfWeekFormatterfunc(date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

Formats the day of week displayed in the calendar header.

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

Returns: The name to display.

| 'start'

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


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


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


If true, the picker and text field are disabled.


If true, editing dates by dragging is disabled.


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


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


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

| 'mobile'

Force static wrapper inner components to be rendered in mobile or desktop mode.


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


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


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


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


Maximal selectable date.


Minimal selectable date.


Callback fired when the value is accepted.

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

Callback fired when the value changes.

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

Callback fired when component requests to be closed. Can be fired when selecting (by default on desktop mode) or clearing a value.


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.

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.

Callback fired on month change.

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

Callback fired when the range position changes.

Signature:function(rangePosition: RangePosition) => void
  • rangePosition The new range position.
| 'start'

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

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

If true, disable heavy animations.

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

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

renderLoadingfunc() => "..."

Component rendered on the "day" view when props.loading is true.

Signature:function() => React.ReactNode

    Returns: The node to render when loading.


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


    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.


    The props used for each component slot.


    Overridable component slots.

    See Slots API below for more details.

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

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


    The selected value. Used when the component is controlled.

    viewRenderers{ day?: func }-

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

    The ref is forwarded to the root element.


    Slot nameClass nameDefault componentDescription
    toolbarDateTimePickerToolbarCustom component for the toolbar rendered above the views.
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    dayDateRangePickersDayCustom component for day in range pickers. Check the DateRangePickersDay component.
    previousIconButtonIconButtonButton allowing to switch to the left view.
    nextIconButtonIconButtonButton allowing to switch to the right view.
    leftArrowIconArrowLeftIcon displayed in the left view switch button.
    rightArrowIconArrowRightIcon displayed in the right view switch button.
    switchViewButtonIconButtonButton displayed to switch between different calendar views.
    switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is "year".
    actionBarPickersActionBarCustom component for the action bar, it is placed below the picker views.
    shortcutsPickersShortcutsCustom component for the shortcuts.
    layoutCustom component for wrapping the layout. It wraps the toolbar, views, action bar, and shortcuts.