Readme file was updated to reflect show12Hours option

[github/fretlink/time-picker.git] / README.md

diff --git a/README.md b/README.md
index ea0e0346a40263964922c2fa241545de75831c0c..b9d06fda604552a47a619592da0bce85a3c2eba4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -51,23 +51,45 @@ API
 | Name                    | Type                              | Default                                       | Description                                                                                |
 |-------------------------|-----------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------|
 | prefixCls               | String                            |                                               | prefixCls of this component                                                                |
-| locale                  | Object                            | import from 'rc-time-picker/lib/locale/en_US' |                                                                                            |
+| clearText               | String                            | 'clear'                                       |                                                                                            |
 | disabled                | Boolean                           | false                                         | whether picker is disabled                                                                 |
+| clearText               | String                            | clear                                         | clear text                                                                                 |
 | 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                      |
+| 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                                                                   |
 | showHour                | Boolean                           | whether show hour                             |                                                                                            |
+| showMinute                | Boolean                         | whether show minute                             |                                                                                            |
 | showSecond              | Boolean                           | whether show second                           |                                                                                            |
-| formatter               | String|GregorianCalendarFormatter |                                               |                                                                                            |
+| format                  | String                            |                                               |                                                                                            |
 | disabledHours           | Function                          | disabled hour options                         |                                                                                            |
 | disabledMinutes         | Function                          | disabled minute options                       |                                                                                            |
 | disabledSeconds         | Function                          | disabled second options                       |                                                                                            |
+| show12Hours             | Boolean                           | 12 hours display mode                         |                                                                                            |
 | hideDisabledOptions     | Boolean                           | whether hide disabled options                 |                                                                                            |
 | onChange                | Function                          | null                                          | called when select a different value                                                       |
+| addon                   | Function                          | nothing                                       | 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
 -------