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

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.

NameTypeDefaultDescription
classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

defaultValueobject-

The default selected value. Used when the component is not controlled.

disabledbool-

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.

maxDateobject-

Maximal selectable date.

minDateobject-

Minimal selectable date.

onChangefunc-

Callback fired when the value changes.

Signature:function(value: TDate) => void
  • value The new value.
readOnlybool-

If true picker is readonly

referenceDateobjectThe 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: If true, the year will be disabled.

slotPropsobject{}

The props used for each component slot.

slotsobject{}

Overridable component slots.

See Slots API below for more details.

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 documentation for more details.

valueobject-

The selected value. Used when the component is controlled.

yearsPerRow3
| 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 nameClass nameDefault componentDescription
yearButtonYearCalendarButtonButton 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 nameRule nameDescription
.MuiYearCalendar-rootrootStyles applied to the root element.

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