RangeCalendar

RangeCalendar 从 HeroUI v2 到 v3 的迁移指南。

完整的 API 参考、样式指南与高级示例请参阅 v3 RangeCalendar 文档。本指南只关注从 HeroUI v2 的迁移。

结构变化

在 v2 中，RangeCalendar 是一个完全通过 props 配置的单一组件：

1import { RangeCalendar } from "@lenso/ui";2import { today, getLocalTimeZone } from "@internationalized/date";3
4export default function App() {5  return (6    <RangeCalendar7      aria-label="Trip dates"8      defaultValue={{9        start: today(getLocalTimeZone()),10        end: today(getLocalTimeZone()).add({ weeks: 1 }),11      }}12    />13  );14}

在 v3 中，RangeCalendar 改用带显式子组件的复合组件模式：

1import { RangeCalendar } from "@lenso/ui";2import { today, getLocalTimeZone } from "@internationalized/date";3
4export default function App() {5  return (6    <RangeCalendar7      aria-label="Trip dates"8      defaultValue={{9        start: today(getLocalTimeZone()),10        end: today(getLocalTimeZone()).add({ weeks: 1 }),11      }}12    >13      <RangeCalendar.Header>14        <RangeCalendar.Heading />15        <RangeCalendar.NavButton slot="previous" />16        <RangeCalendar.NavButton slot="next" />17      </RangeCalendar.Header>18      <RangeCalendar.Grid>19        <RangeCalendar.GridHeader>20          {(day) => <RangeCalendar.HeaderCell>{day}</RangeCalendar.HeaderCell>}21        </RangeCalendar.GridHeader>22        <RangeCalendar.GridBody>23          {(date) => <RangeCalendar.Cell date={date} />}24        </RangeCalendar.GridBody>25      </RangeCalendar.Grid>26    </RangeCalendar>27  );28}

主要变化

1. 组件结构

v2： 单一 RangeCalendar 组件，所有布局都在内部处理
v3： 复合组件：RangeCalendar.Header、RangeCalendar.Heading、RangeCalendar.NavButton、RangeCalendar.Grid、RangeCalendar.GridHeader、RangeCalendar.GridBody、RangeCalendar.HeaderCell、RangeCalendar.Cell、RangeCalendar.CellIndicator

2. 年份选择器

v2： 通过 showMonthAndYearPickers prop 提供内置月份 / 年份选择器
v3： 使用专用复合组件：RangeCalendar.YearPickerTrigger、RangeCalendar.YearPickerGrid、RangeCalendar.YearPickerGridBody、RangeCalendar.YearPickerCell

3. Prop 变更

v2 prop	v3 等效项	说明
`value`	`value`	保持一致
`defaultValue`	`defaultValue`	保持一致
`onChange`	`onChange`	保持一致
`focusedValue`	`focusedValue`	保持一致
`onFocusChange`	`onFocusChange`	保持一致
`minValue`	`minValue`	保持一致
`maxValue`	`maxValue`	保持一致
`isDateUnavailable`	`isDateUnavailable`	保持一致
`allowsNonContiguousRanges`	`allowsNonContiguousRanges`	保持一致
`isDisabled`	`isDisabled`	保持一致
`isReadOnly`	`isReadOnly`	保持一致
`isInvalid`	`isInvalid`	保持一致
`pageBehavior`	`pageBehavior`	保持一致
`visibleMonths`	`visibleDuration`	改为 `{months: number}` 对象
`showMonthAndYearPickers`	-	使用 `RangeCalendar.YearPickerTrigger` 和 `RangeCalendar.YearPickerGrid`
`onHeaderExpandedChange`	`onYearPickerOpenChange`	已重命名
`color`	-	已移除（请改用 Tailwind CSS）
`calendarWidth`	-	已移除（请改用 `className` 或 Tailwind CSS）
`weekdayStyle`	-	已移除
`firstDayOfWeek`	-	改用 `I18nProvider` 的 locale
`topContent`	-	将自定义内容作为 `RangeCalendar` children 放在网格之前
`bottomContent`	-	将自定义内容作为 `RangeCalendar` children 放在网格之后
`errorMessage`	-	已移除（请在外部处理校验）
`showHelper`	-	已移除
`disableAnimation`	-	已移除
`classNames`	-	在各个复合组件上使用 `className`

迁移示例

基本范围选择

1import { RangeCalendar } from "@lenso/ui";2import { today, getLocalTimeZone } from "@internationalized/date";3
4<RangeCalendar5  aria-label="Trip dates"6  defaultValue={{7    start: today(getLocalTimeZone()),8    end: today(getLocalTimeZone()).add({ weeks: 1 }),9  }}10/>

受控状态

1import { useState } from "react";2import { RangeCalendar } from "@lenso/ui";3import { parseDate } from "@internationalized/date";4
5const [value, setValue] = useState({6  start: parseDate("2024-03-01"),7  end: parseDate("2024-03-07"),8});9
10<RangeCalendar11  aria-label="Trip dates"12  value={value}13  onChange={setValue}14/>

月份和年份选择器

1<RangeCalendar2  aria-label="Trip dates"3  showMonthAndYearPickers4/>

多个月份

1<RangeCalendar2  aria-label="Trip dates"3  visibleMonths={2}4/>

带非连续范围的不可用日期

1import { isWeekend } from "@internationalized/date";2import { useLocale } from "@react-aria/i18n";3
4const { locale } = useLocale();5
6<RangeCalendar7  aria-label="Trip dates"8  isDateUnavailable={(date) => isWeekend(date, locale)}9  allowsNonContiguousRanges10/>

顶部与底部内容

1<RangeCalendar2  aria-label="Trip dates"3  topContent={<p>Select your travel dates</p>}4  bottomContent={5    <button onClick={handleReset}>Reset</button>6  }7/>

样式变化

v2：`classNames` prop

1<RangeCalendar2  classNames={{3    base: "custom-base",4    prevButton: "custom-prev",5    nextButton: "custom-next",6    title: "custom-title",7    cell: "custom-cell",8    cellButton: "custom-cell-button",9  }}10/>

v3：直接使用 `className` prop

1<RangeCalendar className="custom-base">2  <RangeCalendar.Header>3    <RangeCalendar.Heading className="custom-title" />4    <RangeCalendar.NavButton slot="previous" className="custom-prev" />5    <RangeCalendar.NavButton slot="next" className="custom-next" />6  </RangeCalendar.Header>7  <RangeCalendar.Grid>8    <RangeCalendar.GridHeader>9      {(day) => <RangeCalendar.HeaderCell>{day}</RangeCalendar.HeaderCell>}10    </RangeCalendar.GridHeader>11    <RangeCalendar.GridBody>12      {(date) => <RangeCalendar.Cell date={date} className="custom-cell" />}13    </RangeCalendar.GridBody>14  </RangeCalendar.Grid>15</RangeCalendar>

组件结构

v3 RangeCalendar 遵循以下结构：

1RangeCalendar (Root)2  ├── [Custom top content]3  ├── RangeCalendar.Header4  │   ├── RangeCalendar.Heading (or RangeCalendar.YearPickerTrigger)5  │   ├── RangeCalendar.NavButton slot="previous"6  │   └── RangeCalendar.NavButton slot="next"7  ├── RangeCalendar.Grid (one per visible month)8  │   ├── RangeCalendar.GridHeader9  │   │   └── RangeCalendar.HeaderCell (render prop)10  │   └── RangeCalendar.GridBody11  │       └── RangeCalendar.Cell (render prop)12  │           └── RangeCalendar.CellIndicator (optional)13  ├── RangeCalendar.YearPickerGrid (optional)14  │   └── RangeCalendar.YearPickerGridBody15  │       └── RangeCalendar.YearPickerCell16  └── [Custom bottom content]

总结

组件结构：单一组件 → 带显式布局控制的复合组件
年份选择器：showMonthAndYearPickers prop → 专用的 RangeCalendar.YearPickerTrigger 和 RangeCalendar.YearPickerGrid 组件
多个月份：visibleMonths={n} → visibleDuration={{months: n}}，并使用多个带 offset 的 RangeCalendar.Grid 组件
color 已移除：请改用 Tailwind CSS 类
顶部 / 底部内容：prop 已移除 → 直接将内容作为 children 放在 RangeCalendar 内
单元格自定义：新增 RangeCalendar.CellIndicator，且 RangeCalendar.Cell 支持渲染 prop
样式：classNames prop → 各个复合组件上的 className
已移除 prop：calendarWidth、weekdayStyle、showHelper、errorMessage、disableAnimation —— 请使用 Tailwind CSS 或在外部处理