mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-30 12:28:33 +08:00
89 lines
4.3 KiB
Markdown
89 lines
4.3 KiB
Markdown
---
|
||
category: Components
|
||
group: 数据展示
|
||
title: Calendar
|
||
subtitle: 日历
|
||
description: 按照日历形式展示数据的容器。
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*nF6_To7pDSAAAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-p-wQLik200AAAAAAAAAAAAADrJ8AQ/original
|
||
---
|
||
|
||
## 何时使用
|
||
|
||
当数据是日期或按照日期划分时，例如日程、课表、价格日历等，农历等。目前支持年/月切换。
|
||
|
||
## 代码演示
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx" clientOnly>基本</code>
|
||
<code src="./demo/notice-calendar.tsx" clientOnly>通知事项日历</code>
|
||
<code src="./demo/card.tsx" clientOnly>卡片模式</code>
|
||
<code src="./demo/select.tsx" clientOnly>选择功能</code>
|
||
<code src="./demo/lunar.tsx" clientOnly>农历日历</code>
|
||
<code src="./demo/customize-header.tsx" clientOnly>自定义头部</code>
|
||
<code src="./demo/component-token.tsx" debug>组件 Token</code>
|
||
|
||
## API
|
||
|
||
通用属性参考：[通用属性](/docs/react/common-props)
|
||
|
||
**注意**：Calendar 部分 locale 是从 value 中读取，所以请先正确设置 dayjs 的 locale。
|
||
|
||
```jsx
|
||
// 默认语言为 en-US，所以如果需要使用其他语言，推荐在入口文件全局设置 locale
|
||
// import dayjs from 'dayjs';
|
||
// import 'dayjs/locale/zh-cn';
|
||
// dayjs.locale('zh-cn');
|
||
|
||
<Calendar cellRender={cellRender} onPanelChange={onPanelChange} onSelect={onSelect} />
|
||
```
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| cellRender | 自定义单元格的内容 | function(current: dayjs, info: { prefixCls: string, originNode: React.ReactElement, today: dayjs, 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, info: { prefixCls: string, originNode: React.ReactElement, today: dayjs, range?: 'start' \| 'end', type: PanelMode, locale?: Locale, subType?: 'hour' \| 'minute' \| 'second' \| 'meridiem' }) => React.ReactNode | - | 5.4.0 |
|
||
| defaultValue | 默认展示的日期 | [dayjs](https://day.js.org/) | - | |
|
||
| disabledDate | 不可选择的日期，参数为当前 `value`，注意使用时[不要直接修改](https://github.com/ant-design/ant-design/issues/30987) | (currentDate: Dayjs) => boolean | - | |
|
||
| fullscreen | 是否全屏显示 | boolean | true | |
|
||
| headerRender | 自定义头部内容 | function(object:{value: Dayjs, type: string, onChange: f(), onTypeChange: f()}) | - | |
|
||
| locale | 国际化配置 | object | [(默认配置)](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) | |
|
||
| mode | 初始模式 | `month` \| `year` | `month` | |
|
||
| validRange | 设置可以显示的日期 | \[[dayjs](https://day.js.org/), [dayjs](https://day.js.org/)] | - | |
|
||
| value | 展示日期 | [dayjs](https://day.js.org/) | - | |
|
||
| onChange | 日期变化回调 | function(date: Dayjs) | - | |
|
||
| onPanelChange | 日期面板变化回调 | function(date: Dayjs, mode: string) | - | |
|
||
| onSelect | 选择日期回调，包含来源信息 | function(date: Dayjs, info: { source: 'year' \| 'month' \| 'date' \| 'customize' }) | - | `info`: 5.6.0 |
|
||
|
||
## 主题变量（Design Token）
|
||
|
||
<ComponentTokenTable component="Calendar"></ComponentTokenTable>
|
||
|
||
## FAQ
|
||
|
||
### 如何在 Calendar 中使用自定义日期库
|
||
|
||
参考 [使用自定义日期库](/docs/react/use-custom-date-library#calendar)。
|
||
|
||
### 如何给日期类组件配置国际化？
|
||
|
||
参考 [如何给日期类组件配置国际化](/components/date-picker-cn#%E5%9B%BD%E9%99%85%E5%8C%96%E9%85%8D%E7%BD%AE)。
|
||
|
||
### 为什么时间类组件的国际化 locale 设置不生效？
|
||
|
||
参考 FAQ [为什么时间类组件的国际化 locale 设置不生效？](/docs/react/faq#为什么时间类组件的国际化-locale-设置不生效)。
|
||
|
||
### 如何仅获取来自面板点击的日期？
|
||
|
||
`onSelect` 事件提供额外的来源信息，你可以通过 `info.source` 来判断来源：
|
||
|
||
```tsx
|
||
<Calendar
|
||
onSelect={(date, { source }) => {
|
||
if (source === 'date') {
|
||
console.log('Panel Select:', source);
|
||
}
|
||
}}
|
||
/>
|
||
```
|