]> git.immae.eu Git - github/fretlink/time-picker.git/blobdiff - README.md
add new options about disabled time
[github/fretlink/time-picker.git] / README.md
index 60e5ab035cfb610e8dd581304700b3e5fa3439a1..98f913a14540dd0ed5c24a14ec96972ad7082eed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,7 +39,6 @@ Usage
 
 ```
 import TimePicker from 'rc-time-picker';
-import React from 'react';
 import ReactDOM from 'react-dom';
 ReactDOM.render(<TimePicker />, container);
 ```
@@ -49,25 +48,26 @@ API
 
 ### TimePicker
 
-| Name           | Type                       | Default                                       | Description                                                                                |
-|----------------|----------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------|
-| prefixCls      | String                     |                                               | prefixCls of this component                                                                |
-| locale         | Object                     | import from 'rc-time-picker/lib/locale/en_US' |                                                                                            |
-| disabled       | Boolean                    | false                                         | whether picker is disabled                                                                 |
-| open           | Boolean                    | false                                         | current open state of picker. controlled prop                                              |
-| defaultValue   | GregorianCalendar          | null                                          | default initial value                                                                      |
-| value          | GregorianCalendar                 | null                                          | current value                                                                              |
-| gregorianCalendarLocale   | GregorianCalendar  locale object               | null                                          | if value and defaultValue not set, you should set this to your locale                                                                            |
-| placeholder    | String                     | ''                                            | time input's placeholder                                                                   |
-| showHour       | Boolean                    | whether show hour                             |                                                                                            |
-| showSecond     | Boolean                    | whether show second                           |                                                                                            |
-| formatter      | String|GregorianCalendarFormatter |                                        |                                                                                            |
-| hourOptions    | Array<Number>              | hour options                                  |                                                                                            |
-| minuteOptions  | Array<Number>              | minute options                                |                                                                                            |
-| secondOptions  | Array<Number>              | second options                                |                                                                                            |
-| onChange       | Function                   | null                                          | called when select a different value                                                       |
-| placement      | String                     | bottomLeft                                    | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
-| transitionName | String                     | ''                                            |                                                                                            |
+| Name                    | Type                              | Default                                       | Description                                                                                |
+|-------------------------|-----------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------|
+| prefixCls               | String                            |                                               | prefixCls of this component                                                                |
+| locale                  | Object                            | import from 'rc-time-picker/lib/locale/en_US' |                                                                                            |
+| disabled                | Boolean                           | false                                         | whether picker is disabled                                                                 |
+| open                    | Boolean                           | false                                         | current open state of picker. controlled prop                                              |
+| defaultValue            | GregorianCalendar                 | null                                          | default initial value                                                                      |
+| value                   | GregorianCalendar                 | null                                          | current value                                                                              |
+| gregorianCalendarLocale | GregorianCalendar  locale object  | null                                          | if value and defaultValue not set, you should set this to your locale                      |
+| placeholder             | String                            | ''                                            | time input's placeholder                                                                   |
+| showHour                | Boolean                           | whether show hour                             |                                                                                            |
+| showSecond              | Boolean                           | whether show second                           |                                                                                            |
+| formatter               | String|GregorianCalendarFormatter |                                               |                                                                                            |
+| disabledHours           | Array<Number>                     | disabled hour options                         |                                                                                            |
+| disabledMinutes         | Array<Number>                     | disabled minute options                       |                                                                                            |
+| disabledSeconds         | Array<Number>                     | disabled second options                       |                                                                                            |
+| hideDisabledOptions     | Boolean                           | whether hide disabled options                 |                                                                                            |
+| onChange                | Function                          | null                                          | called when select a different value                                                       |
+| placement               | String                            | bottomLeft                                    | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
+| transitionName          | String                            | ''                                            |                                                                                            |
 
 License
 -------