This repository has been archived by the owner on Mar 13, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19 from sbmaxx/readme
Added readme
- Loading branch information
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
## pointer-gestures | ||
Library which gesture events in a mobile-performant way. | ||
|
||
_In the next release, polymer-gestures will replace (the now deprecated) [PointerGestures](https://github.com/Polymer/PointerGestures), and [PointerEvents](https://github.com/Polymer/PointerEvents) will be removed from the default build._ | ||
|
||
Supported events: | ||
* down | ||
* up | ||
* Same target as down, provides the element under the pointer with the relatedTarget property | ||
* trackstart | ||
* track | ||
* Same target as down | ||
* trackend | ||
* Same target as down, provides the element under the pointer with the relatedTarget property | ||
* tap | ||
* Targets the nearest common ancestor of down and up.relatedTarget | ||
* Can be prevented by calling any gesture event's preventTap function | ||
|
||
Not yet implemented: | ||
* flick | ||
* hold | ||
* holdpulse | ||
* release | ||
* pinchstart | ||
* pinch | ||
* pinchend | ||
|
||
More info — https://groups.google.com/forum/#!topic/polymer-dev/ba4aDyOozm8 | ||
|
||
## How to build | ||
|
||
```bash | ||
mkdir gestures | ||
cd gestures | ||
git clone [email protected]:Polymer/tools.git | ||
git clone [email protected]:Polymer/polymer-gestures.git | ||
cd polymer-gestures | ||
npm install | ||
grunt | ||
``` | ||
|
||
## Hot to run | ||
```bash | ||
cd gestures | ||
python -m SimpleHTTPServer | ||
open http://localhost:8000/polymer-gestures/samples/simple/ | ||
``` | ||
More info — http://www.polymer-project.org/resources/tooling-strategy.html |