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

Props of the native component are also available.

Name	Type	Default	Description
autoFocus	bool	-	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.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
dayOfWeekFormatter	func	(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.
defaultValue	object	-	The default selected value. Used when the component is not controlled.
disabled	bool	false	If `true`, the picker and text field are disabled.
disableFuture	bool	false	If `true`, disable values after the current date for date components, time for time components and both for date time components.
disableHighlightToday	bool	false	If `true`, today's date is rendering without highlighting with circle.
disablePast	bool	false	If `true`, disable values before the current date for date components, time for time components and both for date time components.
displayWeekNumber	bool	-	If `true`, the week number will be display in the calendar.
fixedWeekNumber	number	-	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
focusedView	'day' \| 'month' \| 'year'	-	Controlled focused view.
loading	bool	false	If `true`, calls `renderLoading` instead of rendering the day calendar. Can be used to preload information and show it in calendar.
maxDate	object	2099-12-31	Maximal selectable date.
minDate	object	1900-01-01	Minimal selectable date.
monthsPerRow	3 \| 4	3	Months rendered per row.
onChange	func	-	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.
onFocusedViewChange	func	-	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.
onMonthChange	func	-	Callback fired on month change. Signature:`function(month: TDate) => void` `month` The new month.
onViewChange	func	-	Callback fired on view change. Signature:`function(view: TView) => void` `view` The new view.
onYearChange	func	-	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.
readOnly	bool	false	Make picker read only.
reduceAnimations	bool	`@media(prefers-reduced-motion: reduce)` \|\| `navigator.userAgent` matches Android <10 or iOS <13	If `true`, disable heavy animations.
referenceDate	object	The 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.
renderLoading	func	() => <span data-mui-test="loading-progress">...</span>	Component displaying when passed `loading` true. Signature:`function() => React.ReactNode` Returns: The node to render when loading.
shouldDisableDate	func	-	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.
shouldDisableMonth	func	-	Disable specific month. Signature:`function(month: TDate) => boolean` `month` The month to test. Returns: If `true`, the month will be disabled.
shouldDisableYear	func	-	Disable specific year. Signature:`function(year: TDate) => boolean` `year` The year to test. Returns: If `true`, the year will be disabled.
showDaysOutsideCurrentMonth	bool	false	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.
slotProps	object	{}	The props used for each component slot.
slots	object	{}	Overridable component slots. See Slots API below for more details.
sx	Array<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.
timezone	string	The 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.
value	object	-	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.
views	Array<'day' \| 'month' \| 'year'>	-	Available views.
yearsPerRow	3 \| 4	3	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.

Slots

Slot name	Default component	Description
calendarHeader	`PickersCalendarHeader`	Custom component for calendar header. Check the PickersCalendarHeader component.
day	`PickersDay`	Custom component for day. Check the PickersDay component.
leftArrowIcon	`ArrowLeft`	Icon displayed in the left view switch button.
monthButton	`MonthCalendarButton`	Button displayed to render a single month in the "month" view.
nextIconButton	`IconButton`	Button allowing to switch to the right view.
previousIconButton	`IconButton`	Button allowing to switch to the left view.
rightArrowIcon	`ArrowRight`	Icon displayed in the right view switch button.
switchViewButton	`IconButton`	Button displayed to switch between different calendar views.
switchViewIcon	`ArrowDropDown`	Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is "year".
yearButton	`YearCalendarButton`	Button 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 name	Rule name	Description
.MuiDateCalendar-root	root	Styles applied to the root element.
.MuiDateCalendar-viewTransitionContainer	viewTransitionContainer	Styles applied to the transition group element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.