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/YearCalendar';
// or
import { YearCalendar } from '@mui/x-date-pickers';
// or
import { YearCalendar } 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
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 `true` picker is 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.
maxDate	object	-	Maximal selectable date.
minDate	object	-	Minimal selectable date.
onChange	func	-	Callback fired when the value changes. Signature:`function(value: TDate) => void` `value` The new value.
readOnly	bool	-	If `true` picker is readonly
referenceDate	object	The 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.
shouldDisableYear	func	-	Disable specific year. Signature:`function(year: TDate) => boolean` `year` The year to test. Returns: If `true`, the year will be disabled.
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.
yearsPerRow	3 \| 4	3	Years rendered per row.

The ref is forwarded to the root element.

Theme default props

You can use MuiYearCalendar to change the default props of this component with the theme.

Slots

Slot name	Class name	Default component	Description
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
.MuiYearCalendar-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.