Skip to content

Commit 4e2bb64

Browse files
onmotiononmotion
committed
docs: update readme
1 parent ec09ec0 commit 4e2bb64

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

‎README.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Dropdown Item picker with search and autocomplete (typeahead) functionality for
66
[![npm](https://img.shields.io/npm/v/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
77
[![npm](https://img.shields.io/npm/dm/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
88

9-
> This is documentation for version 3.x, if you are looking docs for version 2.x, you can find it [here](https://github.com/onmotion/react-native-autocomplete-dropdown/blob/main/README%5E2.md)
9+
> This is documentation for version 4.x, if you are looking docs for version 3.x, you can find it [here](https://github.com/onmotion/react-native-autocomplete-dropdown/blob/main/README%5E3.md)
1010
1111
<p style="text-align: center;" align="center">
1212
<img src="./screens/Example.png" width="500px" >
@@ -42,21 +42,17 @@ Dropdown Item picker with search and autocomplete (typeahead) functionality for
4242

4343
Run:
4444

45-
```bash
46-
npm install --save react-native-autocomplete-dropdown
47-
```
48-
4945
or
5046

5147
```bash
5248
yarn add react-native-autocomplete-dropdown
5349
```
5450

55-
or to try out the new beta version branch run
51+
or for v3.x
5652

57-
```bash
58-
yarn add react-native-autocomplete-dropdown@next
59-
```
53+
```bash
54+
yarn add react-native-autocomplete-dropdown@3.1.5
55+
```
6056

6157
## Post-install Steps
6258

@@ -249,12 +245,15 @@ More examples see at <https://github.com/onmotion/react-native-autocomplete-drop
249245

250246
## Playground
251247

248+
To play around with the examples, you can run the following commands
249+
252250
```bash
253251
cd example
254252
yarn install
255-
npx pod-install
256-
yarn ios
253+
yarn pods
257254

255+
yarn ios
256+
yarn android
258257
```
259258

260259
## Options
@@ -270,8 +269,10 @@ yarn ios
270269
| `closeOnBlur` | whether to close dropdown on blur | bool | false |
271270
| `closeOnSubmit` | whether to close dropdown on submit | bool | false |
272271
| `clearOnFocus` | whether to clear typed text on focus | bool | true |
272+
| `caseSensitive` | whether to perform case-sensitive search | bool | false
273273
| `ignoreAccents` | ignore diacritics | bool | true |
274274
| `trimSearchText` | trim the searched text | bool | true |
275+
| `editable` | is textInput editable | bool | true |
275276
| `debounce` | wait **ms** before call `onChangeText` | number | 0 |
276277
| `suggestionsListMaxHeight` | max height of dropdown | number | 200 |
277278
| `direction` | "up" or "down" | string | down + auto calculate |
@@ -299,3 +300,5 @@ yarn ios
299300
| `emptyResultText` | replace the default "Nothing found" text on empty result | string | "Nothing found" |
300301
| `textInputProps` | text input props | TextInputProps | |
301302
| `flatListProps` | props for \ component | FlatListProps\ | |
303+
304+
## Contribution

‎README^4.md‎ renamed to ‎README^3.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Dropdown Item picker with search and autocomplete (typeahead) functionality for
66
[![npm](https://img.shields.io/npm/v/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
77
[![npm](https://img.shields.io/npm/dm/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
88

9-
> This is documentation for version 4.x, if you are looking docs for version 3.x, you can find it [here](https://github.com/onmotion/react-native-autocomplete-dropdown/blob/main/README%5E3.md)
9+
> This is documentation for version 3.x, if you are looking docs for version 2.x, you can find it [here](https://github.com/onmotion/react-native-autocomplete-dropdown/blob/main/README%5E2.md)
1010
1111
<p style="text-align: center;" align="center">
1212
<img src="./screens/Example.png" width="500px" >
@@ -52,6 +52,12 @@ npm install --save react-native-autocomplete-dropdown
5252
yarn add react-native-autocomplete-dropdown
5353
```
5454

55+
or to try out the new beta version branch run
56+
57+
```bash
58+
yarn add react-native-autocomplete-dropdown@next
59+
```
60+
5561
## Post-install Steps
5662

5763
Make sure **react-native-svg** is installed. Follow the guide
@@ -243,15 +249,12 @@ More examples see at <https://github.com/onmotion/react-native-autocomplete-drop
243249

244250
## Playground
245251

246-
To play around with the examples, you can run the following commands
247-
248252
```bash
249253
cd example
250254
yarn install
251-
yarn pods
252-
255+
npx pod-install
253256
yarn ios
254-
yarn android
257+
255258
```
256259

257260
## Options
@@ -267,10 +270,8 @@ yarn android
267270
| `closeOnBlur` | whether to close dropdown on blur | bool | false |
268271
| `closeOnSubmit` | whether to close dropdown on submit | bool | false |
269272
| `clearOnFocus` | whether to clear typed text on focus | bool | true |
270-
| `caseSensitive` | whether to perform case-sensitive search | bool | false
271273
| `ignoreAccents` | ignore diacritics | bool | true |
272274
| `trimSearchText` | trim the searched text | bool | true |
273-
| `editable` | is textInput editable | bool | true |
274275
| `debounce` | wait **ms** before call `onChangeText` | number | 0 |
275276
| `suggestionsListMaxHeight` | max height of dropdown | number | 200 |
276277
| `direction` | "up" or "down" | string | down + auto calculate |
@@ -298,5 +299,3 @@ yarn android
298299
| `emptyResultText` | replace the default "Nothing found" text on empty result | string | "Nothing found" |
299300
| `textInputProps` | text input props | TextInputProps | |
300301
| `flatListProps` | props for \ component | FlatListProps\ | |
301-
302-
## Contribution

0 commit comments

Comments
 (0)