npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, πŸ‘‹, I’m Ryan HefnerΒ  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you πŸ™

Β© 2024 – Pkg Stats / Ryan Hefner

web-gesture-events

v0.1.0

Published

A library that brings high-level asynchronous gesture events to the web by extending the standard addEventListener interface. β˜πŸΎπŸ“±

Downloads

74

Readme

Web Gesture Events

A library that brings high-level asynchronous gesture events to the web by extending the standard addEventListener interface. β˜πŸΎπŸ“±

Demo

version downloads license

Table of Contents

Installation

npm install web-gesture-events

Usage

Basic

Add event listeners as you would using the addEventListener interface. The GestureEvent interface passed as the argument to all gesture events is an extension of the TouchEvent interface. Which means all the properties you are used to are the same with the addition of a few properties. Rotation and Scale on iOS have been overwritten since they are not considered standard

...
import 'web-gesture-events'; // top level import only side-effects
...

import {SwipeEvent} from 'web-gesture-events';

window.addEventListener('swipe', (ev) => {
    console.log(ev.direction, ev.velocity); // direction and instantaneous velocity
}

Config Options

Config options can be set on the global GestureProvider interface available on the window or by specifying a data-attribute on a DOM element.

window.gestureProvider.config.minPointers = 2;
// OR
<div data-minpointers="2"></div>

API Documentation

Gesture Provider Config

| Property | Type | Description | | ------ | ------ | ------ | | minPointers | number | Minimum number of touch points necessary before events are fired. | | longPressDuration | number | Minimum duration in milliseconds for a touch to be persisted to fire a single LongPressEvent. | | tapDelay | number | Maximum time in milliseconds that can pass between taps. | | numberOfTaps | number | Number of taps required before tap events are fired. |

Config Attributes

Data- prefixed attributes recognised on DOM elements. | Property | Type | Description | | ------ | ------ | ------ | | data-minpointers | string | Minimum number of touch points necessary before events are fired. | | data-longpressduration | string | Minimum duration in milliseconds for a touch to be persisted to fire a single LongPressEvent. | | data-tapdelay | string | Maximum time in milliseconds that can pass between taps. | | data-numberoftaps | string | Number of taps required before tap events are fired. |

GestureEvent

| Property | Type | Description | | ------ | ------ | ------ | | gestureTarget | EventTarget | The element that the primary pointer TouchStart event targeted. | | x | number | Horizontal position of the primary pointer relative to the viewport. | | y | number | Vertical position of the primary pointer relative to the viewport. |

LongPressEvent

| Property | Type | Description | | ------ | ------ | ------ | | duration | number | Duration of the long press event. |

SwipeEvent

| Property | Type | Description | | ------ | ------ | ------ | | types | "swipestart", "swipe", "swipeend" | Events fired over the lifecycle of a swipe. | | velocity | number | Instantaneous velocity of user swipe. In case of swipeend velocity equals average velocity of swipe. | | direction | "up", "down", "left" or "right" | Direction of the user swipe relative to the gesture origin. |

PanEvent

| Property | Type | Description | | ------ | ------ | ------ | | types | "panstart", "pan", "panend" | Events fired over the lifecycle of a pan. | | velocity | number | Instantaneous velocity of user pan. In case of panend velocity equals average velocity of swipe. | | translation | Translation | Object that contains x and y movements of user gesture relative to gesture origin and viewport. |

RotateEvent

| Property | Type | Description | | ------ | ------ | ------ | | types | "rotatestart", "rotate", "rotateend" | Events fired over the lifecycle of a rotation. | | rotation | number | Rotation about the anchor (primary pointer) in radians. | | rotationDeg | number | Rotation about the anchor (primary pointer) in degrees. | | anchor | Anchor | Object that contains x and y positions of rotation anchor point relative to gesture origin and viewport. |

PinchEvent

| Property | Type | Description | | ------ | ------ | ------ | | types | "pinchstart", "pinch", "pinchend" | Events fired over the lifecycle of a pinch. | | scale | number | Scale factor relative to primary and secondary touch points' distance. |

Remarks

There are a few potential drawbacks I haven't been able to overcome. For example the data-attribute config options might not work if a gesture event listener uses bubbling. Also even though these gesture events are asynchronous there is still the problem that the browser currently does not offer a way to query if event listeners exist on an element anywhere in the DOM tree. Meaning events are always fired regardless of if an event listener was detected or not. Also these events are not trusted events so do bare that in mind whenever using these events to accomplish things that require user interaction such as toggling fullscreen or resuming an audio context.

Credits

  1. React Native Gesture Handler
  2. Introduction to events
  3. Touch Events