Skip to content

MonthPicker API

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

Import

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

Component name

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

Props

NameTypeDefaultDescription
date*any
Date value for the MonthPicker
onChange*func
Callback fired on date change.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
classNamestring
className applied to the root element.
disabledboolfalse
If true picker is disabled
disableFutureboolfalse
If true future days are disabled.
disableHighlightTodayboolfalse
If true, today's date is rendering without highlighting with circle.
disablePastboolfalse
If true past days are disabled.
maxDateany
Maximal selectable date. @DateIOType
minDateany
Minimal selectable date. @DateIOType
readOnlyboolfalse
If true picker is readonly
shouldDisableMonthfunc
Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.
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.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiMonthPicker-rootStyles applied to the root element.

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

Demos