From 78637ac02ce6a469d2021736d3cb12e98c5edbe7 Mon Sep 17 00:00:00 2001 From: MG12 Date: Mon, 16 Nov 2015 14:44:26 +0800 Subject: remove toggle feature because rc-trigger included; update example and document --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 40cb7c4..998fe4e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,56 @@ -# timepicker -Timepicker +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(, 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 | hour options | | +| minuteOptions | Array | minute options | | +| secondOptions | Array | 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. -- cgit v1.2.3