docs: add compatibility table to tab-view

react-navigation · May 26, 2023 · 4b28fac · 4b28fac
1 parent 926a657
commit 4b28fac
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/versioned_docs/version-6.x/tab-view.md b/versioned_docs/version-6.x/tab-view.md
@@ -14,6 +14,15 @@ It follows material design guidelines by default, but you can also use your own
 
 This package doesn't integrate with React Navigation. If you want to integrate the tab view with React Navigation's navigation system, e.g. want to show screens in the tab bar and be able to navigate between them using `navigation.navigate` etc, use [Material Top Tab Navigator](material-top-tab-navigator.md) instead.
 
+## React Native Compatibility
+
+To use this library you need to ensure you are using the correct version of React Native. If you are using a version of React Native that is lower than `0.63` you will need to upgrade that before attempting to use this library.
+
+| `react-native-tab-view` Version | Required React Native Version |
+| ------------------------------- | ----------------------------- |
+| `2.x.x`                         | `< 0.63`                      |
+| `3.x.x`                         | `>= 0.63`                     |
+
 ## Installation
 
 To use this package, open a Terminal in the project root and run:
@@ -262,9 +271,7 @@ When you enable lazy rendering for a screen, it will usually take some time to r
 You can also pass a boolean to enable lazy for all of the scenes:
 
 ```js
-<TabView
-  lazy
-/>
+<TabView lazy />
 ```
 
 ##### `lazyPreloadDistance`

diff --git a/versioned_docs/version-7.x/tab-view.md b/versioned_docs/version-7.x/tab-view.md
@@ -14,6 +14,15 @@ It follows material design guidelines by default, but you can also use your own
 
 This package doesn't integrate with React Navigation. If you want to integrate the tab view with React Navigation's navigation system, e.g. want to show screens in the tab bar and be able to navigate between them using `navigation.navigate` etc, use [Material Top Tab Navigator](material-top-tab-navigator.md) instead.
 
+## React Native Compatibility
+
+To use this library you need to ensure you are using the correct version of React Native. If you are using a version of React Native that is lower than `0.63` you will need to upgrade that before attempting to use this library.
+
+| `react-native-tab-view` Version | Required React Native Version |
+| ------------------------------- | ----------------------------- |
+| `2.x.x`                         | `< 0.63`                      |
+| `3.x.x`                         | `>= 0.63`                     |
+
 ## Installation
 
 To use this package, open a Terminal in the project root and run:
@@ -262,9 +271,7 @@ When you enable lazy rendering for a screen, it will usually take some time to r
 You can also pass a boolean to enable lazy for all of the scenes:
 
 ```js
-<TabView
-  lazy
-/>
+<TabView lazy />
 ```
 
 ##### `lazyPreloadDistance`