gesture-helper - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

demo/demo.js

@@ -5,7 +5,8 @@ import GestureHelper from '../src/gesture-helper.js';
 const gestureCtrl = new GestureHelper(document.body, {
+  sensitivity: 5,
   passive: false,
-  capture: true,
-  blockOppositeScroll: false,
+  capture: false,
+  swipeVelocity: 0.7,
   maxTapDuration: 300,
-  sensitivity: 5,
+  // longTapDuration: 500, // coming soon
 });
@@ -19,4 +20,4 @@
 
-gestureCtrl.on('pan.all', handleAll);
-// gestureCtrl.on('pan.**', handler);
+// gestureCtrl.on('pan.all', handleAll);
+gestureCtrl.on('pan', handler);
 // gestureCtrl.on('pan.y.**', handler);
@@ -28,8 +29,11 @@
 
-// gestureCtrl.on('pan.end', function(ev) {
-//   console.log('pan.end', ev);
-// });
+gestureCtrl.on('pan.end', function(ev) {
+  console.log('pan.end', ev);
+  demoOutput.innerHTML = JSON.stringify(ev);
+  clear();
+});
 
 function handleAll(ev) {
-  console.log('pan.all', ev);
+  console.log(this.event, ev);
+  demoOutput.innerHTML = JSON.stringify(ev);
 }
@@ -39,2 +43,3 @@
   console.log(this.event, ev);
+  demoOutput.innerHTML = JSON.stringify(ev);
 }
@@ -46,2 +51,2 @@
   // gestureCtrl.off('pan.both', handleBoth);
-}, 1000);
+}, 1000);

package.json

 {
   "name": "gesture-helper",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "a *tiny* touch & mouse library to help make tracking touch interactions more simple.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

 # gesture-helper
 a **tiny** touch & mouse library to help make tracking touch interactions more simple.
 
-***note:** This lib currently only supports horizontal movement. If/when it detects up and down movement (at gesture start), it stands down so that the browser can scroll, as per usual.
+Gesture helper extends https://github.com/asyncly/EventEmitter2, and returns an event emitter.
+Events can be name spaced, per EventEmitter2. This means that you can bind to the following events:
+```
+tap
+pan.**
+pan.start
+pan.end
+pan.y.up
+pan.y.down
+pan.y.**
+pan.x.left
+pan.x.right
+pan.x.**
+```
+In the interest of keeping the library small, versatile and uncomplicated, all source touch/mouse events are returned inside EE2 event payloads ```{ sourceEvent: e }```.
+This allows you to add preventDefault() and other native event functionality as you need it.
 
@@ -11,7 +26,3 @@ # install:
 ```
-let gestureControl = new GestureHelper(document.querySelector('.el'), {
-  onPanStart: () => {},
-  onPan: (e) => {},
-  onPanEnd: (e) => {},
-});
+const gestureControl = new GestureHelper(document.querySelector('.el'), { ...options });
 ```
@@ -21,5 +32,8 @@
 ```
+  passive: false,
+  capture: false,
   sensitivity: Number(5), // Integer: Px's movement to allow before capturing pan event
   swipeVelocity: Float(0.7), // Float: Velocity threshold range for varied swipe detection
+  maxTapDuration: Number(300), // Integer: Milliseconds of finger being on the screen before a tap event is ignored
 ```
 

No alert changes

Improved metrics

Total package byte prevSize

70984

increased by0.91%

Lines of code

1719

increased by0.35%

Number of lines in readme file

38

increased by58.33%

No dependency changes