Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs(ngTouch): Document event parameter for $swipe handlers #12149

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/ngTouch/swipe.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ ngTouch.factory('$swipe', [function() {
* `$swipe` will listen for `mouse` and `touch` events.
*
* The four events are `start`, `move`, `end`, and `cancel`. `start`, `move`, and `end`
* receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }`.
* receive as a parameter a coordinates object of the form `{ x: 150, y: 310 }` and the raw
* event. `cancel` receives the raw event as it's single parameter.
*
* `start` is called on either `mousedown` or `touchstart`. After this event, `$swipe` is
* watching for `touchmove` or `mousemove` events. These events are ignored until the total
Expand Down