MonthPicker API
API documentation for the React MonthPicker component. Learn about the available props and the CSS API.
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';
Component name
The nameMuiMonthPicker
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
onChange* | func | Callback fired when the value (the selected month) changes. Signature: function(value: TValue) => void value: The new value. | |
value* | any | Date value for the MonthPicker | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
className | string | className applied to the root element. | |
disabled | bool | false | If true picker is disabled |
disableFuture | bool | false | If true disable values before the current time |
disableHighlightToday | bool | false | If true , today's date is rendering without highlighting with circle. |
disablePast | bool | false | If true disable values after the current time. |
maxDate | any | Maximal selectable date. @DateIOType | |
minDate | any | Minimal selectable date. @DateIOType | |
readOnly | bool | false | If true picker is readonly |
shouldDisableMonth | func | 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. | |
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. |
The
ref
is forwarded to the root element.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiMonthPicker-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.