ant-design/components/calendar/index.zh-CN.md
muxin 07d5e5e7bb
feat: migrate less to token for Calendar (#42194)
* feat: rename calendar token

* docs: add component-token demo
2023-05-18 16:12:41 +08:00

5.3 KiB
Raw Blame History

category group subtitle title cover coverDark
Components 数据展示 日历 Calendar https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*nF6_To7pDSAAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-p-wQLik200AAAAAAAAAAAAADrJ8AQ/original

按照日历形式展示数据的容器。

何时使用

当数据是日期或按照日期划分时,例如日程、课表、价格日历等,农历等。目前支持年/月切换。

代码演示

基本 通知事项日历 卡片模式 选择功能 自定义头部 组件 Token

API

注意Calendar 部分 locale 是从 value 中读取,所以请先正确设置 dayjs 的 locale。

// 默认语言为 en-US所以如果需要使用其他语言推荐在入口文件全局设置 locale
// import dayjs from 'dayjs';
// import 'dayjs/locale/zh-cn';
// dayjs.locale('zh-cn');

<Calendar
  dateCellRender={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
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
monthFullCellRender 自定义渲染月单元格,返回内容覆盖单元格,>= 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
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

Design Token

FAQ

如何在 Calendar 中使用自定义日期库

参考 使用自定义日期库

如何给日期类组件配置国际化?

参考 如何给日期类组件配置国际化

为什么时间类组件的国际化 locale 设置不生效?

参考 FAQ 为什么时间类组件的国际化 locale 设置不生效?

如何仅获取来自面板点击的日期?

onSelect 事件提供额外的来源信息,你可以通过 info.source 来判断来源:

<Calendar
  onSelect={(date, { source }) => {
    if (source === 'date') {
      console.log('Panel Select:', source);
    }
  }}
/>