Skip to content

Commit

Permalink
docs: sync to actual version
Browse files Browse the repository at this point in the history
  • Loading branch information
@onmotion
onmotion committed Apr 1, 2024
1 parent 9539325 commit 1ce7e38
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 4 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Dropdown Item picker with search and autocomplete (typeahead) functionality for
[![npm](https://img.shields.io/npm/v/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
[![npm](https://img.shields.io/npm/dm/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)

> 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)
> 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)
<p style="text-align: center;" align="center">
<img src="./screens/Example.png" width="500px" >
Expand Down Expand Up @@ -52,7 +52,7 @@ npm install --save react-native-autocomplete-dropdown
yarn add react-native-autocomplete-dropdown
```

or to try out the new beta version branch run
or to try out the new beta version branch run

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

## Playground

To play around with the examples, you can run the following commands

```bash
cd example
yarn install
yarn pods

npx pod-install
yarn ios
yarn android

```

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

## Contribution
14 changes: 10 additions & 4 deletions README^3.md → README^4.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Dropdown Item picker with search and autocomplete (typeahead) functionality for
[![npm](https://img.shields.io/npm/v/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)
[![npm](https://img.shields.io/npm/dm/react-native-autocomplete-dropdown.svg)](https://npmjs.com/package/react-native-autocomplete-dropdown)

> 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)
> 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)
<p style="text-align: center;" align="center">
<img src="./screens/Example.png" width="500px" >
Expand Down Expand Up @@ -79,7 +79,7 @@ Wrap your root component in `AutocompleteDropdownContextProvider` from `react-na
</AutocompleteDropdownContextProvider>
```

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

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

## Playground

To play around with the examples, you can run the following commands

```bash
cd example
yarn install
npx pod-install
yarn ios
yarn pods

yarn ios
yarn android
```

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

## Contribution

0 comments on commit 1ce7e38

Please sign in to comment.