Skip to content

Commit 0c90ac8

Browse files
authored
docs: mention that react-native-reanimated is a mandatory dependency right now (#423)
## 📜 Description Added warning on installation page that `reanimated` is a mandatory dependency right now. ## 💡 Motivation and Context People who are not aware about adding `reanimated` dependency may get "failed to create a worklet" error, so I want to make it explicit that `reanimated` is a mandatory dependency right now (maybe later I'll make it optional). Partially resovles #301 ## 📢 Changelog ### Docs - added a warning about mandatory `reanimated` installation ## 🤔 How Has This Been Tested? Tested manually on `localhost:3000`. ## 📸 Screenshots (if appropriate): <img width="1007" alt="image" src="https://github.com/kirillzyusko/react-native-keyboard-controller/assets/22820318/98d00954-0425-4688-b10d-42f00a29e318"> ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed
1 parent b1c4ed5 commit 0c90ac8

File tree

10 files changed

+50
-0
lines changed

10 files changed

+50
-0
lines changed

docs/docs/installation.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ npm install react-native-keyboard-controller --save
4040
</TabItem>
4141
</Tabs>
4242

43+
:::warning Mandatory `react-native-reanimated` dependency
44+
45+
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.
46+
:::
47+
4348
### Linking
4449

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

docs/versioned_docs/version-1.0.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ yarn add react-native-keyboard-controller
1414
# npm install react-native-keyboard-controller --save
1515
```
1616

17+
:::warning Mandatory `react-native-reanimated` dependency
18+
19+
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.
20+
:::
21+
1722
### Linking
1823

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

docs/versioned_docs/version-1.10.0/installation.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ npm install react-native-keyboard-controller --save
4040
</TabItem>
4141
</Tabs>
4242

43+
:::warning Mandatory `react-native-reanimated` dependency
44+
45+
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.
46+
:::
47+
4348
### Linking
4449

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

docs/versioned_docs/version-1.11.0/installation.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ npm install react-native-keyboard-controller --save
4040
</TabItem>
4141
</Tabs>
4242

43+
:::warning Mandatory `react-native-reanimated` dependency
44+
45+
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.
46+
:::
47+
4348
### Linking
4449

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

docs/versioned_docs/version-1.4.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ yarn add react-native-keyboard-controller
1414
# npm install react-native-keyboard-controller --save
1515
```
1616

17+
:::warning Mandatory `react-native-reanimated` dependency
18+
19+
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.
20+
:::
21+
1722
### Linking
1823

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

docs/versioned_docs/version-1.5.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ yarn add react-native-keyboard-controller
2626
# npm install react-native-keyboard-controller --save
2727
```
2828

29+
:::warning Mandatory `react-native-reanimated` dependency
30+
31+
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.
32+
:::
33+
2934
### Linking
3035

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

docs/versioned_docs/version-1.6.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ yarn add react-native-keyboard-controller
2626
# npm install react-native-keyboard-controller --save
2727
```
2828

29+
:::warning Mandatory `react-native-reanimated` dependency
30+
31+
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.
32+
:::
33+
2934
### Linking
3035

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

docs/versioned_docs/version-1.7.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ yarn add react-native-keyboard-controller
2626
# npm install react-native-keyboard-controller --save
2727
```
2828

29+
:::warning Mandatory `react-native-reanimated` dependency
30+
31+
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.
32+
:::
33+
2934
### Linking
3035

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

docs/versioned_docs/version-1.8.0/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ yarn add react-native-keyboard-controller
2626
# npm install react-native-keyboard-controller --save
2727
```
2828

29+
:::warning Mandatory `react-native-reanimated` dependency
30+
31+
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.
32+
:::
33+
2934
### Linking
3035

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

docs/versioned_docs/version-1.9.0/installation.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ npm install react-native-keyboard-controller --save
4040
</TabItem>
4141
</Tabs>
4242

43+
:::warning Mandatory `react-native-reanimated` dependency
44+
45+
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.
46+
:::
47+
4348
### Linking
4449

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

0 commit comments

Comments
 (0)