StaticDateRangePickerAPI

React StaticDateRangePicker 組件的 API 參考文檔。瞭解此導出模組的屬性、CSS 和其他 API。

示範

有關此 React 組件用法的範例和詳細資訊，請訪問組件示範頁面

導入

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

瞭解差異，請閱讀這份關於最小化捆綁包大小的指南。

屬性

名稱	類型	預設值	描述
autoFocus	bool	-	如果 `true`，則在首次掛載期間主要元素會獲得焦點。此主要元素為：- 可見視圖選擇的元素（如果有的話）（即：`day` 視圖上選定的日期）。- 如果有呈現欄位，則為 `input` 元素。
calendars	1 \| 2 \| 3	如果 `displayStaticWrapperAs === 'mobile'`，則為 1，否則為 2。	要呈現的日曆數量。
currentMonthCalendarPosition	1 \| 2 \| 3	1	目前月份呈現位置。
dayOfWeekFormatter	func	(date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()	格式化日曆標題中顯示的星期幾。簽名：`function(date: TDate) => string` `date` 適配器提供的星期幾的日期。返回：要顯示的名稱。
defaultRangePosition	'end' \| 'start'	'start'	編輯日期範圍中的初始位置。當組件不受控制時使用。
defaultValue	Array<object>	-	預設值。當組件不受控制時使用。
disableAutoMonthSwitching	bool	false	如果 `true`，在選擇 `start` 日期後，日曆將不會自動切換到 `end` 日期的月份。
disabled	bool	false	如果 `true`，則禁用選擇器和文字欄位。
disableDragEditing	bool	false	如果 `true`，則禁用通過拖動編輯日期。
disableFuture	bool	false	如果 `true`，則禁用日期組件的當前日期之後的值，時間組件的時間以及日期時間組件的兩者。
disableHighlightToday	bool	false	如果 `true`，今天的日期將在沒有圓圈高亮顯示的情況下呈現。
disablePast	bool	false	如果 `true`，則禁用日期組件的當前日期之前的值，時間組件的時間以及日期時間組件的兩者。
displayStaticWrapperAs	'desktop' \| 'mobile'	"mobile"	強制靜態包裝器內部組件以移動或桌面模式呈現。
displayWeekNumber	bool	-	如果 `true`，則週數將顯示在日曆中。
fixedWeekNumber	number	-	日期視圖將顯示當前月份結束後所需的週數，以匹配此值。設定為 6 以在公曆日曆中具有固定的週數
loading	bool	false	如果 `true`，則調用 `renderLoading` 而不是呈現日期日曆。可用於預加載資訊並在日曆中顯示。
localeText	object	-	組件文字的語言環境。允許覆蓋來自 `LocalizationProvider` 和 `theme` 的文字。
maxDate	object	2099-12-31	最大可選日期。
minDate	object	1900-01-01	最小可選日期。
onAccept	func	-	當值被接受時觸發的回調。簽名：`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` 剛剛被接受的值。 `context` 包含當前值的驗證結果的上下文。
onChange	func	-	當值更改時觸發的回調。簽名：`function(value: TValue, context: FieldChangeHandlerContext) => void` `value` 新值。 `context` 包含當前值的驗證結果的上下文。
onClose	func	-	當組件請求關閉時觸發的回調。可以在選擇（預設在 `desktop` 模式下）或清除值時觸發。已棄用－請避免使用，因為它將在下一個主要版本中移除。
onError	func	-	當與當前值關聯的錯誤更改時觸發的回調。當檢測到驗證錯誤時，`error` 參數包含非空值。這可用於呈現適當的表單錯誤。簽名：`function(error: TError, value: TValue) => void` `error` 當前值無效的原因。 `value` 與錯誤關聯的值。
onMonthChange	func	-	在月份更改時觸發的回調。簽名：`function(month: TDate) => void` `month` 新月份。
onRangePositionChange	func	-	當範圍位置更改時觸發的回調。簽名：`function(rangePosition: RangePosition) => void` `rangePosition` 新範圍位置。
rangePosition	'end' \| 'start'	-	當前編輯的日期範圍中的位置。當組件位置受控制時使用。
reduceAnimations	bool	`@media(prefers-reduced-motion: reduce)` \|\| `navigator.userAgent` 匹配 Android <10 或 iOS <13	如果 `true`，則禁用繁重的動畫。
referenceDate	object	使用驗證屬性的最接近的有效日期時間，除了像 `shouldDisable<...>` 這樣的回調。	當 `value` 和 `defaultValue` 都為空時，用於生成新值的日期。
renderLoading	func	() => "..."	當 `props.loading` 為 true 時，在「day」視圖上呈現的組件。簽名：`function() => React.ReactNode` 返回：加載時要呈現的節點。
shouldDisableDate	func	-	禁用特定日期。警告：此函數可以多次調用（例如，在呈現日期日曆、檢查焦點是否可以移動到特定日期等時）。昂貴的計算可能會影響性能。簽名：`function(day: TDate, position: string) => boolean` `day` 要測試的日期。 `position` 要測試的日期，'start' 或 'end'。返回：如果應禁用日期，則返回 `true`。
showDaysOutsideCurrentMonth	bool	false	如果 `true`，則呈現當前月份之外的日期 - 如果定義了 `fixedWeekNumber`，則呈現日期以具有請求的週數。 - 如果未定義 `fixedWeekNumber`，則呈現日期以填充當前月份的第一週和最後一週。 - 如果 `calendars` 等於範圍選擇器上的 `1` 以上，則忽略。
slotProps	object	{}	用於每個組件插槽的屬性。
slots	object	{}	可覆蓋的組件插槽。有關更多詳細資訊，請參閱下方的插槽 API。
sx	Array<func \| object \| bool> \| func \| object	-	允許定義系統覆蓋以及其他 CSS 樣式的系統屬性。有關更多詳細資訊，請參閱 `sx` 頁面。
timezone	string	定義 `value` 或 `defaultValue` 屬性的時區，否則為 'default'。	選擇要用於值的時區。範例：「default」、「system」、「UTC」、「America/New_York」。如果您將來自其他時區的值傳遞給某些屬性，它們將在被使用之前轉換為此時區。有關更多詳細資訊，請參閱時區文檔。
value	Array<object>	-	選定的值。當組件受控制時使用。
viewRenderers	{ day?: func }	-	為每個部分定義自訂視圖渲染器。如果為 `null`，則該部分將僅具有欄位編輯。如果為 `undefined`，則將使用內部定義的視圖。

ref 被轉發到根元素。

插槽

插槽名稱	預設組件	描述
actionBar	`PickersActionBar`	操作欄的自訂組件，它位於選擇器視圖下方。
calendarHeader	`PickersCalendarHeader`	日曆標題的自訂組件。查看 PickersCalendarHeader 組件。
day	`DateRangePickersDay`	範圍選擇器中日期的自訂組件。查看 DateRangePickersDay 組件。
layout		用於包裝佈局的自訂組件。它包裝工具欄、視圖、操作欄和快捷鍵。
leftArrowIcon	`ArrowLeft`	在左視圖切換按鈕中顯示的圖示。
nextIconButton	`IconButton`	允許切換到右視圖的按鈕。
previousIconButton	`IconButton`	允許切換到左視圖的按鈕。
rightArrowIcon	`ArrowRight`	在右視圖切換按鈕中顯示的圖示。
shortcuts	`PickersShortcuts`	快捷鍵的自訂組件。
switchViewButton	`IconButton`	顯示以在不同日曆視圖之間切換的按鈕。
switchViewIcon	`ArrowDropDown`	在 SwitchViewButton 中顯示的圖示。當打開的視圖為 `year` 時旋轉 180°。
toolbar	`DateTimePickerToolbar`	在視圖上方呈現的工具欄的自訂組件。

原始碼

如果您在此頁面中找不到資訊，請考慮查看組件的實現以獲取更多詳細資訊。