MonthCalendarAPI

React MonthCalendar 元件的 API 參考文件。了解此匯出模組的 props、CSS 和其他 API。

範例

如需此 React 元件的使用範例和詳細資訊，請瀏覽元件範例頁面

匯入

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

閱讀這份關於最小化 bundle 大小的指南，了解差異。

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	最小可選日期。
monthsPerRow	3 \| 4	3	每行渲染的月份數。
onChange	func	-	值變更時觸發的回呼函式。 Signature:`function(value: TDate) => void` `value` 新值。
readOnly	bool	-	如果為 `true`，則選擇器為唯讀
referenceDate	object	使用驗證 props 的最接近有效月份，但 `shouldDisableMonth` 等回呼函式除外。	當 `value` 和 `defaultValue` 都為空時，用於產生新值的日期。
shouldDisableMonth	func	-	停用特定月份。 Signature:`function(month: TDate) => boolean` `month` 要測試的月份。傳回值：如果為 `true`，則該月份將被停用。
slotProps	object	{}	用於每個元件插槽的 props。
slots	object	{}	可覆寫的元件插槽。詳情請參閱下方的插槽 API。
sx	Array<func \| object \| bool> \| func \| object	-	系統 prop，允許定義系統覆寫以及額外的 CSS 樣式。詳情請參閱 `sx` 頁面。
timezone	string	定義 `value` 或 `defaultValue` prop 的時區，否則為 'default'。	選擇要用於值的時區。範例：「default」、「system」、「UTC」、「America/New_York」。如果您將來自其他時區的值傳遞給某些 props，它們將在被使用之前轉換為此時區。詳情請參閱時區文件。
value	object	-	選取的值。當元件受控制時使用。

ref 會轉發到根元素。

主題預設 props

您可以使用 MuiMonthCalendar 透過主題變更此元件的預設 props。

插槽

插槽名稱	類別名稱	預設元件	描述
monthButton		`MonthCalendarButton`	顯示的按鈕，用於在 `month` 檢視中渲染單個月份。

CSS 類別

這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時，它們會套用至元件的插槽。

類別名稱	規則名稱	描述
.MuiMonthCalendar-root	root	套用至根元素的樣式。

您可以使用以下其中一種自訂選項來覆寫元件的樣式

使用全域類別名稱。
在自訂主題中使用規則名稱作為元件的 styleOverrides 屬性的一部分。

原始碼

如果您在此頁面中找不到資訊，請考慮查看元件的實作以了解更多詳細資訊。