mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 19:50:05 +08:00
75 lines
4.3 KiB
Markdown
75 lines
4.3 KiB
Markdown
|
---
|
||
|
|
category: Components
|
||
|
|
type: Form Control
|
||
|
|
english: DatePicker
|
||
|
|
---
|
||
|
|
|
||
|
|
To select/input a date.
|
||
|
|
|
||
|
|
## When To Use
|
||
|
|
|
||
|
|
By clicking the input box, you can select a date from a popup calendar.
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### DatePicker
|
||
|
|
|
||
|
|
```html
|
||
|
|
<DatePicker defaultValue="2015-01-01" />
|
||
|
|
```
|
||
|
|
|
||
|
|
> Warning: `Datepicker` is renamed to `DatePicker` after `0.11`.
|
||
|
|
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
|--------------|----------------|----------|--------------|
|
||
|
|
| value | to set date | String/Date | - |
|
||
|
|
| defaultValue | to set default date | String/Date | - |
|
||
|
|
| format | to set the date format, refer to [GregorianCalendarFormat](https://github.com/yiminghe/gregorian-calendar-format) | String | "yyyy-MM-dd" |
|
||
|
|
| disabledDate | to specify the date that cannot be selected | function | - |
|
||
|
|
| onChange | a callback function, can be executed when the selected time is changing | function(date, dateString) | - |
|
||
|
|
| disabled | determine whether the DatePicker is disabled | Boolean | false |
|
||
|
|
| style | to customize the style of the input box | Object | {} |
|
||
|
|
| popupStyle | to customize the style of the popup calendar | Object | {} |
|
||
|
|
| size | determine the size of the input box, the height of `large` and `small`, are 32px and 22px respectively, while default size is 28px | String | - |
|
||
|
|
| locale | localization configuration | Object | [default](https://github.com/ant-design/ant-design/issues/424) |
|
||
|
|
| onOk | a callback function, can be executed when OK-button is clicked | function(Date value) | - |
|
||
|
|
| toggleOpen | a callback function, can be executed whether the popup calendar is popped up or closed | function(status) | - |
|
||
|
|
| getCalendarContainer | to set the container of the floating layer, while the default is to create a `div` element in `body` | function(trigger) | - |
|
||
|
|
| showTime | to provide an additional time selection | Object/Boolean | [TimePicker Options](http://ant.design/components/time-picker/#api) |
|
||
|
|
|
||
|
|
### MonthPicker
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
|--------------|----------------|----------|--------------|
|
||
|
|
| value | to set date | String/Date | - |
|
||
|
|
| defaultValue | to set default date | String/Date | - |
|
||
|
|
| format | to set the date format, refer to [GregorianCalendarFormat](https://github.com/yiminghe/gregorian-calendar-format) | String | "yyyy-MM" |
|
||
|
|
| disabledDate | to specify the date that cannot be selected | function | - |
|
||
|
|
| onChange | a callback function, can be executed when the selected time is changing | function(Date value) | - |
|
||
|
|
| disabled | determine whether the MonthPicker is disabled | Boolean | false |
|
||
|
|
| style | to customize the style of the input box | Object | {} |
|
||
|
|
| popupStyle | to customize the style of the popup calendar | Object | {} |
|
||
|
|
| size | determine the size of the input box, the height of `large` and `small`, are 32px and 22px respectively, while default size is 28px | String | - |
|
||
|
|
| locale | localization configuration | Object | [default](https://github.com/ant-design/ant-design/issues/424) |
|
||
|
|
| getCalendarContainer | to set the container of the floating layer, while the default is to create a `div` element in `body` | function(trigger) | - |
|
||
|
|
|
||
|
|
### RangePicker
|
||
|
|
|
||
|
|
| Property | Description | Type | Default |
|
||
|
|
|--------------|----------------|----------|--------------|
|
||
|
|
| value | to set date | [String/Date, String/Date] | - |
|
||
|
|
| defaultValue | to set default date | [String/Date, String/Date] | - |
|
||
|
|
| format | to set the date format | String | "yyyy-MM-dd HH:mm:ss" |
|
||
|
|
| onChange | a callback function, can be executed when the selected time is changing | function(date[], dateString[]) | - |
|
||
|
|
| showTime | to provide an additional time selection | Object/Boolean | [TimePicker Options](http://ant.design/components/time-picker/#api) |
|
||
|
|
|
||
|
|
The following properties are the same with `DatePicker`: `disabled` `style` `popupStyle` `size` `locale` `showTime` `onOk` `getCalendarContainer`
|
||
|
|
|
||
|
|
|
||
|
|
<style>
|
||
|
|
.code-box-demo .ant-calendar-picker {
|
||
|
|
margin: 0 8px 12px 0;
|
||
|
|
}
|
||
|
|
</style>
|