README.md 3.82 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
### For pure javascript version -> [v3.0.5](https://github.com/beefe/react-native-picker/tree/pure-javascript-version)
xwenliang's avatar
xwenliang committed
6

xwenliang's avatar
xwenliang committed
7 8
![ui2](./doc/ui2.jpg)

xwenliang's avatar
init  
xwenliang committed
9 10
###Documentation

xwenliang's avatar
xwenliang committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
####Params

|Key | Description | Type | Default|
| -- | ----------- | ---- | ------ |
|pickerConfirmBtnText  |  |string  |确认                |
|pickerCancelBtnText   |  |string  |取消                |
|pickerTitleText       |  |string  |请选择              |
|pickerConfirmBtnColor |  |array   |[1, 186, 245, 1]   |
|pickerCancelBtnColor  |  |array   |[1, 186, 245, 1]   |
|pickerTitleColor      |  |array   |[20, 20, 20, 1])   |
|pickerToolBarBg       |  |array   |[232, 232, 232, 1] |
|pickerBg              |  |array   |[196, 199, 206, 1] |
|pickerData            |  |array   |                   |
|selectedValue         |  |string  |                   |
|onPickerConfirm       |  |function|                   |
|onPickerCancel        |  |function|                   |
|onPickerSelect        |  |function|                   |
xwenliang's avatar
bugs  
xwenliang committed
28

xwenliang's avatar
xwenliang committed
29
####Methods
xwenliang's avatar
xwenliang committed
30 31 32 33 34 35 36 37

|Name | Description | Type | Default|
| --- | ----------- | ---- | ------ |
|toggle       |show or hide picker                     |   |   |
|show         |show picker                             |   |   |
|hide         |hide picker                             |   |   |
|isPickerShow |get status of picker, return a boolean  |   |   |

xwenliang's avatar
xwenliang committed
38

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

####Step 1 - install

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

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

```
	react-native link
```

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

```javascript
xwenliang's avatar
xwenliang committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
	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
77
	
xwenliang's avatar
xwenliang committed
78 79 80 81 82 83
```

###Notice

####support two modes:

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

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

####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
xwenliang's avatar
xwenliang committed
113 114 115 116 117 118 119 120 121 122
    pickerData = [
        {
            a: [1, 2, 3, 4]
        },
        {
            b: [5, 6, 7, 8]
        },
        ...
    ];
    selectedValue = ['a', 2];
xwenliang's avatar
xwenliang committed
123 124 125 126 127
```

- three wheel

```javascript
xwenliang's avatar
xwenliang committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
    pickerData = [
        {
            a: [
                {
                    a1: [1, 2, 3, 4]
                },
                {
                    a2: [5, 6, 7, 8]
                },
                {
                    a3: [9, 10, 11, 12]
                }
            ]
        },
        {
            b: [
                {
                    b1: [11, 22, 33, 44]
                },
                {
                    b2: [55, 66, 77, 88]
                },
                {
                    b3: [99, 1010, 1111, 1212]
                }
            ]
        },
        {
            c: [
                {
                    c1: ['a', 'b', 'c']
                },
                {
                    c2: ['aa', 'bb', 'cc']
                },
                {
                    c3: ['aaa', 'bbb', 'ccc']
                }
            ]
        },
xwenliang's avatar
xwenliang committed
168
        ...
xwenliang's avatar
xwenliang committed
169 170
    ]
```