You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## 📜 Description
Added new `Troubleshooting` page.
## 💡 Motivation and Context
The installation section seems to contain the information that may be
not used directly on this page. So I decided to move the content of this
page to separate page + add a new use-case with sentry@v5.
Closes#641
## 📢 Changelog
### Docs
- added dedicated `Troubleshooting` page;
- added a reference to `Troubleshooting` page on `Installation` page.
- added a new use-case with Sentry@v5.
## 🤔 How Has This Been Tested?
Tested via preview.
## 📸 Screenshots (if appropriate):
### Installation
<img width="1007" alt="image"
src="https://github.com/user-attachments/assets/5f30d945-0487-490f-af03-1d213a7eae1e">
### Troubleshooting
<img width="1301" alt="image"
src="https://github.com/user-attachments/assets/9d086f13-07e0-43c2-a38b-db1791559bd0">
## 📝 Checklist
- [x] CI successfully passed
- [x] I added new mocks and corresponding unit-tests if library API was
changed
Copy file name to clipboardExpand all lines: docs/docs/installation.mdx
+3-54
Original file line number
Diff line number
Diff line change
@@ -89,57 +89,6 @@ export default function App() {
89
89
90
90
Congratulations! 🎉 You've just finished installation process. Go to the [next section](./guides/first-animation.md) to get more insights of what you can do using this library. 😎
91
91
92
-
## Troubleshooting
93
-
94
-
### Incompatible `kotlinVersion` and failed Android builds
95
-
96
-
Sometimes you may see failed Android builds complaining that your version of kotlin is lower than expected version.
97
-
98
-
`error: module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.6.0, expected version is 1.4.1.`
99
-
100
-
To overcome this issue you will need to set higher version of the kotlin:
101
-
102
-
#### react-native or expo bare workflow
103
-
104
-
You need to modify `android/build.gradle` and specify correct `kotlinVersion`:
105
-
106
-
```java
107
-
buildscript {
108
-
ext {
109
-
kotlinVersion ="1.6.21"
110
-
}
111
-
}
112
-
```
113
-
114
-
For more information please, see how it's configured in [example](https://github.com/kirillzyusko/react-native-keyboard-controller/blob/9d0e63712a2f55dab0f6f3f95398567bb9ca1efa/example/android/build.gradle#L9) project.
115
-
116
-
#### Expo managed workflow
117
-
118
-
If you are using Expo managed workflow you need to install `expo-build-properties`
119
-
120
-
```sh
121
-
npx expo install expo-build-properties
122
-
```
123
-
124
-
And add plugin inside of your `app.json` or `app.config.js` with following configuration:
125
-
126
-
```json
127
-
{
128
-
"expo": {
129
-
"plugins": [
130
-
[
131
-
"expo-build-properties",
132
-
{
133
-
"android": {
134
-
"kotlinVersion": "1.6.21"
135
-
}
136
-
}
137
-
]
138
-
]
139
-
}
140
-
}
141
-
```
142
-
143
-
### Swift support
144
-
145
-
Since part of this library is written using `swift` language - your project needs to support it. For that you can create empty `.swift` file with bridging header. See this [step-by-step](https://stackoverflow.com/a/56176956/9272042) guide if you have problems.
92
+
:::danger Troubleshooting guide
93
+
If you encounter some issues make sure to read the [Troubleshooting](./troubleshooting.md) section.
This section attempts to outline issues that users frequently encounter when first getting accustomed to using `react-native-keyboard-controller`. These issues may or may not be related to `react-native-keyboard-controller`.
4
+
5
+
## Incompatible `kotlinVersion` and failed Android builds
6
+
7
+
Sometimes you may see failed Android builds complaining that your version of kotlin is lower than expected version.
8
+
9
+
`error: module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.6.0, expected version is 1.4.1.`
10
+
11
+
To overcome this issue you will need to set higher version of the kotlin:
12
+
13
+
### `react-native` or `expo` bare workflow
14
+
15
+
You need to modify `android/build.gradle` and specify correct `kotlinVersion`:
16
+
17
+
```java
18
+
buildscript {
19
+
ext {
20
+
kotlinVersion ="1.6.21"
21
+
}
22
+
}
23
+
```
24
+
25
+
For more information please, see how it's configured in [example](https://github.com/kirillzyusko/react-native-keyboard-controller/blob/9d0e63712a2f55dab0f6f3f95398567bb9ca1efa/example/android/build.gradle#L9) project.
26
+
27
+
### `Expo` managed workflow
28
+
29
+
If you are using Expo managed workflow you need to install `expo-build-properties`
30
+
31
+
```sh
32
+
npx expo install expo-build-properties
33
+
```
34
+
35
+
And add plugin inside of your `app.json` or `app.config.js` with following configuration:
36
+
37
+
```json
38
+
{
39
+
"expo": {
40
+
"plugins": [
41
+
[
42
+
"expo-build-properties",
43
+
{
44
+
"android": {
45
+
"kotlinVersion": "1.6.21"
46
+
}
47
+
}
48
+
]
49
+
]
50
+
}
51
+
}
52
+
```
53
+
54
+
## Swift support
55
+
56
+
Since part of this library is written using `swift` language - your project needs to support it. For that you can create empty `.swift` file with bridging header. See this [step-by-step](https://stackoverflow.com/a/56176956/9272042) guide if you have problems.
57
+
58
+
## Animations frame drops
59
+
60
+
Sometimes you may see that animation performance is poor. If you are using `sentry@5` make sure `enableStallTracking` is disabled (i. e. `enableStallTracking: false`) or upgrade to `sentry@6`,
61
+
62
+
See [this issue](https://github.com/kirillzyusko/react-native-keyboard-controller/issues/641) for more details.
Copy file name to clipboardExpand all lines: docs/versioned_docs/version-1.14.0/installation.mdx
+3-54
Original file line number
Diff line number
Diff line change
@@ -89,57 +89,6 @@ export default function App() {
89
89
90
90
Congratulations! 🎉 You've just finished installation process. Go to the [next section](./guides/first-animation.md) to get more insights of what you can do using this library. 😎
91
91
92
-
## Troubleshooting
93
-
94
-
### Incompatible `kotlinVersion` and failed Android builds
95
-
96
-
Sometimes you may see failed Android builds complaining that your version of kotlin is lower than expected version.
97
-
98
-
`error: module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.6.0, expected version is 1.4.1.`
99
-
100
-
To overcome this issue you will need to set higher version of the kotlin:
101
-
102
-
#### react-native or expo bare workflow
103
-
104
-
You need to modify `android/build.gradle` and specify correct `kotlinVersion`:
105
-
106
-
```java
107
-
buildscript {
108
-
ext {
109
-
kotlinVersion ="1.6.21"
110
-
}
111
-
}
112
-
```
113
-
114
-
For more information please, see how it's configured in [example](https://github.com/kirillzyusko/react-native-keyboard-controller/blob/9d0e63712a2f55dab0f6f3f95398567bb9ca1efa/example/android/build.gradle#L9) project.
115
-
116
-
#### Expo managed workflow
117
-
118
-
If you are using Expo managed workflow you need to install `expo-build-properties`
119
-
120
-
```sh
121
-
npx expo install expo-build-properties
122
-
```
123
-
124
-
And add plugin inside of your `app.json` or `app.config.js` with following configuration:
125
-
126
-
```json
127
-
{
128
-
"expo": {
129
-
"plugins": [
130
-
[
131
-
"expo-build-properties",
132
-
{
133
-
"android": {
134
-
"kotlinVersion": "1.6.21"
135
-
}
136
-
}
137
-
]
138
-
]
139
-
}
140
-
}
141
-
```
142
-
143
-
### Swift support
144
-
145
-
Since part of this library is written using `swift` language - your project needs to support it. For that you can create empty `.swift` file with bridging header. See this [step-by-step](https://stackoverflow.com/a/56176956/9272042) guide if you have problems.
92
+
:::danger Troubleshooting guide
93
+
If you encounter some issues make sure to read the [Troubleshooting](./troubleshooting.md) section.
This section attempts to outline issues that users frequently encounter when first getting accustomed to using `react-native-keyboard-controller`. These issues may or may not be related to `react-native-keyboard-controller`.
4
+
5
+
## Incompatible `kotlinVersion` and failed Android builds
6
+
7
+
Sometimes you may see failed Android builds complaining that your version of kotlin is lower than expected version.
8
+
9
+
`error: module was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.6.0, expected version is 1.4.1.`
10
+
11
+
To overcome this issue you will need to set higher version of the kotlin:
12
+
13
+
### `react-native` or `expo` bare workflow
14
+
15
+
You need to modify `android/build.gradle` and specify correct `kotlinVersion`:
16
+
17
+
```java
18
+
buildscript {
19
+
ext {
20
+
kotlinVersion ="1.6.21"
21
+
}
22
+
}
23
+
```
24
+
25
+
For more information please, see how it's configured in [example](https://github.com/kirillzyusko/react-native-keyboard-controller/blob/9d0e63712a2f55dab0f6f3f95398567bb9ca1efa/example/android/build.gradle#L9) project.
26
+
27
+
### `Expo` managed workflow
28
+
29
+
If you are using Expo managed workflow you need to install `expo-build-properties`
30
+
31
+
```sh
32
+
npx expo install expo-build-properties
33
+
```
34
+
35
+
And add plugin inside of your `app.json` or `app.config.js` with following configuration:
36
+
37
+
```json
38
+
{
39
+
"expo": {
40
+
"plugins": [
41
+
[
42
+
"expo-build-properties",
43
+
{
44
+
"android": {
45
+
"kotlinVersion": "1.6.21"
46
+
}
47
+
}
48
+
]
49
+
]
50
+
}
51
+
}
52
+
```
53
+
54
+
## Swift support
55
+
56
+
Since part of this library is written using `swift` language - your project needs to support it. For that you can create empty `.swift` file with bridging header. See this [step-by-step](https://stackoverflow.com/a/56176956/9272042) guide if you have problems.
57
+
58
+
## Animations frame drops
59
+
60
+
Sometimes you may see that animation performance is poor. If you are using `sentry@5` make sure `enableStallTracking` is disabled (i. e. `enableStallTracking: false`) or upgrade to `sentry@6`,
61
+
62
+
See [this issue](https://github.com/kirillzyusko/react-native-keyboard-controller/issues/641) for more details.
0 commit comments