aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 56 insertions, 2 deletions
diff --git a/README.md b/README.md
index 40cb7c4..998fe4e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
1# timepicker 1TimePicker
2Timepicker 2==========
3
4React TimePicker
5
6install
7-------
8
9```
10npm install rc-time-picker
11```
12
13Usage
14-----
15
16```
17import TimePicker from 'rc-time-picker';
18import React from 'react';
19import ReactDOM from 'react-dom';
20ReactDOM.render(<TimePicker />, container);
21```
22
23API
24---
25
26### TimePanel
27
28| Name | Type | Default | Description |
29|---------------|----------------------------|-----------------------------------------------|-----------------------------------------------|
30| prefixCls | String | | prefixCls of this component |
31| locale | Object | import from 'rc-time-picker/lib/locale/en_US' | |
32| defaultValue | GregorianCalendar | null | defaultValue like input's defaultValue |
33| placeholder | String | '' | time input's placeholder |
34| formatter | GregorianCalendarFormatter | HH:mm:ss or HH:mm or mm:ss | |
35| hourOptions | Array<String> | hour options | |
36| minuteOptions | Array<String> | minute options | |
37| secondOptions | Array<String> | second options | |
38| onChange | Function | null | called when input or select a different value |
39
40### TimePicker
41
42| Name | Type | Default | Description |
43|-----------|-------------------------|---------|-----------------------------------------------|
44| prefixCls | String | | prefixCls of this component |
45| panel | TimePanel React Element | | |
46| disabled | Boolean | false | whether picker is disabled |
47| open | Boolean | false | current open state of picker. controlled prop |
48| value | GregorianCalendar | null | current value like input's value |
49| onChange | Function | null | called when select a different value |
50| onOpen | Function | null | called when open picker |
51| onClose | Function | null | called when close picker |
52
53License
54-------
55
56rc-time-picker is released under the MIT license.