README.md

   1 # TimePicker
   2
   3 React TimePicker
   4
   5 [![NPM version][npm-image]][npm-url]
   6 [![build status][travis-image]][travis-url]
   7 [![Test coverage][coveralls-image]][coveralls-url]
   8 [![gemnasium deps][gemnasium-image]][gemnasium-url]
   9 [![node version][node-image]][node-url]
  10 [![npm download][download-image]][download-url]
  11
  12 [npm-image]: http://img.shields.io/npm/v/rc-time-picker.svg?style=flat-square
  13 [npm-url]: http://npmjs.org/package/rc-time-picker
  14 [travis-image]: https://img.shields.io/travis/react-component/time-picker.svg?style=flat-square
  15 [travis-url]: https://travis-ci.org/react-component/time-picker
  16 [coveralls-image]: https://img.shields.io/coveralls/react-component/time-picker.svg?style=flat-square
  17 [coveralls-url]: https://coveralls.io/r/react-component/time-picker?branch=master
  18 [gemnasium-image]: http://img.shields.io/gemnasium/react-component/time-picker.svg?style=flat-square
  19 [gemnasium-url]: https://gemnasium.com/react-component/time-picker
  20 [node-image]: https://img.shields.io/badge/node.js-%3E=_4.0.0-green.svg?style=flat-square
  21 [node-url]: http://nodejs.org/download/
  22 [download-image]: https://img.shields.io/npm/dm/rc-time-picker.svg?style=flat-square
  23 [download-url]: https://npmjs.org/package/rc-time-picker
  24
  25 example
  26 --------
  27
  28 http://react-component.github.io/time-picker/
  29
  30 install
  31 -------
  32
  33 ```
  34 npm install rc-time-picker
  35 ```
  36
  37 Usage
  38 -----
  39
  40 ```
  41 import TimePicker from 'rc-time-picker';
  42 import ReactDOM from 'react-dom';
  43 ReactDOM.render(<TimePicker />, container);
  44 ```
  45
  46 API
  47 ---
  48
  49 ### TimePicker
  50
  51 | Name                    | Type                              | Default                                       | Description                                                                                |
  52 |-------------------------|-----------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------|
  53 | prefixCls               | String                            |                                               | prefixCls of this component                                                                |
  54 | locale                  | Object                            | import from 'rc-time-picker/lib/locale/en_US' |                                                                                            |
  55 | disabled                | Boolean                           | false                                         | whether picker is disabled                                                                 |
  56 | open                    | Boolean                           | false                                         | current open state of picker. controlled prop                                              |
  57 | defaultValue            | GregorianCalendar                 | null                                          | default initial value                                                                      |
  58 | value                   | GregorianCalendar                 | null                                          | current value                                                                              |
  59 | gregorianCalendarLocale | GregorianCalendar  locale object  | null                                          | if value and defaultValue not set, you should set this to your locale                      |
  60 | placeholder             | String                            | ''                                            | time input's placeholder                                                                   |
  61 | showHour                | Boolean                           | whether show hour                             |                                                                                            |
  62 | showSecond              | Boolean                           | whether show second                           |                                                                                            |
  63 | formatter               | String|GregorianCalendarFormatter |                                               |                                                                                            |
  64 | disabledHours           | Array<Number>                     | disabled hour options                         |                                                                                            |
  65 | disabledMinutes         | Array<Number>                     | disabled minute options                       |                                                                                            |
  66 | disabledSeconds         | Array<Number>                     | disabled second options                       |                                                                                            |
  67 | hideDisabledOptions     | Boolean                           | whether hide disabled options                 |                                                                                            |
  68 | onChange                | Function                          | null                                          | called when select a different value                                                       |
  69 | placement               | String                            | bottomLeft                                    | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
  70 | transitionName          | String                            | ''                                            |                                                                                            |
  71
  72 License
  73 -------
  74
  75 rc-time-picker is released under the MIT license.