aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 998fe4e2de84bae38832c0f639affb0b7ac2dba6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
TimePicker
==========

React TimePicker

install
-------

```
npm install rc-time-picker
```

Usage
-----

```
import TimePicker from 'rc-time-picker';
import React from 'react';
import ReactDOM from 'react-dom';
ReactDOM.render(<TimePicker />, container);
```

API
---

### TimePanel

| 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<String>              | hour options                                  |                                               |
| minuteOptions | Array<String>              | minute options                                |                                               |
| secondOptions | Array<String>              | second options                                |                                               |
| onChange      | Function                   | null                                          | called when input or select a different value |

### TimePicker

| 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                      |

License
-------

rc-time-picker is released under the MIT license.