From afbf52582818db430952f10741fbdb9e321d636e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=88=98=E5=8A=9B=E7=91=9E?= Date: Fri, 15 Dec 2017 16:07:53 +0800 Subject: [PATCH] Create README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e47c111 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# react-native-picker-actionsheet [![Monthly download](https://img.shields.io/npm/dm/react-native-picker-actionsheet.svg)](https://img.shields.io/npm/dm/react-native-picker-actionsheet.svg) [![Total downloads](https://img.shields.io/npm/dt/react-native-picker-actionsheet.svg)](https://img.shields.io/npm/dt/react-native-picker-actionsheet.svg) + +## Install + +```bash +npm install react-native-picker-actionsheet --save +``` + +## Usage + +```javascript +import AlertInput from 'react-native-picker-actionsheet'; + + +``` + +## Example + +![ios](https://raw.githubusercontent.com/BooYeu/react-native-picker-actionsheet/master/images/ios.jpg) +![android](https://raw.githubusercontent.com/BooYeu/react-native-picker-actionsheet/master/images/android.jpg) + +## Properties + +| Prop | Default | Required | Description | +| :------------ |:---------------:| :---------------:| :-----| +| show | false | yes | Controller whether or not show it | +| height | 120 | yes | The height of the container,you have to change it for your requirement | +| title | '' | no | The title text of the container | +| data | [] | no | The data you give users to picker | +| renderItem | ({item,index})=>{} | no | Function that shows data | +| onCancel | ()=>{} | no | Function that is called when user cancels it | +| onSubmit | (text)=>{} | no | Function that is called when user submits it | +| cancelText | 'cancel' | no | The string that is displayed on the cancel button | +| submitText | 'submit' | no | The string that is displayed on the submit button |