Calendar日历
Calendar
日历
按照日历形式展示数据的容器。
使用import{ Calendar }from"antd"; |
文档编辑此页 |
- 组件总览
- 通用
- 布局
- 导航
- 数据录入
- 数据展示
- 反馈
- 其他
当数据是日期或按照日期划分时，例如日程、课表、价格日历等，农历等。目前支持年/月切换。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 | 27 | 28 | 29 | 30 | 31 | 01 |
02 | 03 | 04 | 05 | 06 | 07 | 08 |
09 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 01 | 02 | 03 | 04 | 05 | 06 |
一个通用的日历面板，支持年/月切换。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 | 27 | 28 | 29 | 30 | 31 | 01 |
02 | 03 | 04 | 05 | 06 | 07 | 08
|
09 | 10
| 11 | 12 | 13 | 14 | 15
|
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 01 | 02 | 03 | 04 | 05 | 06 |
一个复杂的应用示例，用 dateCellRender 和 monthCellRender 函数来自定义需要渲染的数据。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 | 27 | 28 | 29 | 30 | 31 | 01 |
02 | 03 | 04 | 05 | 06 | 07 | 08 |
09 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 01 | 02 | 03 | 04 | 05 | 06 |
用于嵌套在空间有限的容器中。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 | 27 | 28 | 29 | 30 | 31 | 01 |
02 | 03 | 04 | 05 | 06 | 07 | 08 |
09 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 31 | 01 | 02 | 03 | 04 | 05 |
一个通用的日历面板，支持年/月切换。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 廿三 | 27 廿四 | 28 廿五 | 29 廿六 | 30 廿七 | 31 廿八 | 1 廿九 |
2 三十 | 3 初一 | 4 初二 | 5 初三 | 6 初四 | 7 白露 | 8 初六 |
9 初七 | 10 初八 | 11 初九 | 12 初十 | 13 十一 | 14 十二 | 15 十三 |
16 十四 | 17 中秋节 | 18 十六 | 19 十七 | 20 十八 | 21 十九 | 22 秋分 |
23 廿一 | 24 廿二 | 25 廿三 | 26 廿四 | 27 廿五 | 28 廿六 | 29 廿七 |
30 廿八 | 1 国庆节 | 2 三十 | 3 初一 | 4 初二 | 5 初三 | 6 初四 |
展示农历、节气等信息。
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
26 | 27 | 28 | 29 | 30 | 31 | 01 |
02 | 03 | 04 | 05 | 06 | 07 | 08 |
09 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 01 | 02 | 03 | 04 | 05 | 06 |
自定义日历头部内容。
通用属性参考：通用属性
注意：Calendar 部分 locale 是从 value 中读取，所以请先正确设置 dayjs 的 locale。
// 默认语言为 en-US，所以如果需要使用其他语言，推荐在入口文件全局设置 locale// import dayjs from 'dayjs';// import 'dayjs/locale/zh-cn';// dayjs.locale('zh-cn');<CalendardateCellRender={dateCellRender}monthCellRender={monthCellRender}onPanelChange={onPanelChange}onSelect={onSelect}/>
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| dateCellRender | 自定义渲染日期单元格，返回内容会被追加到单元格，>= 5.4.0 请用 cellRender | function(date: Dayjs): ReactNode | - | < 5.4.0 |
| cellRender | 自定义单元格的内容 | function(current: dayjs, today: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' | 'end', type: PanelMode, locale?: Locale, subType?: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode | - | 5.4.0 |
| dateFullCellRender | 自定义渲染日期单元格，返回内容覆盖单元格，>= 5.4.0 请用 fullCellRender | function(date: Dayjs): ReactNode | - | < 5.4.0 |
| fullCellRender | 自定义单元格的内容 | function(current: dayjs, today: dayjs, info: { originNode: React.ReactElement,today: DateType, range?: 'start' | 'end', type: PanelMode, locale?: Locale, subType?: 'hour' | 'minute' | 'second' | 'meridiem' }) => React.ReactNode | - | 5.4.0 |
| defaultValue | 默认展示的日期 | dayjs | - | |
| disabledDate | 不可选择的日期，参数为当前 value，注意使用时不要直接修改 | (currentDate: Dayjs) => boolean | - | |
| fullscreen | 是否全屏显示 | boolean | true | |
| headerRender | 自定义头部内容 | function(object:{value: Dayjs, type: string, onChange: f(), onTypeChange: f()}) | - | |
| locale | 国际化配置 | object | (默认配置) | |
| mode | 初始模式 | month | year | month | |
| monthCellRender | 自定义渲染月单元格，返回内容会被追加到单元格，>= 5.4.0 请用 cellRender | function(date: Dayjs): ReactNode | - | < 5.4.0 |
| monthFullCellRender | 自定义渲染月单元格，返回内容覆盖单元格，>= 5.4.0 请用 fullCellRender | function(date: Dayjs): ReactNode | - | < 5.4.0 |
| validRange | 设置可以显示的日期 | [dayjs, dayjs] | - | |
| value | 展示日期 | dayjs | - | |
| onChange | 日期变化回调 | function(date: Dayjs) | - | |
| onPanelChange | 日期面板变化回调 | function(date: Dayjs, mode: string) | - | |
| onSelect | 选择日期回调，包含来源信息 | function(date: Dayjs, info: { source: 'year' | 'month' | 'date' | 'customize' }) | - | info: 5.6.0 |
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| fullBg | 完整日历背景色 | string | #ffffff |
| fullPanelBg | 完整日历面板背景色 | string | #ffffff |
| itemActiveBg | 日期项选中背景色 | string | #e6f4ff |
| miniContentHeight | 迷你日历内容高度 | string | number | 256 |
| monthControlWidth | 月选择器宽度 | string | number | 70 |
| yearControlWidth | 年选择器宽度 | string | number | 80 |
参考 使用自定义日期库。
参考 如何给日期类组件配置国际化。
参考 FAQ 为什么时间类组件的国际化 locale 设置不生效？。
onSelect 事件提供额外的来源信息，你可以通过 info.source 来判断来源：
<CalendaronSelect={(date, { source }) => {if (source === 'date') {console.log('Panel Select:', source);}}}/>
