Panning Touch/Mouse Action
Quasar offers full-featured Vue directives that can totally replace libraries like Hammerjs: v-touch-pan
, v-touch-swipe
and v-touch-hold
.
These directives also work with mouse events, not only touch events, so you are able to build cool functionality for your App on desktops too.
We will be describing v-touch-pan
on the lines below.
Basic Usage
<div v-touch-pan="handler">...</div> |
Handler Parameter
The handler
function/method will be called by the directive when a pan
touch (or with mouse) action is taking place (any change in touch position triggers a call) on the DOM element and it receives the following parameter:{
evt, // JS Native Event
position, // {top, left} Position in pixels
// where the user's finger is currently at
direction, // "left", "right", "up" or "down"
duration, // Number in ms since "pan" started
distance, // {x, y} Distance in pixels covered by panning
// on horizontal and vertical
delta, // {x, y} Distance in pixels since last called handler
isFirst, // Boolean; Has panning just been started?
isFinal // Boolean; Is panning over?
}
// example:
handler (obj) {
console.log(obj.direction) // "right"
console.log(obj.duration) // 78
console.log(obj.distance.x) // 273
}
Modifiers
Use horizontal
or vertical
when you only want to capture horizontal or vertical swipes.<div v-touch-pan.horizontal="userSwiped">...</div>
Directive allows vertical scroll when capturing only horizontal panning.
When you don’t want to capture mouse actions too, use the nomouse
modifier:<!--
directive won't be triggered by mouse actions;
it's exclusively triggered by touch actions now:
-->
<div v-touch-pan.nomouse="userHasSwiped">...</div>