X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=1c44e76c63df8dddb380b15aecebf5862be07f86;hb=1630cc0d1942d079a80705cd000a48df9a58b355;hp=998fe4e2de84bae38832c0f639affb0b7ac2dba6;hpb=78637ac02ce6a469d2021736d3cb12e98c5edbe7;p=github%2Ffretlink%2Ftime-picker.git diff --git a/README.md b/README.md index 998fe4e..1c44e76 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,32 @@ -TimePicker -========== +# TimePicker 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 ------- @@ -15,7 +39,6 @@ Usage ``` import TimePicker from 'rc-time-picker'; -import React from 'react'; import ReactDOM from 'react-dom'; ReactDOM.render(, container); ``` @@ -23,32 +46,50 @@ ReactDOM.render(, container); API --- -### TimePanel +### TimePicker -| Name | Type | Default | Description | -|---------------|----------------------------|-----------------------------------------------|-----------------------------------------------| -| prefixCls | String | | prefixCls of this component | -| locale | Object | import from 'rc-time-picker/lib/locale/en_US' | | -| defaultValue | GregorianCalendar | null | defaultValue like input's defaultValue | -| 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 input or select a different value | +| 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 | +| 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 | -### TimePicker +## Test Case + +``` +npm test +npm run chrome-test +``` + +## Coverage + +``` +npm run coverage +``` -| Name | Type | Default | Description | -|-----------|-------------------------|---------|-----------------------------------------------| -| prefixCls | String | | prefixCls of this component | -| panel | TimePanel React Element | | | -| disabled | Boolean | false | whether picker is disabled | -| open | Boolean | false | current open state of picker. controlled prop | -| value | GregorianCalendar | null | current value like input's value | -| onChange | Function | null | called when select a different value | -| onOpen | Function | null | called when open picker | -| onClose | Function | null | called when close picker | +open coverage/ dir License -------