跳到主要內容

MobileDateRangePickerAPI

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

示範

匯入

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

瞭解差異，請閱讀本指南，瞭解如何最小化套件大小。

屬性

名稱類型預設值描述
autoFocusbool-

如果 true，則主要元素會在首次掛載期間取得焦點。此主要元素為： - 可見視圖選擇的元素（若有）（即：day 視圖中選取的日期）。 - 如果有呈現欄位，則為 input 元素。

closeOnSelectbool桌面版為 true，行動版為 false（根據選取的包裝函式和 desktopModeMediaQuery 屬性）。

如果 true，則在提交完整日期後，快顯視窗或模式視窗將會關閉。

currentMonthCalendarPosition1
| 2
| 3		1

目前月份呈現的位置。

dayOfWeekFormatterfunc(date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()

格式化日曆標題中顯示的星期幾。

簽名：function(date: TDate) => string
  • date 適配器提供的星期幾的日期。

傳回： 要顯示的名稱。

defaultRangePosition'end'
| 'start'		'start'

編輯日期範圍中的初始位置。當組件不受控制時使用。

defaultValueArray<object>-

預設值。當組件不受控制時使用。

disableAutoMonthSwitchingboolfalse

如果 true，則在選取 start 日期後，日曆將不會自動切換到 end 日期的月份。

disabledboolfalse

如果 true，則停用選擇器和文字欄位。

disableDragEditingboolfalse

如果 true，則停用透過拖曳編輯日期。

disableFutureboolfalse

如果 true，則針對日期組件停用目前日期之後的值，針對時間組件停用時間，針對日期時間組件則停用兩者。

disableHighlightTodayboolfalse

如果 true，則今天的日期在呈現時不會以圓圈醒目提示。

disableOpenPickerboolfalse

如果 true，則不會呈現開啟選擇器按鈕（僅呈現欄位）。

disablePastboolfalse

如果 true，則針對日期組件停用目前日期之前的值，針對時間組件停用時間，針對日期時間組件則停用兩者。

displayWeekNumberbool-

如果 true，則星期數將顯示在日曆中。

fixedWeekNumbernumber-

日期檢視將顯示目前月份結束後所需的週數，以符合此值。設為 6 可在公曆中固定週數

formatstring-

在輸入中呈現日期的格式。預設為根據使用的 views 本地化格式。

formatDensity'dense'
| 'spacious'		"dense"

在輸入中呈現格式的密度。將 formatDensity 設定為 "spacious" 將在每個 /、- 和 . 字元前後新增空格。

inputRefref-

將 ref 傳遞至 input 元素。如果欄位有多個輸入，則忽略。

labelnode-

標籤內容。如果欄位有多個輸入，則忽略。

loadingboolfalse

如果 true，則呼叫 renderLoading 而不是呈現日期日曆。可用於預先載入資訊並在日曆中顯示。

localeTextobject-

組件文字的地區設定。允許覆寫來自 LocalizationProvider 和 theme 的文字。

maxDateobject2099-12-31

最大可選日期。

minDateobject1900-01-01

最小可選日期。

namestring-

Field 中 input 元素使用的 Name 屬性。如果欄位有多個輸入，則忽略。

onAcceptfunc-

當值被接受時觸發的回呼。

簽名：function(value: TValue, context: FieldChangeHandlerContext) => void
  • value 剛接受的值。
  • context 包含目前值的驗證結果的內容。
onChangefunc-

當值變更時觸發的回呼。

簽名：function(value: TValue, context: FieldChangeHandlerContext) => void
  • value 新值。
  • context 包含目前值的驗證結果的內容。
onClosefunc-

當快顯視窗要求關閉時觸發的回呼。在受控模式中使用（請參閱 open）。

onErrorfunc-

當與目前值相關聯的錯誤變更時觸發的回呼。當偵測到驗證錯誤時，error 參數包含非空值。這可用於呈現適當的表單錯誤。

簽名：function(error: TError, value: TValue) => void
  • error 目前值無效的原因。
  • value 與錯誤相關聯的值。
onMonthChangefunc-

在月份變更時觸發的回呼。

簽名：function(month: TDate) => void
  • month 新月份。
onOpenfunc-

當快顯視窗要求開啟時觸發的回呼。在受控模式中使用（請參閱 open）。

onRangePositionChangefunc-

當範圍位置變更時觸發的回呼。

簽名：function(rangePosition: RangePosition) => void
  • rangePosition 新範圍位置。
onSelectedSectionsChangefunc-

當選取的區段變更時觸發的回呼。

簽名：function(newValue: FieldSelectedSections) => void
  • newValue 新選取的區段。
openboolfalse

控制快顯視窗或對話方塊開啟狀態。

rangePosition'end'
| 'start'		-

目前編輯的日期範圍中的位置。當組件位置受控制時使用。

reduceAnimationsbool`@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` 符合 Android <10 或 iOS <13

如果 true，則停用繁重的動畫。

referenceDateobject使用驗證屬性的最接近有效日期時間，但回呼（例如 shouldDisable<...>）除外。

當 value 和 defaultValue 皆為空時，用於產生新值的日期。

renderLoadingfunc() => "..."

當 props.loading 為 true 時，在「day」視圖上呈現的組件。

簽名：function() => React.ReactNode

    傳回： 載入時要呈現的節點。

    selectedSections'all'
    | 'day'
    | 'empty'
    | 'hours'
    | 'meridiem'
    | 'minutes'
    | 'month'
    | 'seconds'
    | 'weekDay'
    | 'year'
    | number    		-

    目前選取的區段。此屬性接受四種格式：1. 如果提供數字，則將選取此索引處的區段。2. 如果提供 FieldSectionType 類型的字串，則將選取具有該名稱的第一個區段。3. 如果提供 "all"，則將選取所有區段。4. 如果提供 null，則不會選取任何區段。如果未提供，則選取的區段將在內部處理。

    shouldDisableDatefunc-

    停用特定日期。
    警告：此函式可能會被多次呼叫（例如，當呈現日期日曆、檢查焦點是否可以移動到特定日期等時）。昂貴的計算可能會影響效能。

    簽名：function(day: TDate, position: string) => boolean
    • day 要測試的日期。
    • position 要測試的日期，「start」或「end」。

    傳回： 如果應停用日期，則傳回 true。

    showDaysOutsideCurrentMonthboolfalse

    如果 true，則呈現目前月份以外的日期
    - 如果已定義 fixedWeekNumber，則呈現日期以符合要求的週數。
    - 如果未定義 fixedWeekNumber，則呈現日期以填滿目前月份的第一週和最後一週。
    - 如果範圍選擇器上的 calendars 等於多個 1，則忽略。

    slotPropsobject{}

    用於每個組件插槽的屬性。

    slotsobject{}

    可覆寫的組件插槽。

    請參閱下方的 插槽 API 以瞭解更多詳細資訊。

    sxArray<func
    | object
    | bool>
    | func
    | object    		-

    允許定義系統覆寫以及其他 CSS 樣式的系統屬性。

    請參閱 sx 頁面以瞭解更多詳細資訊。

    timezonestring定義 value 或 defaultValue 屬性的時區，否則為「default」。

    選擇要用於值的時區。範例：「default」、「system」、「UTC」、「America/New_York」。如果您將來自其他時區的值傳遞給某些屬性，則它們將在被使用前轉換為此時區。

    請參閱 時區文件以瞭解更多詳細資訊。

    valueArray<object>-

    選取的值。當組件受控制時使用。

    viewRenderers{ day?: func }-

    為每個區段定義自訂視圖呈現器。如果為 null，則區段將僅具有欄位編輯。如果為 undefined，則將使用內部定義的視圖。

    ref 會轉發到根元素。

    插槽

    插槽名稱類別名稱預設組件描述
    actionBarPickersActionBar動作列的自訂組件，它位於選擇器視圖下方。
    calendarHeaderPickersCalendarHeader日曆標題的自訂組件。檢查 PickersCalendarHeader 組件。
    clearButtonIconButton用於清除值的按鈕。
    clearIconClearIcon用於顯示在清除按鈕內的圖示。
    dayDateRangePickersDay範圍選擇器中日期的自訂組件。檢查 DateRangePickersDay 組件。
    dialogPickersModalDialogRoot用於在行動裝置上呈現視圖的對話方塊的自訂組件。
    field
    fieldRoot在根目錄呈現的元素。如果欄位只有一個輸入，則忽略。
    fieldSeparator在兩個輸入之間呈現的元素。如果欄位只有一個輸入，則忽略。
    layout用於包裝版面配置的自訂組件。它包裝工具列、視圖、動作列和快捷方式。
    leftArrowIconArrowLeft顯示在左側視圖切換按鈕中的圖示。
    mobilePaper來自 '@mui/material' 的 Paper。用於在行動選擇器的對話方塊內呈現的紙張的自訂組件。
    mobileTransition來自 '@mui/material' 的 Fade。行動對話方塊 Transition 的自訂組件。
    nextIconButtonIconButton允許切換到右側視圖的按鈕。
    previousIconButtonIconButton允許切換到左側視圖的按鈕。
    rightArrowIconArrowRight顯示在右側視圖切換按鈕中的圖示。
    shortcutsPickersShortcuts快捷方式的自訂組件。
    switchViewButtonIconButton顯示用於在不同日曆視圖之間切換的按鈕。
    switchViewIconArrowDropDown顯示在 SwitchViewButton 中的圖示。當開啟的視圖為 year 時旋轉 180°。
    textField來自 '@mui/material' 的 TextField 或 PickersTextField（如果 enableAccessibleFieldDOMStructure 為 true）。具有輸入的表單控制項，用於在預設欄位內呈現日期或時間。它會呈現兩次：一次用於開始元素，另一次用於結束元素。
    toolbarDateTimePickerToolbar用於在視圖上方呈現的工具列的自訂組件。

    原始碼

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