Skip to content

YearCalendar API

API reference docs for the React YearCalendar 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 { YearCalendar } from '@mui/x-date-pickers-pro/YearCalendar';
// or
import { YearCalendar } from '@mui/x-date-pickers/YearCalendar';
// or
import { YearCalendar } from '@mui/x-date-pickers-pro';
// or
import { YearCalendar } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
classNamestring
className applied to the root element.
defaultValueany
The default selected value. Used when the component is not controlled.
disabledboolfalse
If true picker is 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.
maxDateany
Maximal selectable date.
minDateany
Minimal selectable date.
onChangefunc
Callback fired when the value changes.

Signature:
function(value: TDate) => void
value: The new value.
readOnlyboolfalse
If true picker is readonly
referenceDateanyThe closest valid year using the validation props, except callbacks such as `shouldDisableYear`.
The date used to generate the new value when both value and defaultValue are empty.
shouldDisableYearfunc
Disable specific year.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): If true, the year 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.
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.
yearsPerRow3
| 4
3
Years rendered per row.

The ref is forwarded to the root element.

CSS

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

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