@nativescript-community/gesturehandler 2.0.0 → 2.0.3

package/README.md

@@ -1,23 +1,66 @@
-[![npm](https://img.shields.io/npm/v/@nativescript-community/gesturehandler.svg)](https://www.npmjs.com/package/@nativescript-community/gesturehandler)
-[![npm](https://img.shields.io/npm/dt/@nativescript-community/gesturehandler.svg?label=npm%20downloads)](https://www.npmjs.com/package/@nativescript-community/gesturehandler)
-[![GitHub forks](https://img.shields.io/github/forks/nativescript-community/gesturehandler.svg)](https://github.com/nativescript-community/gesturehandler/network)
-[![GitHub stars](https://img.shields.io/github/stars/nativescript-community/gesturehandler.svg)](https://github.com/nativescript-community/gesturehandler/stargazers)
+<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
+<!--  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      DO NOT EDIT THIS READEME DIRECTLY! Edit "bluesprint.md" instead.
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<h1 align="center">@nativescript-community/gesturehandler</h1>
+<p align="center">
+		<a href="https://npmcharts.com/compare/@nativescript-community/gesturehandler?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/gesturehandler.svg" height="20"/></a>
+<a href="https://www.npmjs.com/package/@nativescript-community/gesturehandler"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/gesturehandler.svg" height="20"/></a>
+	</p>
 
+<p align="center">
+  <b>Declarative API exposing platform native touch and gesture system to NativeScript.</b></br>
+  <sub><sub>
+</p>
 
-## Installation
+<br />
 
-```shell
-tns plugin add @nativescript-community/gesturehandler
-```
 
-Be sure to run a new build after adding plugins to avoid any issues.
+
+[](#table-of-contents)
+
+## Table of Contents
 
----
+* [Installation](#installation)
+* [API](#api)
+			* [TypeScript](#typescript)
+* [GestureRootView](#gesturerootview)
+* [Overriding Nativescript gestures](#overriding-nativescript-gestures)
+* [Credits](#credits)
+	* [Examples:](#examples)
+* [Demos and Development](#demos-and-development)
+	* [Setup](#setup)
+	* [Build](#build)
+	* [Demos](#demos)
+* [Questions](#questions)
 
-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!
+
+[](#installation)
+
+## Installation
+Run the following command from the root of your project:
 
+`ns plugin add @nativescript-community/gesturehandler`
 
+
+[](#api)
+
 ## API
 
 We need to do some wiring when your app starts, so open `app.ts` and add this before creating any View/App/Frame:
@@ -54,3 +97,80 @@ Right now you must not forget to store the ```gestureHandler``` somewhere or the
 
 Now about the API. All the gestures for the react counterpart exist with the same options and the same event ```extraData```.
 
+
+[](#gesturerootview)
+
+## GestureRootView
+
+For the gestures to work correctly we need a `root` view which knows how to handle the gestures.
+If using `Page` (thus `Frame`) you don't need to do anything.
+In case you don't (drawer root view, modals, ...) then you can wrap your views in a `GestureRootView` which inherits `GridLayout`
+
+
+[](#overriding-nativescript-gestures)
+
+## 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`
+
+To do that 
+
+
+[](#credits)
+
+## 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!
+
+
+
+### Examples:
+
+- [Basic](demo-snippets/vue/Basic.vue)
+  - A basic example showing that overriding N gestures works, even in modals
+
+
+[](#demos-and-development)
+
+## Demos and Development
+
+
+### Setup
+
+To run the demos, you must clone this repo **recursively**.
+
+```
+git clone https://github.com/@nativescript-community/gesturehandler.git --recursive
+```
+
+**Install Dependencies:**
+```bash
+npm i # or 'yarn install' or 'pnpm install'
+```
+
+**Interactive Menu:**
+
+To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
+
+### Build
+
+```bash
+npm run build
+
+npm run build.angular # or for Angular
+```
+
+### Demos
+
+```bash
+npm run demo.[ng|react|svelte|vue].[ios|android]
+
+npm run demo.svelte.ios # Example
+```
+
+[](#questions)
+
+## Questions
+
+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).

package/gesturehandler.android.d.ts

@@ -0,0 +1,180 @@
+import { View } from '@nativescript/core';
+import { HandlerOptions, LongPressGestureHandlerOptions, NativeViewGestureHandlerOptions, PanGestureHandlerOptions, PinchGestureHandlerOptions, RotationGestureHandlerOptions, TapGestureHandlerOptions } from './gesturehandler';
+import { BaseGestureRootView, BaseNative, GestureHandlerStateEvent, GestureHandlerTouchEvent, GestureState, GestureStateEventData, GestureTouchEventData, HandlerType, ManagerBase, OptionsTypeMap, TypeMap, ViewDisposeEvent, ViewInitEvent } from './gesturehandler.common';
+export { GestureState, GestureHandlerStateEvent, GestureHandlerTouchEvent, GestureStateEventData, GestureTouchEventData, HandlerType, ViewInitEvent, ViewDisposeEvent };
+export declare class GestureRootView extends BaseGestureRootView {
+    createNativeView(): com.nativescript.gesturehandler.PageLayout;
+    initNativeView(): void;
+    disposeNativeView(): void;
+    get registry(): any;
+}
+export declare function install(overrideNGestures?: boolean): void;
+export declare abstract class Handler<T extends com.swmansion.gesturehandler.GestureHandler<any>, U extends HandlerOptions> extends BaseNative<T, U> {
+    hitSlop: any;
+    enabled: boolean;
+    shouldCancelWhenOutside: boolean;
+    shouldStartGesture: (arg: any) => boolean;
+    manager: WeakRef<Manager>;
+    touchListener: com.swmansion.gesturehandler.OnTouchEventListener<T>;
+    nativeGetterKey: string;
+    getExtraData(handler: T): {
+        positions: any[];
+        numberOfPointers: number;
+    };
+    initNativeView(native: T, options: U): void;
+    disposeNativeView(): void;
+    handleShouldStartGesture(handler: T, event: android.view.MotionEvent): boolean;
+    onTouchEvent(handler: T, event: android.view.MotionEvent): void;
+    onStateChange(handler: T, state: number, prevState: number): void;
+    tag: number;
+    attachedView: View;
+    setTag(tag: number): void;
+    getTag(): number;
+    getView(): globalAndroid.view.View;
+    cancel(): void;
+    attachToView(view: View): void;
+    detachFromView(view?: View): void;
+}
+export declare class TapGestureHandler extends Handler<com.swmansion.gesturehandler.TapGestureHandler, TapGestureHandlerOptions> {
+    numberOfTaps: number;
+    maxDurationMs: number;
+    maxDelayMs: number;
+    maxDeltaX: number;
+    maxDeltaY: number;
+    maxDist: number;
+    minPointers: number;
+    createNative(options: any): com.swmansion.gesturehandler.TapGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.TapGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        x: number;
+        y: number;
+        absoluteX: number;
+        absoluteY: number;
+    };
+}
+export declare class PanGestureHandler extends Handler<com.swmansion.gesturehandler.PanGestureHandler, PanGestureHandlerOptions> {
+    minDist: number;
+    activeOffsetXStart: number;
+    activeOffsetXEnd: number;
+    failOffsetXStart: number;
+    failOffsetXEnd: number;
+    activeOffsetYStart: number;
+    activeOffsetYEnd: number;
+    failOffsetYStart: number;
+    failOffsetYEnd: number;
+    minVelocity: number;
+    minVelocityX: number;
+    minVelocityY: number;
+    minPointers: number;
+    maxPointers: number;
+    avgTouches: number;
+    numberOfPointers: number;
+    createNative(options: any): com.swmansion.gesturehandler.PanGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.PanGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        x: number;
+        y: number;
+        absoluteX: number;
+        absoluteY: number;
+        translationX: number;
+        translationY: number;
+        velocityX: number;
+        velocityY: number;
+    };
+}
+export declare class PinchGestureHandler extends Handler<com.swmansion.gesturehandler.PinchGestureHandler, PinchGestureHandlerOptions> {
+    minSpan: number;
+    createNative(options: any): com.swmansion.gesturehandler.PinchGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.PinchGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        x: number;
+        y: number;
+        absoluteX: number;
+        absoluteY: number;
+        scale: number;
+        focalX: number;
+        focalY: number;
+        velocity: number;
+    };
+}
+export declare enum FlingDirection {
+    DIRECTION_LEFT,
+    DIRECTION_UP,
+    DIRECTION_DOWN,
+    DIRECTION_RIGHT
+}
+export declare class FlingGestureHandler extends Handler<com.swmansion.gesturehandler.FlingGestureHandler, TapGestureHandlerOptions> {
+    numberOfPointers: number;
+    direction: number;
+    createNative(options: any): com.swmansion.gesturehandler.FlingGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.FlingGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        direction: string;
+    };
+}
+export declare class LongPressGestureHandler extends Handler<com.swmansion.gesturehandler.LongPressGestureHandler, LongPressGestureHandlerOptions> {
+    minDurationMs: number;
+    maxDist: number;
+    createNative(options: any): com.swmansion.gesturehandler.LongPressGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.LongPressGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        x: number;
+        y: number;
+        absoluteX: number;
+        absoluteY: number;
+    };
+}
+export declare class RotationGestureHandler extends Handler<com.swmansion.gesturehandler.RotationGestureHandler, RotationGestureHandlerOptions> {
+    createNative(options: any): com.swmansion.gesturehandler.RotationGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.RotationGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        x: number;
+        y: number;
+        absoluteX: number;
+        absoluteY: number;
+        rotation: number;
+        anchorX: number;
+        anchorY: number;
+        velocity: number;
+    };
+}
+export declare class NativeViewGestureHandler extends Handler<com.swmansion.gesturehandler.NativeViewGestureHandler, NativeViewGestureHandlerOptions> {
+    shouldActivateOnStart: boolean;
+    disallowInterruption: boolean;
+    createNative(options: any): com.swmansion.gesturehandler.NativeViewGestureHandler;
+    getExtraData(handler: com.swmansion.gesturehandler.NativeViewGestureHandler): {
+        positions: any[];
+        numberOfPointers: number;
+    } & {
+        pointerInside: boolean;
+    };
+}
+export declare class Manager extends ManagerBase {
+    _interactionManager: com.nativescript.gesturehandler.GestureHandlerInteractionController;
+    configureInteractions<T extends com.swmansion.gesturehandler.GestureHandler<any>, U extends HandlerOptions>(handler: Handler<T, U>, options?: U): void;
+    get interactionManager(): com.nativescript.gesturehandler.GestureHandlerInteractionController;
+    static sManager: Manager;
+    static getInstance(): Manager;
+    createGestureHandler<T extends HandlerType>(handlerName: T, handlerTag: number, config?: OptionsTypeMap[T]): TypeMap[T];
+    findRegistry(view: View): com.swmansion.gesturehandler.GestureHandlerRegistryImpl;
+    attachGestureHandlerToView<T extends com.swmansion.gesturehandler.GestureHandler<any> = com.swmansion.gesturehandler.GestureHandler<any>>(handler: Handler<T, any>, view: View): void;
+    detachGestureHandlerFromView<T extends com.swmansion.gesturehandler.GestureHandler<any> = com.swmansion.gesturehandler.GestureHandler<any>>(handler: Handler<T, any>, view: View): void;
+    viewListeners: Map<View, Map<number, {
+        init: () => void;
+        dispose: () => void;
+    }>>;
+    attachGestureHandler<T extends com.swmansion.gesturehandler.GestureHandler<any> = com.swmansion.gesturehandler.GestureHandler<any>>(handler: Handler<T, any>, view: View): void;
+    detachGestureHandler<T extends com.swmansion.gesturehandler.GestureHandler<any> = com.swmansion.gesturehandler.GestureHandler<any>>(handler: Handler<T, any>, view: View): void;
+}