Skip to content
Edit this page

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 '/packages/x-date-pickers/src/YearCalendar';
// or
import { YearCalendar } from '/packages/x-date-pickers/src';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
className

className applied to the root element.

Type:

string
defaultValue

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

Type:

any
disabled

If true picker is disabled

Type:

bool
disableFuture

If true, disable values after the current date for date components, time for time components and both for date time components.

Type:

bool
disableHighlightToday

If true, today's date is rendering without highlighting with circle.

Type:

bool
disablePast

If true, disable values before the current date for date components, time for time components and both for date time components.

Type:

bool
maxDate

Maximal selectable date.

Type:

any
minDate

Minimal selectable date.

Type:

any
onChange

Callback fired when the value changes.

Type:

func

Signature:

function(value: TDate) => void
  • value The new value.
readOnly

If true picker is readonly

Type:

bool
referenceDate

The date used to generate the new value when both value and defaultValue are empty.

Type:

any

Default:

The closest valid year using the validation props, except callbacks such as `shouldDisableYear`.
shouldDisableYear

Disable specific year.

Type:

func

Signature:

function(year: TDate) => boolean
  • year The year to test.

Returns: If true, the year will be disabled.

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
timezone

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.

Type:

string

Default:

The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
value

The selected value. Used when the component is controlled.

Type:

any
yearsPerRow

Years rendered per row.

Type:

3 | 4

Default:

3
The ref is forwarded to the root element.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiYearCalendar-rootroot

Styles applied to the root element.

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