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

xwenliang's avatar
xwenliang committed
3
[![npm version](https://img.shields.io/npm/v/react-native-picker.svg?style=flat-square)](https://www.npmjs.com/package/react-native-picker) <a href="https://david-dm.org/beefe/react-native-picker"><img src="https://david-dm.org/beefe/react-native-picker.svg?style=flat-square" alt="dependency status"></a>  
4

xwenliang's avatar
xwenliang committed
5
A Native Picker with high performance
xwenliang's avatar
init  
xwenliang committed
6

xwenliang's avatar
xwenliang committed
7 8 9 10 11 12
####Demo

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


xwenliang's avatar
xwenliang committed
13 14
![ui](./doc/ui.gif)

xwenliang's avatar
xwenliang committed
15 16
![ui2](./doc/ui2.jpg)

xwenliang's avatar
init  
xwenliang committed
17 18
###Documentation

xwenliang's avatar
bugs  
xwenliang committed
19
####Props
xwenliang's avatar
xwenliang committed
20 21 22 23 24 25 26 27 28 29 30 31 32
- <b>pickerConfirmBtnText</b> string, 确认按钮文字
- <b>pickerCancelBtnText</b> string, 取消按钮文字
- <b>pickerTitleText</b> string, 标题文字
- <b>pickerConfirmBtnColor</b> ['255', '66', '00', 0.5],  确认按钮字体颜色
- <b>pickerCancelBtnColor</b> ['255', '66', '00', 0.5],  取消按钮字体颜色
- <b>pickerTitleColor</b> ['255', '66', '00', 0.5],  标题字体颜色
- <b>pickerToolBarBg</b> ['255', '66', '00', 0.5],  工具栏背景颜色
- <b>pickerBg</b> ['255', '66', '00', 0.5],  picker背景颜色
- <b>pickerData</b> 数组或对象,picker数据
- <b>selectedValue</b> string,默认选中数据
- <b>onPickerConfirm</b> function,确认按钮回调
- <b>onPickerCancel</b> function,取消按钮回调
- <b>onPickerSelect</b> function,滚轮滚动时回调
xwenliang's avatar
bugs  
xwenliang committed
33

xwenliang's avatar
xwenliang committed
34 35
####Methods
- <b>toggle</b> show or hide picker, default to be hiden
xwenliang's avatar
xwenliang committed
36 37 38
- <b>show</b> show picker
- <b>hide</b> hide picker
- <b>isPickerShow</b> get status of picker, return a boolean
xwenliang's avatar
xwenliang committed
39

xwenliang's avatar
bugs  
xwenliang committed
40 41 42 43 44 45 46 47
###Usage

####Step 1 - install

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

xwenliang's avatar
xwenliang committed
48 49 50 51 52 53 54
####Step 2 - link

```
	react-native link
```

####Step 3 - import and use in project
xwenliang's avatar
bugs  
xwenliang committed
55 56

```javascript
xwenliang's avatar
xwenliang committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
	import Picker from 'react-native-picker';

	let data = [];
    for(var i=0;i<100;i++){
        data.push(i);
    }

    Picker.init({
        pickerData: data,
        selectedValue: [59],
        onPickerConfirm: data => {
            console.log(data);
        },
        onPickerCancel: data => {
            console.log(data);
        },
        onPickerSelect: data => {
            console.log(data);
        }
    });
    Picker.show();
xwenliang's avatar
bugs  
xwenliang committed
78
	
xwenliang's avatar
xwenliang committed
79 80 81 82 83 84
```

###Notice

####support two modes:

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

xwenliang's avatar
xwenliang committed
87
<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
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

####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 = {
xwenliang's avatar
xwenliang committed
115 116 117
		a: [1,2,3,4],
		b: [5,6,7,8],
		...
xwenliang's avatar
xwenliang committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
	};
	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];
```