Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.33 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.33 KB
Raw

🖐️ prosthetic-hand 🖐️

A JavaScript library to emulate mouse/touch/pointer events, designed to help unit-test touch gestures.

Installation

npm install prosthetic-hand

Usage

import Hand from 'prosthetic-hand';

const hand = new Hand();
const finger = hand.growFinger('pointer', { pointerType: 'touch', pressure: 0.9 });

finger
  .wait(500)
  .moveTo(200, 250, 0)
  .down()
  .moveBy(100, 150, 2000)
  .up();

For more information see the API documentation and demos.

Testing

Run npm install and npm start, then open the URL printed in the console in your preferred browser.

Building the documentation

Run npm run build-docs and open the api-docs.html file generated by it.

Contributing code

Read the Leaflet guidelines. Whenever making a bugfix or a new feature, notify IvanSanchez so that a new version can be published to NPM.

Legalese

"THE BEER-WARE LICENSE":

[email protected] wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return.