Merge remote-tracking branch 'origin/master'

Author: farfromrefug

CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.30](https://github.com/nativescript-community/gesturehandler/compare/v2.0.29...v2.0.30) (2024-03-22)
+
+### Bug Fixes
+
+* bug fix ([254419f](https://github.com/nativescript-community/gesturehandler/commit/254419f0bad6a33fbabb39da2cda0861a918ff1f))
+
+## [2.0.29](https://github.com/nativescript-community/gesturehandler/compare/v2.0.28...v2.0.29) (2024-03-22)
+
+### Bug Fixes
+
+* **ios:** cancel gesture fix ([77a2ec0](https://github.com/nativescript-community/gesturehandler/commit/77a2ec07b9af89e6b02b27525e87e3dc0b6a61b2))
+* **ios:** gesture override more in line with N ([fb3744d](https://github.com/nativescript-community/gesturehandler/commit/fb3744d274aa5fa659450f1c1b58c73e26d12d3a))
+
 ## [2.0.28](https://github.com/nativescript-community/gesturehandler/compare/v2.0.27...v2.0.28) (2024-02-24)
 
 ### Bug Fixes

README.md

@@ -66,6 +66,7 @@
 [](#installation)
 
 ## Installation
+
 Run the following command from the root of your project:
 
 `ns plugin add @nativescript-community/gesturehandler`
@@ -79,16 +80,18 @@ Run the following command from the root of your project:
 ## API
 
 We need to do some wiring when your app starts, so open `app.ts` and add this before creating any View/App/Frame:
+
 ##### TypeScript
+
 ```ts
-import { install } from "@nativescript-community/gesturehandler";
+import { install } from '@nativescript-community/gesturehandler';
 install();
 ```
 
 You create a gesture handler using something like this:
-```typescript 
-import { GestureHandlerTouchEvent, GestureHandlerStateEvent, GestureStateEventData, GestureTouchEventData, HandlerType } from '@nativescript-community/gesturehandler';
 
+```typescript
+import { GestureHandlerTouchEvent, GestureHandlerStateEvent, GestureStateEventData, GestureTouchEventData, HandlerType, Manager } from '@nativescript-community/gesturehandler';
 
 function onGestureTouch(args: GestureTouchEventData) {
     const { state, extraData, view } = args.data;
@@ -100,17 +103,17 @@ function onGestureState(args: GestureStateEventData) {
     console.log('onGestureState', state, prevState, view, extraData);
 }
 const manager = Manager.getInstance();
-const gestureHandler = = manager.createGestureHandler(HandlerType.PAN, 10, {
+const gestureHandler = manager.createGestureHandler(HandlerType.PAN, 10, {
     shouldCancelWhenOutside: false
 });
 gestureHandler.on(GestureHandlerTouchEvent, onGestureTouch, this);
 gestureHandler.on(GestureHandlerStateEvent, onGestureState, this);
 gestureHandler.attachToView(view);
 ```
 
-Right now you must not forget to store the ```gestureHandler``` somewhere or the gesture won't work on iOS (native object being released). This will be fixed in future versions.
+Right now you must not forget to store the `gestureHandler` somewhere or the gesture won't work on iOS (native object being released). This will be fixed in future versions.
 
-Now about the API. All the gestures for the react counterpart exist with the same options and the same event ```extraData```.
+Now about the API. All the gestures for the react counterpart exist with the same options and the same event `extraData`.
 
 
 [](#gesturerootview)
@@ -132,7 +135,7 @@ In case you don't (drawer root view, modals, ...) then you can wrap your views i
 
 ## Overriding Nativescript gestures
 
-This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes `tap` and `longpress`
+This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes `tap` and `longpress`.
 
 To do that 
 
@@ -145,9 +148,7 @@ To do that
 ## Credits
 
 This is a port of [react-native-gesturehandler](https://kmagiera.github.io/react-native-gesture-handler/).
-The source is based on the source code by [Krzysztof Magiera](https://github.com/kmagiera). Dont hesitate to go and thank him for his work!
-
-
+The source is based on the source code by [Krzysztof Magiera](https://github.com/kmagiera). Don't hesitate to go and thank him for his work!
 
 ### Examples:
 
@@ -262,6 +263,7 @@ One easy solution is t modify `~/.gitconfig` and add
 
 If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
 
+
 [](#demos-and-development)
 
 ## Demos and Development

docs/assets/navigation.js

@@ -68,10 +68,10 @@ <h1 align="center">@nativescript-community/gesturehandler</h1>
 <p><a href="#md:api"></a></p>
 <p><a href="#md:api"></a></p>
 <a id="md:api" class="tsd-anchor"></a><h2><a href="#md:api">API</a></h2><p>We need to do some wiring when your app starts, so open <code>app.ts</code> and add this before creating any View/App/Frame:</p>
-<a id="md:typescript" class="tsd-anchor"></a><h5><a href="#md:typescript">TypeScript</a></h5><pre><code class="language-ts"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">install</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&quot;@nativescript-community/gesturehandler&quot;</span><span class="hl-1">;</span><br/><span class="hl-4">install</span><span class="hl-1">();</span>
+<a id="md:typescript" class="tsd-anchor"></a><h5><a href="#md:typescript">TypeScript</a></h5><pre><code class="language-ts"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">install</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@nativescript-community/gesturehandler&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">install</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
 <p>You create a gesture handler using something like this:</p>
-<pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">GestureHandlerTouchEvent</span><span class="hl-1">, </span><span class="hl-2">GestureHandlerStateEvent</span><span class="hl-1">, </span><span class="hl-2">GestureStateEventData</span><span class="hl-1">, </span><span class="hl-2">GestureTouchEventData</span><span class="hl-1">, </span><span class="hl-2">HandlerType</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@nativescript-community/gesturehandler&#39;</span><span class="hl-1">;</span><br/><br/><br/><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-4">onGestureTouch</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">: </span><span class="hl-6">GestureTouchEventData</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-7">state</span><span class="hl-1">, </span><span class="hl-7">extraData</span><span class="hl-1">, </span><span class="hl-7">view</span><span class="hl-1"> } = </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">view</span><span class="hl-1">.</span><span class="hl-2">translateX</span><span class="hl-1"> = </span><span class="hl-2">extraData</span><span class="hl-1">.</span><span class="hl-2">translationX</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">view</span><span class="hl-1">.</span><span class="hl-2">translateY</span><span class="hl-1"> = </span><span class="hl-2">extraData</span><span class="hl-1">.</span><span class="hl-2">translationY</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-4">onGestureState</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">: </span><span class="hl-6">GestureStateEventData</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-7">state</span><span class="hl-1">, </span><span class="hl-7">prevState</span><span class="hl-1">, </span><span class="hl-7">extraData</span><span class="hl-1">, </span><span class="hl-7">view</span><span class="hl-1"> } = </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-3">&#39;onGestureState&#39;</span><span class="hl-1">, </span><span class="hl-2">state</span><span class="hl-1">, </span><span class="hl-2">prevState</span><span class="hl-1">, </span><span class="hl-2">view</span><span class="hl-1">, </span><span class="hl-2">extraData</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">manager</span><span class="hl-1"> = </span><span class="hl-2">Manager</span><span class="hl-1">.</span><span class="hl-4">getInstance</span><span class="hl-1">();</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">gestureHandler</span><span class="hl-1"> = = </span><span class="hl-2">manager</span><span class="hl-1">.</span><span class="hl-4">createGestureHandler</span><span class="hl-1">(</span><span class="hl-2">HandlerType</span><span class="hl-1">.</span><span class="hl-7">PAN</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, {</span><br/><span class="hl-1">    </span><span class="hl-2">shouldCancelWhenOutside:</span><span class="hl-1"> </span><span class="hl-5">false</span><br/><span class="hl-1">});</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-2">GestureHandlerTouchEvent</span><span class="hl-1">, </span><span class="hl-2">onGestureTouch</span><span class="hl-1">, </span><span class="hl-5">this</span><span class="hl-1">);</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-2">GestureHandlerStateEvent</span><span class="hl-1">, </span><span class="hl-2">onGestureState</span><span class="hl-1">, </span><span class="hl-5">this</span><span class="hl-1">);</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">attachToView</span><span class="hl-1">(</span><span class="hl-2">view</span><span class="hl-1">);</span>
+<pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">GestureHandlerTouchEvent</span><span class="hl-1">, </span><span class="hl-2">GestureHandlerStateEvent</span><span class="hl-1">, </span><span class="hl-2">GestureStateEventData</span><span class="hl-1">, </span><span class="hl-2">GestureTouchEventData</span><span class="hl-1">, </span><span class="hl-2">HandlerType</span><span class="hl-1">, </span><span class="hl-2">Manager</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@nativescript-community/gesturehandler&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-4">onGestureTouch</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">: </span><span class="hl-6">GestureTouchEventData</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-7">state</span><span class="hl-1">, </span><span class="hl-7">extraData</span><span class="hl-1">, </span><span class="hl-7">view</span><span class="hl-1"> } = </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">view</span><span class="hl-1">.</span><span class="hl-2">translateX</span><span class="hl-1"> = </span><span class="hl-2">extraData</span><span class="hl-1">.</span><span class="hl-2">translationX</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">view</span><span class="hl-1">.</span><span class="hl-2">translateY</span><span class="hl-1"> = </span><span class="hl-2">extraData</span><span class="hl-1">.</span><span class="hl-2">translationY</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-4">onGestureState</span><span class="hl-1">(</span><span class="hl-2">args</span><span class="hl-1">: </span><span class="hl-6">GestureStateEventData</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-7">state</span><span class="hl-1">, </span><span class="hl-7">prevState</span><span class="hl-1">, </span><span class="hl-7">extraData</span><span class="hl-1">, </span><span class="hl-7">view</span><span class="hl-1"> } = </span><span class="hl-2">args</span><span class="hl-1">.</span><span class="hl-2">data</span><span class="hl-1">;</span><br/><span class="hl-1">    </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-3">&#39;onGestureState&#39;</span><span class="hl-1">, </span><span class="hl-2">state</span><span class="hl-1">, </span><span class="hl-2">prevState</span><span class="hl-1">, </span><span class="hl-2">view</span><span class="hl-1">, </span><span class="hl-2">extraData</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">manager</span><span class="hl-1"> = </span><span class="hl-2">Manager</span><span class="hl-1">.</span><span class="hl-4">getInstance</span><span class="hl-1">();</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">gestureHandler</span><span class="hl-1"> = </span><span class="hl-2">manager</span><span class="hl-1">.</span><span class="hl-4">createGestureHandler</span><span class="hl-1">(</span><span class="hl-2">HandlerType</span><span class="hl-1">.</span><span class="hl-7">PAN</span><span class="hl-1">, </span><span class="hl-8">10</span><span class="hl-1">, {</span><br/><span class="hl-1">    </span><span class="hl-2">shouldCancelWhenOutside:</span><span class="hl-1"> </span><span class="hl-5">false</span><br/><span class="hl-1">});</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-2">GestureHandlerTouchEvent</span><span class="hl-1">, </span><span class="hl-2">onGestureTouch</span><span class="hl-1">, </span><span class="hl-5">this</span><span class="hl-1">);</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">on</span><span class="hl-1">(</span><span class="hl-2">GestureHandlerStateEvent</span><span class="hl-1">, </span><span class="hl-2">onGestureState</span><span class="hl-1">, </span><span class="hl-5">this</span><span class="hl-1">);</span><br/><span class="hl-2">gestureHandler</span><span class="hl-1">.</span><span class="hl-4">attachToView</span><span class="hl-1">(</span><span class="hl-2">view</span><span class="hl-1">);</span>
 </code><button>Copy</button></pre>
 <p>Right now you must not forget to store the <code>gestureHandler</code> somewhere or the gesture won&#39;t work on iOS (native object being released). This will be fixed in future versions.</p>
 <p>Now about the API. All the gestures for the react counterpart exist with the same options and the same event <code>extraData</code>.</p>
@@ -82,12 +82,12 @@ <h1 align="center">@nativescript-community/gesturehandler</h1>
 In case you don&#39;t (drawer root view, modals, ...) then you can wrap your views in a <code>GestureRootView</code> which inherits <code>GridLayout</code></p>
 <p><a href="#md:overriding-nativescript-gestures"></a></p>
 <p><a href="#md:overriding-nativescript-gestures"></a></p>
-<a id="md:overriding-nativescript-gestures" class="tsd-anchor"></a><h2><a href="#md:overriding-nativescript-gestures">Overriding Nativescript gestures</a></h2><p>This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes <code>tap</code> and <code>longpress</code></p>
+<a id="md:overriding-nativescript-gestures" class="tsd-anchor"></a><h2><a href="#md:overriding-nativescript-gestures">Overriding Nativescript gestures</a></h2><p>This plugin can also override N gestures completely. This would give much more control over gestures and especially would allow to correctly handle simultaneous gestures likes <code>tap</code> and <code>longpress</code>.</p>
 <p>To do that </p>
 <p><a href="#md:credits"></a></p>
 <p><a href="#md:credits"></a></p>
 <a id="md:credits" class="tsd-anchor"></a><h2><a href="#md:credits">Credits</a></h2><p>This is a port of <a href="https://kmagiera.github.io/react-native-gesture-handler/">react-native-gesturehandler</a>.
-The source is based on the source code by <a href="https://github.com/kmagiera">Krzysztof Magiera</a>. Dont hesitate to go and thank him for his work!</p>
+The source is based on the source code by <a href="https://github.com/kmagiera">Krzysztof Magiera</a>. Don&#39;t hesitate to go and thank him for his work!</p>
 <a id="md:examples" class="tsd-anchor"></a><h3><a href="#md:examples">Examples:</a></h3><ul>
 <li><a href="demo-snippets/vue/Basic.vue">Basic</a><ul>
 <li>A basic example showing that overriding N gestures works, even in modals</li>

docs/assets/search.js

@@ -1,5 +1,5 @@
 {
-    "version": "2.0.28",
+    "version": "2.0.30",
     "$schema": "node_modules/@lerna-lite/cli/schemas/lerna-schema.json",
     "packages": [
         "packages/*"