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

73 lines
3.6 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
chinese: 日期选择框
type: 表单
english: DatePicker
---
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
2015-06-08 13:01:43 +08:00
```html
<DatePicker defaultValue="2015-01-01" />
2015-05-29 22:25:04 +08:00
```
2015-12-23 19:09:31 +08:00
> 注意:`0.11+` 后 `Datepicker` 改名为 `DatePicker`。
2015-07-08 14:55:05 +08:00
| 参数 | 说明 | 类型 | 默认值 |
|--------------|----------------|----------|--------------|
2016-01-26 00:28:50 +08:00
| value | 日期 | string or Date | 无 |
| defaultValue | 默认日期 | string or Date | 无 |
| format | 展示的日期格式,配置参考 [GregorianCalendarFormat](https://github.com/yiminghe/gregorian-calendar-format) | string | "yyyy-MM-dd" |
2015-07-08 14:55:05 +08:00
| disabledDate | 不可选择的日期 | function | 无 |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date, dateString) | 无 |
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) |
2016-02-02 17:49:44 +08:00
| onOk | 点击确定按钮的回调 | function(Date value) | 无 |
| 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 | 日期 | string or Date | 无 |
| defaultValue | 默认日期 | string or Date | 无 |
| format | 展示的日期格式,配置参考 [GregorianCalendarFormat](https://github.com/yiminghe/gregorian-calendar-format) | string | "yyyy-MM" |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(Date value) | 无 |
| 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 | 日期 | [string/Date, string/Date] | 无 |
| defaultValue | 默认日期 | [string/Date, string/Date] | 无 |
2015-12-11 11:11:24 +08:00
| format | 展示的日期格式 | string | "yyyy-MM-dd HH:mm:ss" |
| onChange | 时间发生变化的回调,发生在用户选择时间时 | function(date[], dateString[]) | 无 |
| 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>