Skip to content

Commit f48d2d7

Browse files
authored
docs: FAQ section (#648)
## 📜 Description Added FAQ section. ## 💡 Motivation and Context Installation guide contains too many tips/info badges. I decided to keep info in installation guide only which related to the installation process. For other important topics I created a separate page (FAQ) where I'll place the questions and answers. ## 📢 Changelog ### Docs - added `FAQ` section; - removed one `info` badge and move it to FAQ page. ## 🤔 How Has This Been Tested? Tested via preview. ## 📸 Screenshots (if appropriate): |Before|After| |-------|-----| |<img width="990" alt="image" src="https://github.com/user-attachments/assets/38fea8d9-9dc7-4aef-825b-606d623b6fdc">|<img width="987" alt="image" src="https://github.com/user-attachments/assets/b2282655-3d26-4b60-824f-703f14443351">| ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed
1 parent 9dec434 commit f48d2d7

File tree

6 files changed

+58
-12
lines changed

6 files changed

+58
-12
lines changed

docs/docs/faq.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 6
3+
description: Frequently asked questions and answers on them
4+
keywords:
5+
[
6+
react-native-keyboard-controller,
7+
react-native keyboard,
8+
installation,
9+
setup,
10+
keyboard handling,
11+
keyboard animation,
12+
keyboard movement,
13+
troubleshooting,
14+
]
15+
---
16+
17+
# FAQ
18+
19+
## Usage with `useAnimatedKeyboard` hook from `react-native-reanimated`
20+
21+
`react-native-keyboard-controller` and `useAnimatedKeyboard` hook (from `react-native-reanimated`) _**may**_ technically be used together, but it's **highly recommended** to use only one of them to avoid any kind of conflicts.
22+
23+
If you want to know the difference between `useAnimatedKeyboard` and the implementation of this library, please read [this comparison](./recipes/architecture#what-is-the-difference-between-useanimatedkeyboard-from-react-native-reanimated-and-this-library).

docs/docs/installation.mdx

-6
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,6 @@ npm install react-native-keyboard-controller --save
4545
This library requires `react-native-reanimated` to work properly. If you don't have it in your project, you need to follow [installation guide](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) and install it in your project before using this library.
4646
:::
4747

48-
:::info Usage with `useAnimatedKeyboard` hook from `react-native-reanimated`
49-
`react-native-keyboard-controller` and `useAnimatedKeyboard` hook (from `react-native-reanimated`) _**may**_ technically be used together, but it's **highly recommended** to use only one of them to avoid any kind of conflicts.
50-
51-
If you want to know the difference between `useAnimatedKeyboard` and the implementation of this library, please read [this comparison](./recipes/architecture#what-is-the-difference-between-useanimatedkeyboard-from-react-native-reanimated-and-this-library).
52-
:::
53-
5448
### Linking
5549

5650
This package supports [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md).

docs/docs/troubleshooting.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar_position: 5
3+
description: Troubleshooting guide
4+
keywords: [react-native-keyboard-controller, troubleshooting]
5+
---
6+
17
# Troubleshooting
28

39
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`.
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 6
3+
description: Frequently asked questions and answers on them
4+
keywords:
5+
[
6+
react-native-keyboard-controller,
7+
react-native keyboard,
8+
installation,
9+
setup,
10+
keyboard handling,
11+
keyboard animation,
12+
keyboard movement,
13+
troubleshooting,
14+
]
15+
---
16+
17+
# FAQ
18+
19+
## Usage with `useAnimatedKeyboard` hook from `react-native-reanimated`
20+
21+
`react-native-keyboard-controller` and `useAnimatedKeyboard` hook (from `react-native-reanimated`) _**may**_ technically be used together, but it's **highly recommended** to use only one of them to avoid any kind of conflicts.
22+
23+
If you want to know the difference between `useAnimatedKeyboard` and the implementation of this library, please read [this comparison](./recipes/architecture#what-is-the-difference-between-useanimatedkeyboard-from-react-native-reanimated-and-this-library).

docs/versioned_docs/version-1.14.0/installation.mdx

-6
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,6 @@ npm install react-native-keyboard-controller --save
4545
This library requires `react-native-reanimated` to work properly. If you don't have it in your project, you need to follow [installation guide](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/#installation) and install it in your project before using this library.
4646
:::
4747

48-
:::info Usage with `useAnimatedKeyboard` hook from `react-native-reanimated`
49-
`react-native-keyboard-controller` and `useAnimatedKeyboard` hook (from `react-native-reanimated`) _**may**_ technically be used together, but it's **highly recommended** to use only one of them to avoid any kind of conflicts.
50-
51-
If you want to know the difference between `useAnimatedKeyboard` and the implementation of this library, please read [this comparison](./recipes/architecture#what-is-the-difference-between-useanimatedkeyboard-from-react-native-reanimated-and-this-library).
52-
:::
53-
5448
### Linking
5549

5650
This package supports [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md).

docs/versioned_docs/version-1.14.0/troubleshooting.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
sidebar_position: 5
3+
description: Troubleshooting guide
4+
keywords: [react-native-keyboard-controller, troubleshooting]
5+
---
6+
17
# Troubleshooting
28

39
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`.

0 commit comments

Comments
 (0)