ant-design/components/calendar/index.zh-CN.md
Tom Xu d44f404eae
docs: sort api (#27251)
* chore: improve sort api table scripts

* sort api

* add ignore

* Revert "sort api"

This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207.

* sort api

* Update package.json

* sort api

* Delete sort-api.js

* sort api

* sort api

* sort api

* fix

* Update index.zh-CN.md

* fix input-number

* fix input-number

* sort func

* fix

* Method moved to the end

* carousel method
2020-10-21 10:33:43 +08:00

2.5 KiB
Raw Blame History

category type subtitle cols title cover
Components 数据展示 日历 1 Calendar https://gw.alipayobjects.com/zos/antfincdn/dPQmLq08DI/Calendar.svg

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

何时使用

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

API

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

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

<Calendar
  dateCellRender={dateCellRender}
  monthCellRender={monthCellRender}
  onPanelChange={onPanelChange}
  onSelect={onSelect}
/>
参数 说明 类型 默认值 版本
dateCellRender 自定义渲染日期单元格,返回内容会被追加到单元格 function(date: moment): ReactNode -
dateFullCellRender 自定义渲染日期单元格,返回内容覆盖单元格 function(date: moment): ReactNode -
defaultValue 默认展示的日期 moment -
disabledDate 不可选择的日期 (currentDate: moment) => boolean -
fullscreen 是否全屏显示 boolean true
headerRender 自定义头部内容 function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()}) -
locale 国际化配置 object (默认配置)
mode 初始模式 month | year month
monthCellRender 自定义渲染月单元格,返回内容会被追加到单元格 function(date: moment): ReactNode -
monthFullCellRender 自定义渲染月单元格,返回内容覆盖单元格 function(date: moment): ReactNode -
validRange 设置可以显示的日期 [moment, moment] -
value 展示日期 moment -
onChange 日期变化回调 function(date: moment -
onPanelChange 日期面板变化回调 function(date: moment, mode: string) -
onSelect 点击选择日期回调 function(date: moment -

FAQ