Skip to content

DateCalendar API

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



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

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


Props of the native component are also available.


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.


Override or extend the styles applied to the component.

See CSS classes API below for more details.

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.


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


If true, the picker and text field are 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.


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

| 'month'
| 'year'

Controlled focused view.


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


Maximal selectable date.


Minimal selectable date.

| 4

Months rendered per row.


Callback fired when the value changes.

Signature:function(value: TValue, selectionState: PickerSelectionState | undefined, selectedView: TView | undefined) => void
  • value The new value.
  • selectionState Indicates if the date selection is complete.
  • selectedView Indicates the view in which the selection has been made.

Callback fired on focused view change.

Signature:function(view: TView, hasFocus: boolean) => void
  • view The new view to focus or not.
  • hasFocus true if the view should be focused.

Callback fired on month change.

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

Callback fired on view change.

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

Callback fired on year change.

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

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


Make picker read only.

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

If true, disable heavy animations.

referenceDateobjectThe closest valid date using the validation props, except callbacks such as `shouldDisableDate`.

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

renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>

Component displaying when passed loading 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) => boolean
    • day The date to test.

    Returns: If true the date will be disabled.


    Disable specific month.

    Signature:function(month: TDate) => boolean
    • month The month to test.

    Returns: If true, the month will be disabled.


    Disable specific year.

    Signature:function(year: TDate) => boolean
    • year The year to test.

    Returns: If true, the year will 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.

    | 'month'
    | 'year'

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

    | 'month'
    | 'year'>

    Available views.

    | 4

    Years rendered per row.

    The ref is forwarded to the root element.

    Theme default props

    You can use MuiDateCalendar to change the default props of this component with the theme.


    Slot nameClass nameDefault componentDescription
    calendarHeaderPickersCalendarHeaderCustom component for calendar header. Check the PickersCalendarHeader component.
    switchViewButtonIconButtonButton displayed to switch between different calendar views.
    switchViewIconArrowDropDownIcon displayed in the SwitchViewButton. Rotated by 180° when the open view is "year".
    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.
    dayPickersDayCustom component for day. Check the PickersDay component.
    monthButtonMonthCalendarButtonButton displayed to render a single month in the "month" view.
    yearButtonYearCalendarButtonButton displayed to render a single year in the "year" view.

    CSS classes

    These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

    Class nameRule nameDescription
    .MuiDateCalendar-rootrootStyles applied to the root element.
    .MuiDateCalendar-viewTransitionContainerviewTransitionContainerStyles applied to the transition group element.

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