Skip to content

Commit 1ce7e38

Browse files
onmotiononmotion
committed
docs: sync to actual version
1 parent 9539325 commit 1ce7e38

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

‎README.md

Lines changed: 4 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,7 +52,7 @@ 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
55+
or to try out the new beta version branch run
5656

5757
```bash
5858
yarn add react-native-autocomplete-dropdown@next
@@ -249,15 +249,12 @@ More examples see at <https://github.com/onmotion/react-native-autocomplete-drop
249249

250250
## Playground
251251

252-
To play around with the examples, you can run the following commands
253-
254252
```bash
255253
cd example
256254
yarn install
257-
yarn pods
258-
255+
npx pod-install
259256
yarn ios
260-
yarn android
257+
261258
```
262259

263260
## Options
@@ -275,7 +272,6 @@ yarn android
275272
| `clearOnFocus` | whether to clear typed text on focus | bool | true |
276273
| `ignoreAccents` | ignore diacritics | bool | true |
277274
| `trimSearchText` | trim the searched text | bool | true |
278-
| `editable` | is textInput editable | bool | true |
279275
| `debounce` | wait **ms** before call `onChangeText` | number | 0 |
280276
| `suggestionsListMaxHeight` | max height of dropdown | number | 200 |
281277
| `direction` | "up" or "down" | string | down + auto calculate |
@@ -303,5 +299,3 @@ yarn android
303299
| `emptyResultText` | replace the default "Nothing found" text on empty result | string | "Nothing found" |
304300
| `textInputProps` | text input props | TextInputProps | |
305301
| `flatListProps` | props for \ component | FlatListProps\ | |
306-
307-
## Contribution

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

Lines changed: 10 additions & 4 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" >
@@ -79,7 +79,7 @@ Wrap your root component in `AutocompleteDropdownContextProvider` from `react-na
7979
</AutocompleteDropdownContextProvider>
8080
```
8181

82-
If you have a header component, you can pass an offset. For example with react navigation
82+
If you have a header component, you can pass an offset. For example with react navigation
8383

8484
```js
8585
//...
@@ -243,12 +243,15 @@ More examples see at <https://github.com/onmotion/react-native-autocomplete-drop
243243

244244
## Playground
245245

246+
To play around with the examples, you can run the following commands
247+
246248
```bash
247249
cd example
248250
yarn install
249-
npx pod-install
250-
yarn ios
251+
yarn pods
251252

253+
yarn ios
254+
yarn android
252255
```
253256

254257
## Options
@@ -266,6 +269,7 @@ yarn ios
266269
| `clearOnFocus` | whether to clear typed text on focus | bool | true |
267270
| `ignoreAccents` | ignore diacritics | bool | true |
268271
| `trimSearchText` | trim the searched text | bool | true |
272+
| `editable` | is textInput editable | bool | true |
269273
| `debounce` | wait **ms** before call `onChangeText` | number | 0 |
270274
| `suggestionsListMaxHeight` | max height of dropdown | number | 200 |
271275
| `direction` | "up" or "down" | string | down + auto calculate |
@@ -293,3 +297,5 @@ yarn ios
293297
| `emptyResultText` | replace the default "Nothing found" text on empty result | string | "Nothing found" |
294298
| `textInputProps` | text input props | TextInputProps | |
295299
| `flatListProps` | props for \ component | FlatListProps\ | |
300+
301+
## Contribution

0 commit comments

Comments
 (0)