YearCalendarAPI

React YearCalendar 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

导入

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';

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称	类型	默认值	描述
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参阅下面的 CSS 类 API。
defaultValue	object	-	默认选定的值。当组件不受控制时使用。
disabled	bool	-	如果 `true`，则禁用选择器
disableFuture	bool	false	如果 `true`，则禁用日期组件的当前日期之后的值，时间组件的时间以及日期时间组件的两者。
disableHighlightToday	bool	false	如果 `true`，则今天的日期在渲染时不会用圆圈高亮显示。
disablePast	bool	false	如果 `true`，则禁用日期组件的当前日期之前的值，时间组件的时间以及日期时间组件的两者。
maxDate	object	2099-12-31	最大可选日期。
minDate	object	1900-01-01	最小可选日期。
onChange	func	-	值更改时触发的回调。签名：`function(value: TDate) => void` `value` 新值。
readOnly	bool	-	如果 `true`，则选择器为只读
referenceDate	object	使用验证 props 的最接近的有效年份，除了回调函数（例如 `shouldDisableYear`）。	当 `value` 和 `defaultValue` 都为空时，用于生成新值的日期。
shouldDisableYear	func	-	禁用特定年份。签名：`function(year: TDate) => boolean` `year` 要测试的年份。返回值：如果 `true`，则年份将被禁用。
slotProps	object	{}	用于每个组件插槽的 props。
slots	object	{}	可覆盖的组件插槽。有关更多详细信息，请参阅下面的 Slots API。
sx	Array<func \| object \| bool> \| func \| object	-	允许定义系统覆盖以及其他 CSS 样式的系统 prop。有关更多详细信息，请参阅 `sx` 页面。
timezone	string	`value` 或 `defaultValue` prop 的时区已定义，否则为“default”。	选择要用于值的时区。示例：“default”、“system”、“UTC”、“America/New_York”。如果您将来自其他时区的值传递给某些 props，它们将在使用前转换为此时区。有关更多详细信息，请参阅时区文档。
value	object	-	选定的值。当组件受控制时使用。
yearsOrder	'asc' \| 'desc'	'asc'	默认情况下，年份按升序（时间顺序）显示。如果为 `desc`，则年份按降序显示。
yearsPerRow	3 \| 4	3	每行渲染的年份数。

ref 被转发到根元素。

主题默认 Props

您可以使用 MuiYearCalendar 通过主题更改此组件的默认 props。

插槽

插槽名称	类名	默认组件	描述
yearButton		`YearCalendarButton`	用于在 `year` 视图中渲染单个年份的按钮。

CSS 类

这些类名对于使用 CSS 设置样式很有用。当触发特定状态时，它们会应用于组件的插槽。

类名	规则名称	描述
.MuiYearCalendar-root	root	应用于根元素的样式。

您可以使用以下自定义选项之一覆盖组件的样式

使用全局类名。
在自定义主题中使用规则名称作为组件styleOverrides 属性的一部分。

源代码

如果您在此页面中找不到信息，请考虑查看组件的实现以获取更多详细信息。