屬性

PropTypeDefault說明
value{ start: Date | null; end: Date | null }選定的日期範圍值
onChange(value: { start: Date | null; end: Date | null }) => void值變更時的回呼
presetsDateRangePreset[]預定義的日期範圍預設
maxDaysnumber範圍內允許的最大天數(含)
minDaysnumber範圍内要求的最小天數(含)
allowSingleDateInRangebooleantrue允許開始等於結束的範圍
minDateDate最小可選日期
maxDateDate最大可選日期
localePartial<Locale>自訂語言環境設定
initialMonthDate初始顯示月份
size"small" | "medium" | "large" | "x-large""medium"元件大小
weekStartsOnWeekDay"sunday"一週的第一天
isDateUnavailable(date: Date) => boolean將日期標記為停用
displayFormatstring自訂顯示格式(例如 "YYYY/MM/DD"
openboolean受控的開啟狀態
initialOpenboolean初始開啟狀態(非受控)
onOpenChange(open: boolean) => void開啟狀態變更時的回呼
requiredbooleanfalse停用清除值
showOutsideDaysbooleanfalse顯示相鄰月份的日期
highlightDatesDate[]要突顯的日期
shouldCloseOnSelectbooleanfalse選擇結束日期時自動確認
numberOfMonthsnumber2要顯示的月份數
captionLayout"buttons" | "dropdown""buttons"標題導覽樣式
fromYearnumber下拉選單的開始年份
toYearnumber下拉選單的結束年份
disablePastbooleanfalse停用今天之前的日期
disableFuturebooleanfalse停用今天之後的日期
inlinebooleanfalse內聯顯示日曆(無彈出視窗)
namestring用於表單提交的隱藏輸入名稱(開始日期)
endNamestring結束日期的隱藏輸入名稱(預設為 name-end
placeholderstring觸發器的預留位置文字
hideHeaderbooleanfalse隱藏導覽標頭
hideFooterbooleanfalse隱藏動作頁尾

DateRangePreset

interface DateRangePreset {
label: string;
value: { start: Date; end: Date } | (() => { start: Date; end: Date });
}