Merge pull request #12 from Glazzes/10-smooth-pinch

Update documentation to latest GH release
Glazzes · Mar 28, 2024 · 3769912 · 3769912
2 parents c299dd4 + 04df090
commit 3769912
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 7 deletions.
diff --git a/docs/docs/.vitepress/config.mts b/docs/docs/.vitepress/config.mts
@@ -12,7 +12,7 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      {text: '1.0.1', items: [
+      {text: '1.0.2', items: [
         {text: 'Releases', link: 'https://github.com/Glazzes/react-native-zoom-toolkit/releases'},
         {text: 'Contributing', link: 'https://github.com/Glazzes/react-native-zoom-toolkit/blob/main/CONTRIBUTING.md'},
       ]}

diff --git a/docs/docs/components/cropzoom.md b/docs/docs/components/cropzoom.md
@@ -144,11 +144,15 @@ Select which one of the three available pan modes to use.
 Select which one of the two available scale modes to use.
 
 ### panWithPinch
-| Type | Default | Required |
-|------|---------|----------|
-| `boolean` | `true` | `No`    |
+| Type | Default |
+|------|---------|
+| `boolean` | `true in Android` and `false in iOS` | 
 
-Lets the user drag the component around as they pinch, it also provides a more accurate pinch gesture calculation at the cost of a subtle staircase feeling, disable for a smoother but less accurate experience.
+Lets the user drag the component around as they pinch, it also provides a more accurate pinch gesture calculation at the cost of a subtle "staircase feeling", disable for a smoother but less accurate experience.
+
+::: warning Beware iOS users
+Due to the lack of decimal places for the focal point in iOS devices (see this [GH's issue](https://github.com/software-mansion/react-native-gesture-handler/issues/2833) and [this issue](https://github.com/Glazzes/react-native-zoom-toolkit/issues/10)), this feature is disabled by default for iOS users, if you want to enable it you will require a version of React Native Gesture Handler greater than equals 2.16.0
+:::
 
 ### onTap
 | Type | Default | Additional Info |

diff --git a/docs/docs/components/resumablezoom.md b/docs/docs/components/resumablezoom.md
@@ -133,9 +133,13 @@ Enables and disables both single and double tap gestures.
 ### panWithPinch
 | Type | Default |
 |------|---------|
-| `boolean` | `true` | 
+| `boolean` | `true in Android` and `false in iOS` | 
 
-Lets the user drag the component around as they pinch, it also provides a more accurate pinch gesture calculation at the cost of a subtle staircase feeling, disable for a smoother but less accurate experience.
+Lets the user drag the component around as they pinch, it also provides a more accurate pinch gesture calculation at the cost of a subtle "staircase feeling", disable for a smoother but less accurate experience.
+
+::: warning Beware iOS users
+Due to the lack of decimal places for the focal point in iOS devices (see this [GH's issue](https://github.com/software-mansion/react-native-gesture-handler/issues/2833) and [this issue](https://github.com/Glazzes/react-native-zoom-toolkit/issues/10)), this feature is disabled by default for iOS users, if you want to enable it you will require a version of React Native Gesture Handler greater than equals 2.16.0
+:::
 
 ### onTap
 | Type | Default | Additional Info |

diff --git a/docs/docs/components/snapbackzoom.md b/docs/docs/components/snapbackzoom.md
@@ -5,6 +5,11 @@ outline: deep
 ---
 
 # SnapbackZoom
+
+::: warning Beware iOS users
+Due to the lack of decimal places for the focal point in iOS devices (see this [GH's issue](https://github.com/software-mansion/react-native-gesture-handler/issues/2833) and [this issue](https://github.com/Glazzes/react-native-zoom-toolkit/issues/10)), this feature will be subject to some sttutering unless you install a version of React Native Gesture Handler greater than equals 2.16.0
+:::
+
 An ideal component for preview handling, as its name suggests it returns to its original position after the pinch gesture ends, you can see this feature being implemented in Telegram's messages containing images and/or videos or Instragram's posts.
 
 The next video footage is taken from the [Example app](https://github.com/Glazzes/react-native-zoom-toolkit/tree/main/example)

diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -21,6 +21,10 @@ yarn add react-native-zoom-toolkit
 ### Dependencies
 This library relies on both Reanimated and Gesture Handler being part of your project, if you do not have them installed already please refer to [Reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/) and [Gesture Handler](https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/installation) installation guides.
 
+::: warning Beware iOS users
+Due to the lack of decimal places for the focal point in iOS devices (see this [GH's issue](https://github.com/software-mansion/react-native-gesture-handler/issues/2833) and [this issue](https://github.com/Glazzes/react-native-zoom-toolkit/issues/10)), in order to prove the full feature set for iOS users versions of React Native Gesture Handler greater than equals 2.16.0 are recommended.
+:::
+
 ::: code-group
 
 ```sh [npm]