Props

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 });
}