ant-design/components/calendar/index.zh-CN.md
陈小聪 014bed6358 docs: generate picker (#20515)
* docs: faq How to use dayjs instead of moment

* adjust article position

* add steps and use cases

* change docs

* add bisheng config source

* translate title

* remove customize TimePicker

* simplified document

* Update docs/react/generate-picker.zh-CN.md

Co-Authored-By: 偏右 <afc163@gmail.com>

* Update docs/react/generate-picker.zh-CN.md

Co-Authored-By: 偏右 <afc163@gmail.com>

* add cra demo

* init demo refer 'Use in TypeScript'

Co-authored-by: 偏右 <afc163@gmail.com>
2020-01-02 16:05:59 +08:00

2.4 KiB
Raw Blame History

category type subtitle cols title
Components 数据展示 日历 1 Calendar

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

何时使用

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

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
locale 国际化配置 object 默认配置
mode 初始模式,month/year string month
monthCellRender 自定义渲染月单元格,返回内容会被追加到单元格 function(date: moment): ReactNode
monthFullCellRender 自定义渲染月单元格,返回内容覆盖单元格 function(date: moment): ReactNode
validRange 设置可以显示的日期 [moment, moment]
value 展示日期 moment 当前日期
onPanelChange 日期面板变化回调 function(date: moment, mode: string)
onSelect 点击选择日期回调 function(date: moment
onChange 日期变化回调 function(date: moment
headerRender 自定义头部内容 function(object:{value: moment, type: string, onChange: f(), onTypeChange: f()})

FAQ