X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=0370e4067f3c2425caedf8c651802e85bdccad7b;hb=HEAD;hp=1c16244a75f49c864ac72af06404e5ab94d1c599;hpb=9f9f39e4fb8073f6f31d545c746e4c3b7ad651da;p=github%2Ffretlink%2Ftime-picker.git
diff --git a/README.md b/README.md
index 1c16244..0370e40 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,31 @@
React TimePicker
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+[![gemnasium deps][gemnasium-image]][gemnasium-url]
+[![node version][node-image]][node-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: http://img.shields.io/npm/v/rc-time-picker.svg?style=flat-square
+[npm-url]: http://npmjs.org/package/rc-time-picker
+[travis-image]: https://img.shields.io/travis/react-component/time-picker.svg?style=flat-square
+[travis-url]: https://travis-ci.org/react-component/time-picker
+[coveralls-image]: https://img.shields.io/coveralls/react-component/time-picker.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/r/react-component/time-picker?branch=master
+[gemnasium-image]: http://img.shields.io/gemnasium/react-component/time-picker.svg?style=flat-square
+[gemnasium-url]: https://gemnasium.com/react-component/time-picker
+[node-image]: https://img.shields.io/badge/node.js-%3E=_4.0.0-green.svg?style=flat-square
+[node-url]: http://nodejs.org/download/
+[download-image]: https://img.shields.io/npm/dm/rc-time-picker.svg?style=flat-square
+[download-url]: https://npmjs.org/package/rc-time-picker
+
+example
+--------
+
+http://react-component.github.io/time-picker/
+
install
-------
@@ -14,7 +39,6 @@ Usage
```
import TimePicker from 'rc-time-picker';
-import React from 'react';
import ReactDOM from 'react-dom';
ReactDOM.render(, container);
```
@@ -24,25 +48,57 @@ 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 |
-| placeholder | String | '' | time input's placeholder |
-| formatter | GregorianCalendarFormatter | HH:mm:ss or HH:mm or mm:ss | |
-| hourOptions | Array | hour options | |
-| minuteOptions | Array | minute options | |
-| secondOptions | Array | second options | |
-| onChange | Function | null | called when select a different value |
-| onOpen | Function | null | called when open picker |
-| onClose | Function | null | called when close picker |
-| inputClassName | String | '' | |
-| 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
+
+```
+npm test
+npm run chrome-test
+```
+
+## Coverage
+
+```
+npm run coverage
+```
+
+open coverage/ dir
License
-------