From eeb6ab5a01c22830fe5aa7cc823a04cae2b0e295 Mon Sep 17 00:00:00 2001 From: Benjy Cui Date: Fri, 28 Oct 2016 10:32:09 +0800 Subject: [PATCH] docs: update docs for DatePicker and so on --- components/date-picker/index.en-US.md | 44 +++++++++++++------------- components/date-picker/index.zh-CN.md | 45 ++++++++++++++------------- 2 files changed, 44 insertions(+), 45 deletions(-) diff --git a/components/date-picker/index.en-US.md b/components/date-picker/index.en-US.md index 4b06dad414..e0338dac2b 100644 --- a/components/date-picker/index.en-US.md +++ b/components/date-picker/index.en-US.md @@ -12,7 +12,7 @@ By clicking the input box, you can select a date from a popup calendar. ## API -### DatePicker +Note: Part of locale of DatePicker, MonthPicker, RangePicker is read from value. So, please set the locale of moment correctly. ```jsx import moment from 'moment-timezone/moment-timezone'; @@ -27,22 +27,31 @@ moment.tz.setDefault('Asia/Shanghai') ``` -| Property | Description | Type | Default | +### Common API + +The following APIs are shared by DatePicker, MonthPicker, RangePicker. + +| Property | Description | Type | Default | |--------------|----------------|----------|--------------| -| value | to set date | [moment](http://momentjs.com/) | - | -| defaultValue | to set default date | [moment](http://momentjs.com/) | - | -| format | to set the date format, refer to [moment.js](http://momentjs.com/) | 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: moment, dateString: string) | - | +| allowClear | Whether to show clear button | bool | true | | 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) | - | +| disabledDate | to specify the date that cannot be selected | function | - | +| getCalendarContainer | to set the container of the floating layer, while the default is to create a `div` element in `body` | function(trigger) | - | + +### DatePicker + +| Property | Description | Type | Default | +|--------------|----------------|----------|--------------| +| value | to set date | [moment](http://momentjs.com/) | - | +| defaultValue | to set default date | [moment](http://momentjs.com/) | - | +| format | to set the date format, refer to [moment.js](http://momentjs.com/) | String | "YYYY-MM-DD" | +| onChange | a callback function, can be executed when the selected time is changing | function(date: moment, dateString: string) | - | | open | open state of picker | bool | - | | onOpenChange | 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](/components/time-picker/#api) | ### MonthPicker @@ -52,29 +61,18 @@ moment.tz.setDefault('Asia/Shanghai') | value | to set date | [moment](http://momentjs.com/) | - | | defaultValue | to set default date | [moment](http://momentjs.com/) | - | | format | to set the date format, refer to [moment.js](http://momentjs.com/) | 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: moment, dateString: string) | - | -| 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 | [moment, moment] | - | -| defaultValue | to set default date | [moment, moment] | - | +| value | to set date | [[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | +| defaultValue | to set default date | [[moment](http://momentjs.com/), [moment](http://momentjs.com/)] | - | | 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(dates: [moment, moment], dateStrings: [string, string]) | - | | showTime | to provide an additional time selection | Object/Boolean | [TimePicker Options](/components/time-picker/#api) | -| disabledDate | to specify the date that cannot be selected | function(date: moment, dateString: string) | - | -| disabledTime | to specify the time that cannot be selected | function(dates: [moment, moment], partial: 'start'|'end') | - | - -The following properties are the same with `DatePicker`: `disabled` `style` `popupStyle` `size` `locale` `showTime` `onOk` `getCalendarContainer` - +| disabledTime | to specify the time that cannot be selected | function(dates: [moment, moment], partial: `'start'|'end'`) | - |