YearPicker API

API documentation for the React YearPicker component. Learn about the available props and the CSS API.

Import

import YearPicker from '@mui/x-date-pickers/YearPicker';
// or
import { YearPicker } from '@mui/x-date-pickers';

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

Name	Type	Default	Description
onYearChange	func		Callback firing on year change @DateIOType. Signature: `function(year: TDate) => void` year: The new year.
shouldDisableYear	func		Disable specific years dynamically. Works like `shouldDisableDate` but for year selection view @DateIOType. Signature: `function(year: TDate) => boolean` year: The year to test. returns (boolean): Return `true` if the year should be disabled.

The ref is forwarded to the root element.

Rule name	Global class	Description
root	.MuiYearPicker-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.