Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updated Expo installation instruction #872

Merged
merged 2 commits into from
Mar 20, 2025
Merged

docs: updated Expo installation instruction #872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65eb5b6
docs: updated Expo installation instruction
kirillzyusko Mar 20, 2025
39f79b4
docs: mention fresh build option
kirillzyusko Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ yarn add react-native-keyboard-controller
npm install react-native-keyboard-controller --save
```

</TabItem>
<TabItem value="expo" label="EXPO">

```shell
npx expo install react-native-keyboard-controller
```

:::note Only Expo Dev client compatible
This library has native code, so it **does not work** with _Expo Go_ but it's fully compatible with [custom dev client](https://docs.expo.dev/development/getting-started/).
:::

</TabItem>
</Tabs>

Expand All @@ -51,14 +62,11 @@ This package supports [autolinking](https://github.com/react-native-community/cl

:::tip Pods update

Don't forget to re-install `pods` after adding the package and don't forget to re-assemble `android` and `ios` applications, since this library contains native code.
After adding the package don't forget to **re-install** `pods` and **re-assemble** `android` and `ios` applications, since this library contains native code.

If you still experience issues like **package doesn't seem to be linked** try performing a [fresh build](https://github.com/kirillzyusko/react-native-keyboard-controller/issues/786#issuecomment-2741464142) to clear any outdated cache.
:::

### Expo

This library has native code, so it does not work with _Expo Go_ but you can easily install it using a [custom dev client](https://docs.expo.dev/development/getting-started/).

## Adding provider

In order to use it you'll need to wrap your app with `KeyboardProvider` component.
Expand Down
18 changes: 13 additions & 5 deletions docs/versioned_docs/version-1.16.0/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ yarn add react-native-keyboard-controller
npm install react-native-keyboard-controller --save
```

</TabItem>
<TabItem value="expo" label="EXPO">

```shell
npx expo install react-native-keyboard-controller
```

:::note Only Expo Dev client compatible
This library has native code, so it **does not work** with _Expo Go_ but it's fully compatible with [custom dev client](https://docs.expo.dev/development/getting-started/).
:::

</TabItem>
</Tabs>

Expand All @@ -51,14 +62,11 @@ This package supports [autolinking](https://github.com/react-native-community/cl

:::tip Pods update

Don't forget to re-install `pods` after adding the package and don't forget to re-assemble `android` and `ios` applications, since this library contains native code.
After adding the package don't forget to **re-install** `pods` and **re-assemble** `android` and `ios` applications, since this library contains native code.

If you still experience issues like **package doesn't seem to be linked** try performing a [fresh build](https://github.com/kirillzyusko/react-native-keyboard-controller/issues/786#issuecomment-2741464142) to clear any outdated cache.
:::

### Expo

This library has native code, so it does not work with _Expo Go_ but you can easily install it using a [custom dev client](https://docs.expo.dev/development/getting-started/).

## Adding provider

In order to use it you'll need to wrap your app with `KeyboardProvider` component.
Expand Down