README.md 2.4 KB
Newer Older
xwenliang's avatar
init  
xwenliang committed
1 2
# react-native-picker

3 4 5
![version](https://img.shields.io/npm/v/react-native-picker.svg?style=flat-square)
![dep](https://david-dm.org/beefe/react-native-picker.svg?style=flat-square)

xwenliang's avatar
init  
xwenliang committed
6 7
A Picker written in pure javascript for cross-platform support.

xwenliang's avatar
bugs  
xwenliang committed
8
It was most likely an example of how to build a cross-platform Picker Component use [react-native-picker-android](https://github.com/beefe/react-native-picker-android).
xwenliang's avatar
init  
xwenliang committed
9 10 11

Needs react-native >= 0.14.2

xwenliang's avatar
xwenliang committed
12 13 14 15 16 17
####Demo

- <b>[Date-picker](./demo/date-picker.js)</b>
- <b>[Area-picker](./demo/area-picker.js)</b>


xwenliang's avatar
xwenliang committed
18 19
![ui](./doc/ui.gif)

xwenliang's avatar
xwenliang committed
20 21
![ui2](./doc/ui2.jpg)

xwenliang's avatar
init  
xwenliang committed
22 23
###Documentation

xwenliang's avatar
bugs  
xwenliang committed
24
####Props
xwenliang's avatar
xwenliang committed
25 26
- <b>pickerBtnText</b> string, tool bar's confirm btn text
- <b>pickerCancelBtnText</b> string, tool bar's cancel ben text
xwenliang's avatar
xwenliang committed
27 28
- <b>pickerBtnStyle</b> textStylePropType, tool bar's btn style
- <b>pickerToolBarStyle</b> viewStylePropType, tool bar's style
xwenliang's avatar
xwenliang committed
29 30 31 32
- <b>pickerHeight</b> number, height of picker
- <b>showDuration</b> number, animation of picker
- <b>pickerTitle</b> string, title of picker
- <b>pickerTitleStyle</b> textStylePropType, style of title
xwenliang's avatar
bugs  
xwenliang committed
33 34 35
- <b>pickerData</b> array
- <b>selectedValue</b> any
- <b>onPickerDone</b> function
xwenliang's avatar
xwenliang committed
36
- <b>onPickerCancel</b> function
xwenliang's avatar
bugs  
xwenliang committed
37

xwenliang's avatar
xwenliang committed
38 39 40
####Methods
- <b>toggle</b> show or hide picker, default to be hiden

xwenliang's avatar
bugs  
xwenliang committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
###Usage

####Step 1 - install

```
	npm install react-native-picker --save
```

####Step 2 - import and use in project

```javascript
	import Picker from 'react-native-picker'
	
	<Picker
		pickerHeight={300}
		showDuration={300}
		pickerData={}//picker`s value List
		selectedValue={}//default to be selected value
		onPickerDone={}//when confirm your choice
	/>
xwenliang's avatar
xwenliang committed
61 62 63 64 65 66
```

###Notice

####support two modes:

xwenliang's avatar
xwenliang committed
67
<b>1. parallel:</b> such as time picker, wheels have no connection with each other
xwenliang's avatar
xwenliang committed
68

xwenliang's avatar
xwenliang committed
69
<b>2. cascade:</b> such as date picker, address picker .etc, when front wheel changed, the behind wheels will all be reset
xwenliang's avatar
xwenliang committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

####parallel:

- single wheel:

```javascript
	pickerData = [1,2,3,4];
	selectedValue = 3;
```

- two or more wheel:

```javascript
	pickerData = [
		[1,2,3,4],
		[5,6,7,8],
		...
	];
	selectedValue = [1, 5];
```

####cascade:

- two wheel

```javascript
	pickerData = {
		{
			a: [1,2,3,4],
			b: [5,6,7,8],
			...
		}
	};
	selectedValue = ['a', 2];
```

- three wheel

```javascript
	pickerData = {
		a: {
			a1: [1,2,3,4],
			a2: [5,6,7,8],
			a3: [9,10,11,12]
		},
		b: {
			b1: [1,2,3,4],
			b2: [5,6,7,8],
			b3: [9,10,12,12]
		}
		...
	};
	selectedValue = ['a', 'a1', 1];
```