X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0370e4067f3c2425caedf8c651802e85bdccad7b;hb=HEAD;hp=d8a35b9c3a004440b4dbbe3c9192e51efad6e67b;hpb=4e020febdf6201ab5f10a0e49be81c6ff32daaeb;p=github%2Ffretlink%2Ftime-picker.git diff --git a/README.md b/README.md index d8a35b9..0370e40 100644 --- a/README.md +++ b/README.md @@ -48,33 +48,42 @@ API ### TimePicker -| Name | Type | Default | Description | -|-------------------------|-----------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------| -| prefixCls | String | | prefixCls of this component | -| 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 | 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 | | -| format | String | | | -| disabledHours | Function | disabled hour options | | -| disabledMinutes | Function | disabled minute options | | -| disabledSeconds | Function | disabled second options | | -| use12Hours | 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 | 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 | +| 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 | +| 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 | +| 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 esc should close the picker | +| inputReadOnly | Boolean | false | set input to read only | ## Test Case