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.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Component name

The name MuiDateCalendar can be used when providing default props or style overrides in the theme.

Props

Props of the native component are also available.

NameTypeDefaultDescription
autoFocusboolfalse
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.
componentsobject{}
Overridable components.
componentsPropsobject{}
The props used for each component slot.
dayOfWeekFormatterfunc(day) => day.charAt(0).toUpperCase()
Formats the day of week displayed in the calendar header.

Signature:
function(day: string) => string
day: The day of week provided by the adapter's method getWeekdays.
returns (string): The name to display.
defaultCalendarMonthany
Default calendar month displayed when value and defaultValue are empty.
defaultValueany
The default selected value. Used when the component is not controlled.
disabledboolfalse
If true, the picker and text field are disabled.
disableFutureboolfalse
If true, disable values after the current date for date components, time for time components and both for date time components.
disableHighlightTodayboolfalse
If true, today's date is rendering without highlighting with circle.
disablePastboolfalse
If true, disable values before the current date for date components, time for time components and both for date time components.
displayWeekNumberboolfalse
If true, the week number will be display in the calendar.
fixedWeekNumbernumberundefined
Calendar will show more weeks in order to match this value. Put it to 6 for having fix number of week in Gregorian calendars
focusedView'day'
| 'month'
| 'year'
Controlled focused view.
loadingboolfalse
If true, calls renderLoading instead of rendering the day calendar. Can be used to preload information and show it in calendar.
maxDateany
Maximal selectable date.
minDateany
Minimal selectable date.
monthsPerRow3
| 4
3
Months rendered per row.
onChangefunc
Callback fired when the value changes.

Signature:
function(value: TDate | null, selectionState: PickerSelectionState | undefined) => void
value: The new value.
selectionState: Indicates if the date selection is complete.
onFocusedViewChangefunc
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.
onMonthChangefunc
Callback fired on month change.

Signature:
function(month: TDate) => void
month: The new month.
onViewChangefunc
Callback fired on view change.

Signature:
function(view: TView) => void
view: The new view.
onYearChangefunc
Callback fired on year change.

Signature:
function(year: TDate) => void
year: The new year.
openTo'day'
| 'month'
| 'year'
The default visible view. Used when the component view is not controlled. Must be a valid option from views list.
readOnlyboolfalse
Make picker read only.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
Disable heavy animations.
referenceDateanyThe 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 (React.ReactNode): The node to render when loading.
shouldDisableDatefunc
Disable specific date.

Signature:
function(day: TDate) => boolean
day: The date to test.
returns (boolean): If true the date will be disabled.
shouldDisableMonthfunc
Disable specific month.

Signature:
function(month: TDate) => boolean
month: The month to test.
returns (boolean): If true, the month will be disabled.
shouldDisableYearfunc
Disable specific year.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): If true, the year will be disabled.
showDaysOutsideCurrentMonthboolfalse
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.
slotPropsobject{}
The props used for each component slot.
slotsobject{}
Overridable component slots.
sxArray<func
| 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 documention for more details.
valueany
The selected value. Used when the component is controlled.
view'day'
| 'month'
| 'year'
The visible view. Used when the component view is controlled. Must be a valid option from views list.
viewsArray<'day'
| 'month'
| 'year'>
Available views.
yearsPerRow3
| 4
3
Years rendered per row.

Slots

NameTypeDefaultDescription
dayelementTypePickersDay
Custom component for day. Check the PickersDay component.
leftArrowIconelementTypeArrowLeft
Icon displayed in the left view switch button.
nextIconButtonelementTypeIconButton
Button allowing to switch to the right view.
previousIconButtonelementTypeIconButton
Button allowing to switch to the left view.
rightArrowIconelementTypeArrowRight
Icon displayed in the right view switch button.
switchViewButtonelementTypeIconButton
Button displayed to switch between different calendar views.
switchViewIconelementTypeArrowDropDown
Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.
The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiDateCalendar-rootStyles applied to the root element.
viewTransitionContainer.MuiDateCalendar-viewTransitionContainerStyles applied to the transition group element.

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