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

81 lines
4.1 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-06-27 18:21:12 +08:00
type: Form Controls
title: DatePicker
subtitle: 日期选择框
2016-03-31 14:17:09 +08:00
---
2015-05-21 20:36:13 +08:00
2015-11-19 14:28:54 +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
2015-12-11 11:11:24 +08:00
### DatePicker
```jsx
import moment from 'moment-timezone/moment-timezone';
// 推荐在入口文件全局设置 locale 与时区
import 'moment/locale/zh-cn';
moment.locale('zh-cn');
// 从 https://github.com/moment/moment-timezone/blob/develop/data/packed/latest.json 复制
moment.tz.add('Asia/Shanghai|CST CDT|-80 -90|01010101010101010|-1c1I0 LX0 16p0 1jz0 1Myp0 Rb0 1o10 11z0 1o10 11z0 1qN0 11z0 1o10 11z0 1o10 11z0|23e6');
moment.tz.setDefault('Asia/Shanghai')
<DatePicker defaultValue={moment('2015-01-01', 'YYYY-MM-DD')} />
2015-05-29 22:25:04 +08:00
```
2015-07-08 14:55:05 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|--------------|----------------|----------|--------------|
| value | 日期 | [moment](http://momentjs.com/) | 无 |
| defaultValue | 默认日期 | [moment](http://momentjs.com/) | 无 |
| format | 展示的日期格式,配置参考 [moment.js](http://momentjs.com/) | string | "YYYY-MM-DD" |
2015-07-08 14:55:05 +08:00
| disabledDate | 不可选择的日期 | function | 无 |
| onChange | 时间发生变化的回调 | function(date: moment, dateString: string) | 无 |
2015-07-08 14:55:05 +08:00
| disabled | 禁用 | bool | false |
2015-11-20 21:05:46 +08:00
| style | 自定义输入框样式 | object | {} |
| popupStyle | 格外的弹出日历样式 | object | {} |
2015-08-31 16:45:03 +08:00
| size | 输入框大小,`large` 高度为 32px`small` 为 22px默认是 28px | string | 无 |
2015-10-23 23:50:26 +08:00
| locale | 国际化配置 | object | [默认配置](https://github.com/ant-design/ant-design/issues/424) |
| open | 控制弹层是否展开 | bool | - |
| toggleOpen | 弹出日历和关闭日历的回调 | function(open) | 无 |
| getCalendarContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 |
| showTime | 增加时间选择功能 | Object or Boolean | [TimePicker Options](http://ant.design/components/time-picker/#api) |
2015-06-02 17:06:50 +08:00
2016-04-13 09:25:29 +08:00
### MonthPicker
| 参数 | 说明 | 类型 | 默认值 |
|--------------|----------------|----------|--------------|
| value | 日期 | moment | 无 |
| defaultValue | 默认日期 | moment | 无 |
| format | 展示的日期格式,配置参考 [moment.js](http://momentjs.com/) | string | "YYYY-MM" |
2016-05-19 11:19:09 +08:00
| disabledDate | 不可选择的日期 | function | 无 |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date: moment, dateString: string) | 无 |
2016-04-13 09:25:29 +08:00
| disabled | 禁用 | bool | false |
| style | 自定义输入框样式 | object | {} |
| popupStyle | 格外的弹出日历样式 | object | {} |
| size | 输入框大小,`large` 高度为 32px`small` 为 22px默认是 28px | string | 无 |
| locale | 国际化配置 | object | [默认配置](https://github.com/ant-design/ant-design/issues/424) |
| getCalendarContainer | 定义浮层的容器,默认为 body 上新建 div | function(trigger) | 无 |
2015-12-11 11:11:24 +08:00
### RangePicker
| 参数 | 说明 | 类型 | 默认值 |
|--------------|----------------|----------|--------------|
| value | 日期 | [moment, moment] | 无 |
| defaultValue | 默认日期 | [moment, moment] | 无 |
| format | 展示的日期格式 | string | "YYYY-MM-DD HH:mm:ss" |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(dates: [moment, moment], dateStrings: [string, string]) | 无 |
| showTime | 增加时间选择功能 | Object or Boolean | [TimePicker Options](http://ant.design/components/time-picker/#api) |
2015-12-11 11:11:24 +08:00
`disabled` `style` `popupStyle` `size` `locale` `showTime` `onOk` `getCalendarContainer` 属性与 DatePicker 的一致。
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>