X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=a2758b9faec55ea530b2692da26b0a9ae0e38201;hb=b6767d8a08ccfc52836e09e3a0886a5cf225b93f;hp=60e5ab035cfb610e8dd581304700b3e5fa3439a1;hpb=e9060dda0dd04e99666ff29efe459ebc7d7c65a7;p=github%2Ffretlink%2Ftime-picker.git
diff --git a/README.md b/README.md
index 60e5ab0..a2758b9 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,6 @@ Usage
```
import TimePicker from 'rc-time-picker';
-import React from 'react';
import ReactDOM from 'react-dom';
ReactDOM.render(, container);
```
@@ -49,25 +48,50 @@ API
### TimePicker
-| Name | Type | Default | Description |
-|----------------|----------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------|
-| prefixCls | String | | prefixCls of this component |
-| locale | Object | import from 'rc-time-picker/lib/locale/en_US' | |
-| disabled | Boolean | false | whether picker is disabled |
-| open | Boolean | false | current open state of picker. controlled prop |
-| defaultValue | GregorianCalendar | null | default initial value |
-| value | GregorianCalendar | null | current value |
-| gregorianCalendarLocale | GregorianCalendar locale object | null | if value and defaultValue not set, you should set this to your locale |
-| placeholder | String | '' | time input's placeholder |
-| showHour | Boolean | whether show hour | |
-| showSecond | Boolean | whether show second | |
-| formatter | String|GregorianCalendarFormatter | | |
-| hourOptions | Array | hour options | |
-| minuteOptions | Array | minute options | |
-| secondOptions | Array | second options | |
-| onChange | Function | null | called when select a different value |
-| placement | String | bottomLeft | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
-| transitionName | String | '' | |
+| Name | Type | Default | Description |
+|-------------------------|-----------------------------------|---------|-------------|
+| prefixCls | String | 'rc-time-picker' | prefixCls of this component |
+| clearText | String | 'clear' | clear tooltip of icon |
+| disabled | Boolean | false | whether picker is disabled |
+| allowEmpty | Boolean | true | allow clearing text |
+| open | Boolean | false | current open state of picker. controlled prop |
+| defaultValue | moment | null | default initial value |
+| defaultOpenValue | moment | moment() | default open panel value, used to set utcOffset,locale if value/defaultValue absent |
+| value | moment | null | current value |
+| placeholder | String | '' | time input's placeholder |
+| className | String | '' | time picker className |
+| popupClassName | String | '' | time panel className |
+| showHour | Boolean | true | whether show hour | |
+| showMinute | Boolean | true | whether show minute |
+| showSecond | Boolean | true | whether show second |
+| format | String | - | moment format |
+| disabledHours | Function | - | disabled hour options |
+| disabledMinutes | Function | - | disabled minute options |
+| disabledSeconds | Function | - | disabled second options |
+| use12Hours | Boolean | false | 12 hours display mode |
+| hideDisabledOptions | Boolean | false | whether hide disabled options |
+| onChange | Function | null | called when select a different value |
+| addon | Function | - | called from timepicker panel to render some addon to its bottom, like an OK button. Receives panel instance as parameter, to be able to close it like `panel.close()`.|
+| placement | String | bottomLeft | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
+| transitionName | String | '' | |
+| name | String | - | sets the name of the generated input |
+| onOpen | Function({ open }) | | when TimePicker panel is opened |
+| onClose | Function({ open }) | | when TimePicker panel is opened |
+
+## Test Case
+
+```
+npm test
+npm run chrome-test
+```
+
+## Coverage
+
+```
+npm run coverage
+```
+
+open coverage/ dir
License
-------