]> git.immae.eu Git - github/fretlink/time-picker.git/blobdiff - README.md
Merge pull request #1 from cyrilfretlink/close-on-esc-prop
[github/fretlink/time-picker.git] / README.md
index fa1933a91f60e941151acfcd19c14ec8a5c4d0ec..0370e4067f3c2425caedf8c651802e85bdccad7b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -53,12 +53,15 @@ API
 | prefixCls               | String                            | 'rc-time-picker' | prefixCls of this component |
 | clearText               | String                            | 'clear' | clear tooltip of icon |
 | disabled                | Boolean                           | false   | whether picker is disabled |
-| clearText               | String                            | clear | clear text |
+| 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 |
+| id                      | String                            | '' | time picker id |
+| popupClassName          | String                            | '' | time panel className |
 | showHour                | Boolean                           | true | whether show hour | |
 | showMinute              | Boolean                           | true | whether show minute |
 | showSecond              | Boolean                           | true | whether show second |
@@ -75,6 +78,12 @@ API
 | 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      |
+| hourStep                | Number                            | 1 | interval between hours in picker  |
+| minuteStep              | Number                            | 1 | interval between minutes in picker  |
+| secondStep              | Number                            | 1 | interval between seconds in picker  |
+| focusOnOpen             | Boolean                           | false | automatically focus the input when the picker opens |
+| closeOnEsc              | Boolean                           | true  | whether <kbd>esc</kbd> should close the picker |
+| inputReadOnly             | Boolean                           | false | set input to read only |
 
 ## Test Case