ant-design/components/date-picker/index.zh-CN.md

132 lines
6.2 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
type: Data Entry
title: DatePicker
subtitle: 日期选择框
2016-03-31 14:17:09 +08:00
---
2015-05-21 20:36:13 +08:00
2016-11-14 19:13:37 +08:00
输入或选择日期的控件。
2015-06-14 17:54:08 +08:00
## 何时使用
2015-11-19 14:28:54 +08:00
当用户需要输入一个日期,可以点击标准输入框,弹出日期面板进行选择。
2015-05-27 20:41:16 +08:00
2015-08-25 14:15:46 +08:00
## API
日期类组件包括以下四种形式。
2016-11-14 19:13:37 +08:00
2017-10-25 10:25:44 +08:00
- DatePicker
- MonthPicker
- RangePicker
2017-10-25 10:27:38 +08:00
- WeekPicker
2016-11-14 19:13:37 +08:00
### 国际化配置
默认配置为 en-US如果你需要设置其他语言推荐在入口处使用我们提供的国际化组件,详见:[LocaleProvider国际化](http://ant.design/components/locale-provider-cn/)。
如有特殊需求(仅修改单一组件的语言),请使用 locale 参数,参考:[默认配置](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json)。
```jsx
import locale from 'antd/lib/date-picker/locale/zh_CN';
<DatePicker locale={locale} />
```
**注意:**DatePicker、MonthPicker、RangePicker、WeekPicker 部分 locale 是从 value 中读取,所以请先正确设置 moment 的 locale。
2015-12-11 11:11:24 +08:00
```jsx
// 默认语言为 en-US如果你需要设置其他语言推荐在入口文件全局设置 locale
2018-06-08 12:22:22 +08:00
import moment from 'moment';
2018-07-15 10:14:35 +08:00
import 'moment/locale/zh-cn';
2016-11-02 13:47:05 +08:00
<DatePicker defaultValue={moment('2015-01-01', 'YYYY-MM-DD')} />
2015-05-29 22:25:04 +08:00
```
### 共同的 API
以下 API 为 DatePicker、MonthPicker、RangePicker, WeekPicker 共享的 API。
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| allowClear | 是否显示清除按钮 | boolean | true |
| autoFocus | 自动获取焦点 | boolean | false |
2017-10-25 10:25:44 +08:00
| className | 选择器 className | string | '' |
2017-10-25 10:27:38 +08:00
| dateRender | 自定义日期单元格的内容 | function(currentDate: moment, today: moment) => React.ReactNode | - |
2017-10-25 10:25:44 +08:00
| disabled | 禁用 | boolean | false |
| disabledDate | 不可选择的日期 | (currentDate: moment) => boolean | 无 |
2018-06-24 17:09:18 +08:00
| dropdownClassName | 额外的弹出日历 className | string | - |
| getCalendarContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 |
2017-10-25 10:25:44 +08:00
| locale | 国际化配置 | object | [默认配置](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) |
| open | 控制弹层是否展开 | boolean | - |
2017-10-25 10:25:44 +08:00
| placeholder | 输入框提示文字 | string\|RangePicker\[] | - |
| popupStyle | 额外的弹出日历样式 | object | {} |
2017-10-25 10:27:38 +08:00
| size | 输入框大小,`large` 高度为 40px`small` 为 24px默认是 32px | string | 无 |
2017-10-25 10:25:44 +08:00
| style | 自定义输入框样式 | object | {} |
| onOpenChange | 弹出日历和关闭日历的回调 | function(status) | 无 |
### 共同的方法
| 名称 | 描述 |
2017-12-29 20:22:58 +08:00
| --- | --- |
| blur() | 移除焦点 |
2017-12-29 20:22:58 +08:00
| focus() | 获取焦点 |
### DatePicker
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| defaultValue | 默认日期 | [moment](http://momentjs.com/) | 无 |
2016-11-11 16:06:11 +08:00
| disabledTime | 不可选择的时间 | function(date) | 无 |
2017-10-25 10:25:44 +08:00
| format | 展示的日期格式,配置参考 [moment.js](http://momentjs.com/) | string | "YYYY-MM-DD" |
2018-06-24 17:09:18 +08:00
| mode | 日期面板的状态 | `time|date|month|year` | 'date' |
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |
2017-10-25 10:25:44 +08:00
| showTime | 增加时间选择功能 | Object\|boolean | [TimePicker Options](/components/time-picker/#API) |
| showTime.defaultValue | 设置用户选择日期时默认的时分秒,[例子](https://ant.design/components/date-picker/#components-date-picker-demo-disabled-date) | [moment](http://momentjs.com/) | moment() |
| showToday | 是否展示“今天”按钮 | boolean | true |
| value | 日期 | [moment](http://momentjs.com/) | 无 |
| onChange | 时间发生变化的回调 | function(date: moment, dateString: string) | 无 |
| onOk | 点击确定按钮的回调 | function() | - |
| onPanelChange | 日期面板变化时的回调 | function(value, mode) | - |
2015-06-02 17:06:50 +08:00
2016-04-13 09:25:29 +08:00
### MonthPicker
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| defaultValue | 默认日期 | [moment](http://momentjs.com/) | 无 |
| format | 展示的日期格式,配置参考 [moment.js](http://momentjs.com/) | string | "YYYY-MM" |
| monthCellContentRender | 自定义的月份内容渲染方法 | function(date, locale): ReactNode | - |
2017-12-29 20:22:58 +08:00
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |
2017-10-25 10:25:44 +08:00
| value | 日期 | [moment](http://momentjs.com/) | 无 |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date: moment, dateString: string) | - |
2016-04-13 09:25:29 +08:00
### WeekPicker
2017-10-25 10:27:38 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| defaultValue | 默认日期 | [moment](http://momentjs.com/) | - |
| format | 展示的日期格式,配置参考 [moment.js](http://momentjs.com/) | string | "YYYY-wo" |
2017-10-25 10:27:38 +08:00
| value | 日期 | [moment](http://momentjs.com/) | - |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date: moment, dateString: string) | - |
2015-12-11 11:11:24 +08:00
### RangePicker
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| defaultValue | 默认日期 | [moment](http://momentjs.com/)\[] | 无 |
| disabledTime | 不可选择的时间 | function(dates: [moment, moment], partial: `'start'|'end'`) | 无 |
2017-10-25 10:25:44 +08:00
| format | 展示的日期格式 | string | "YYYY-MM-DD HH:mm:ss" |
2018-06-24 17:09:18 +08:00
| ranges       | 预设时间范围快捷选择 | { \[range: string]: [moment](http://momentjs.com/)\[] } \| () => { \[range: string]: [moment](http://momentjs.com/)\[] } | 无 |
| renderExtraFooter | 在面板中添加额外的页脚 | () => React.ReactNode | - |
2017-10-25 10:25:44 +08:00
| showTime | 增加时间选择功能 | Object\|boolean | [TimePicker Options](/components/time-picker/#API) |
| showTime.defaultValue | 设置用户选择日期时默认的时分秒,[例子](https://ant.design/components/date-picker/#components-date-picker-demo-disabled-date) | [moment](http://momentjs.com/)\[] | [moment(), moment()] |
| value | 日期 | [moment](http://momentjs.com/)\[] | 无 |
| onCalendarChange | 待选日期发生变化的回调 | function(dates: [moment, moment], dateStrings: [string, string]) | 无 |
2017-12-29 20:22:58 +08:00
| onChange | 日期范围发生变化的回调 | function(dates: [moment, moment], dateStrings: [string, string]) | 无 |
| onOk | 点击确定按钮的回调 | function() | - |
2015-12-11 11:11:24 +08:00
2015-05-27 20:41:16 +08:00
<style>
2015-08-03 16:57:03 +08:00
.code-box-demo .ant-calendar-picker {
2015-11-19 14:28:54 +08:00
margin: 0 8px 12px 0;
2015-08-03 16:57:03 +08:00
}
2015-05-27 20:41:16 +08:00
</style>