Home

Awesome

any-touch NPM Version NPM Downloads size-image codecov CircleCI

gestures

Language

δΈ­ζ–‡ | English

Demo

<details> <summary>QR Code</summary> <img src="https://user-images.githubusercontent.com/8264787/104836031-a55ca780-58e5-11eb-936a-7e2d1a05ee86.png" /> </details>

Simple

any-scroll

Install

npm i -S any-touch

CDN

<script src="https://unpkg.com/any-touch/dist/any-touch.umd.min.js"></script>
<script>
    console.log(AnyTouch.version); // 2.x.x
</script>

Directory

⚑ Get Started

🌱 Vue & Directives

πŸ€ WeChat applet

πŸ“ Load on demand

🌈 Advanced

:bulb: API

🍳 Q & A

Get Started

import AnyTouch from 'any-touch';

// monitored element
const el = document.getElementById('box');

// Start monitoring gesture changes on el
const at = new AnyTouch(el);

// The pan event fires when dragging
at.on('pan', (e) => {
    // e contains information such as displacement/velocity/direction
    console.log(e);
});

The pan here is called gesture event. e is the event object, which contains data such as "position/speed/zoom/angle",

πŸ‘‹Gesture

Each state of the gesture corresponds to an event.

<table> <tr> <th><b>Gesture</th> <th>Name</th> <th>Describe</th> </tr> <tr> <td rowspan="5">pan</td> <td>pan</td> <td>Triggered continuously while dragging</td> </tr> <tr> <td>panstart</td> <td>drag to start</td> </tr> <tr> <td>panmove</td> <td>dragging</td> </tr> <tr> <td>panstart</td> <td>Drag to stop (off screen)</td> </tr> <tr> <td>panup / pandown / panright / panleft</td> <td>Drag events in different directions</td> </tr> <tr> <td rowspan="2">press</td> <td>press</td> <td>Press</td> </tr> <tr> <td>press</td> <td>Press release (off screen)</td> </tr> <tr> <td>tap</td> <td>tap</td> <td>Click, No problem with 300ms delay</td> </tr> <tr> <td rowspan="2">swipe</td> <td>swipe</td> <td>Swipe</td> </tr> <tr> <td> swipeup / swipedown / swiperight / swipeleft</td> <td>Swipe in different directions</td> </tr> <tr> <td rowspan="6">pinch</td> <td>pinch</td> <td>Zoom</td> </tr> <tr> <td> pinchstart </td> <td>Zoom start</td> </tr> <tr> <td> pinchmove </td> <td>Zooming</td> </tr> <tr> <td> pinchend </td> <td>Zoom ends (off screen)</td> </tr> <tr> <td> pinchin </td> <td>Zoom in</td> </tr> <tr> <td> pinchout </td> <td>Zoom out</td> </tr> <tr> <td rowspan="6">rotate</td> <td>rotate</td> <td>Rotating, include rotatestart and rotatemove and rotateend </td> </tr> <tr> <td> rotatestart </td> <td>Start of rotation</td> </tr> <tr> <td> rotatemove </td> <td>Rotating</td> </tr> <tr> <td> rotateend </td> <td>End of rotation (off screen)</td> </tr> </table>

Combining events

You can listen to multiple events through the array, such as listening to panleft and panright at the same time, so that you can listen to "x-axis dragging".

at.on(['panleft', 'panright'], () => {
    console.log('Drag on the x-axis');
});

:rocket: back to directory

🍭 Event

When the event is triggered, data such as "position/speed/zoom/angle" can be obtained.

at.on('pan', (event) => {
    // event contains data such as speed/direction
});

event

nametypedescribe
nameStringGesture recognizer name, such as: pan/tap/swipe, etc.
typeStringEvent name, such as tap or panstart, etc., is larger than the name field, such as: when the type is panstart or panmove, and the name returns pan
phaseStringCurrent touch state: start / move / end / cancel Corresponding: first touch / move on the screen / leave the screen / abnormally leave the "can anyTouch" element
xNumberCurrent contact center x coordinate
yNumberCurrent contact center y coordinate
deltaXNumberThe x-axis offset distance of the current contact and the previous contact
deltaYNumberThe y-axis offset distance of the current contact and the previous contact
displacementXNumberThe x displacement of the current contact and the starting contact (vector)
displacementYNumberThe y displacement of the current contact and the starting contact (vector)
distanceXNumberabsolute value of displacementX
distanceYNumberabsolute value of displacementY
distanceNumberThe distance between the current contact and the starting contact (scalar)
deltaTimeNumberThe difference between the current time and the initial touch time
velocityXNumberThe moving speed of the contact on the X axis
velocityYNumberThe moving speed of the contact on the Y axis
directionNumberThe direction of the front contact and the current contact can be understood as the instantaneous direction
angleNumberWhen multi-touch, the rotation angle between the starting contact and the current contact
deltaAngleNumberWhen multi-touch, the rotation angle between the front contact and the current contact
scaleNumberWhen multi-touch, the zoom ratio of the starting touch point and the current touch point
deltaScaleNumberWhen multi-touch, the zoom ratio between the previous touch point and the current touch point
maxPointLengthNumberThe maximum number of contacts that have occurred in the current identification cycle
isStartBooleanWhether the current recognition cycle starts, the rule is that it is a cycle from touchstart->touchend, even if there is a multi-touch, if a point leaves, the current round of recognition ends
isEndBooleanWhether the current recognition cycle is over
targetEventTargetThe element to which the event is bound
targetsEventTarget[]For multiple touches, each target in touches will be stored
currentTargetEventTargetThe element that actually triggered the bound event
nativeEventTouchEventnative event object

:rocket: back to directory

Typescript

If the event function is bound in the vue template, the type of the event object cannot be deduced, so we need to manually annotate it ourselves.

<div @tap="onTap"></div>
// xxx.vue
import type { AnyTouchEvent } from 'any-touch';
function onTap(e: AnyTouchEvent) {
    // It can be correctly deduced that there is an x attribute on e
    console.log(e.x);
}

:rocket: back to directory