MonthCalendar API
API reference docs for the React MonthCalendar component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import { MonthCalendar } from '@mui/x-date-pickers/MonthCalendar';
// or
import { MonthCalendar } from '@mui/x-date-pickers';
// or
import { MonthCalendar } 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.
Name | Type | Default | Description |
---|---|---|---|
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
defaultValue | object | - | The default selected value. Used when the component is not controlled. |
disabled | bool | - | If |
disableFuture | bool | false | If |
disableHighlightToday | bool | false | If |
disablePast | bool | false | If |
maxDate | object | - | Maximal selectable date. |
minDate | object | - | Minimal selectable date. |
monthsPerRow | 3 | 4 | 3 | Months rendered per row. |
onChange | func | - | Callback fired when the value changes. Signature: function(value: TDate) => void
|
readOnly | bool | - | If |
referenceDate | object | The closest valid month using the validation props, except callbacks such as `shouldDisableMonth`. | The date used to generate the new value when both |
shouldDisableMonth | func | - | Disable specific month. Signature: function(month: TDate) => boolean
Returns: If |
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. |
ref
is forwarded to the root element.Theme default props
You can use MuiMonthCalendar
to change the default props of this component with the theme.
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 |
---|---|---|
.MuiMonthCalendar-root | root | Styles applied to the root 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.