Skip to content

Commit 6ac9086

Browse files
authored
docs: updated Expo installation instruction (#872)
## 📜 Description Updated installation guide. ## 💡 Motivation and Context People sometimes complain about the problem when package is not linked, so I decided to improve docs to reduce similar issues in the future. Closes #786 ## 📢 Changelog <!-- High level overview of important changes --> <!-- For example: fixed status bar manipulation; added new types declarations; --> <!-- If your changes don't affect one of platform/language below - then remove this platform/language --> ### Docs - clearly mention expo setup (because expo uses its own installation command); - mention a problem and solution of build caches; - move expo note under expo installation tab. ## 🤔 How Has This Been Tested? Tested locally and via preview. ## 📸 Screenshots (if appropriate): <img width="989" alt="image" src="https://github.com/user-attachments/assets/223f534f-60fc-4a42-8330-c8ed506f26d3" /> ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed
1 parent e1a4cc4 commit 6ac9086

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

docs/docs/installation.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ yarn add react-native-keyboard-controller
3737
npm install react-native-keyboard-controller --save
3838
```
3939

40+
</TabItem>
41+
<TabItem value="expo" label="EXPO">
42+
43+
```shell
44+
npx expo install react-native-keyboard-controller
45+
```
46+
47+
:::note Only Expo Dev client compatible
48+
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/).
49+
:::
50+
4051
</TabItem>
4152
</Tabs>
4253

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

5263
:::tip Pods update
5364

54-
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.
65+
After adding the package don't forget to **re-install** `pods` and **re-assemble** `android` and `ios` applications, since this library contains native code.
5566

67+
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.
5668
:::
5769

58-
### Expo
59-
60-
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/).
61-
6270
## Adding provider
6371

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

docs/versioned_docs/version-1.16.0/installation.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ yarn add react-native-keyboard-controller
3737
npm install react-native-keyboard-controller --save
3838
```
3939

40+
</TabItem>
41+
<TabItem value="expo" label="EXPO">
42+
43+
```shell
44+
npx expo install react-native-keyboard-controller
45+
```
46+
47+
:::note Only Expo Dev client compatible
48+
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/).
49+
:::
50+
4051
</TabItem>
4152
</Tabs>
4253

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

5263
:::tip Pods update
5364

54-
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.
65+
After adding the package don't forget to **re-install** `pods` and **re-assemble** `android` and `ios` applications, since this library contains native code.
5566

67+
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.
5668
:::
5769

58-
### Expo
59-
60-
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/).
61-
6270
## Adding provider
6371

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

0 commit comments

Comments
 (0)