https://github.com/react-component/time-picker
React TimePicker
https://github.com/react-component/time-picker
Last synced: 8 months ago
JSON representation
React TimePicker
- Host: GitHub
- URL: https://github.com/react-component/time-picker
- Owner: react-component
- License: mit
- Created: 2015-10-21T09:43:25.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T07:47:29.000Z (over 1 year ago)
- Last Synced: 2025-05-09T11:50:47.988Z (8 months ago)
- Language: JavaScript
- Homepage: http://react-component.github.io/time-picker/
- Size: 5.86 MB
- Stars: 478
- Watchers: 9
- Forks: 201
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TimePicker
React Time Picker Control.
[![NPM version][npm-image]][npm-url]
[![build status][circleci-image]][circleci-url]
[![Test coverage][coveralls-image]][coveralls-url]
[](https://david-dm.org/react-component/time-picker)
[](https://david-dm.org/react-component/time-picker?type=dev)
[![npm download][download-image]][download-url]
[](https://github.com/react-component/time-picker)
[Storybook]: https://github.com/storybooks/press/blob/master/badges/storybook.svg
[npm-image]: http://img.shields.io/npm/v/rc-time-picker.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-time-picker
[circleci-image]: https://img.shields.io/circleci/react-component/time-picker.svg?style=flat-square
[circleci-url]: https://circleci.com/gh/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=maste
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-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
-------
```
npm install rc-time-picker
```
Usage
-----
```
import TimePicker from 'rc-time-picker';
import ReactDOM from 'react-dom';
import 'rc-time-picker/assets/index.css';
ReactDOM.render(, container);
```
API
---
### TimePicker
| 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 |
| inputClassName | String | '' | time picker input element className |
| id | String | '' | time picker id |
| popupClassName | String | '' | time panel className |
| popupStyle | object | {} | customize popup style
| 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 time-picker a different value |
| onAmPmChange | Function | null | called when time-picker an am/pm 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 ['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 closed |
| 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 |
| inputReadOnly | Boolean | false | set input to read only |
| inputIcon | ReactNode | | specific the time-picker icon. |
| clearIcon | ReactNode | | specific the clear icon. |
## Test Case
```
npm test
```
## Coverage
```
npm run coverage
```
open coverage/ dir
License
-------
rc-time-picker is released under the MIT license.