Quasar offers full-featured Vue directives that can totally replace libraries like Hammerjs: v-touch-pan
, v-touch-swipe
, v-touch-hold
and even v-touch-repeat
.
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.
Usage
Click then pan in a direction with your mouse on the area below to see it in action. Page scrolling is prevented, but you can opt out if you wish.
TIP
If your content also has images, you might want to add draggable="false"
to them, otherwise the native browser behavior might interfere in a negative way.
Panning works both with a mouse or a native touch action. You can also capture pan to certain directions (any) only as you’ll see below.
Example on capturing only horizontal panning. Notice that on touch capable devices the scrolling is automatically not blocked, since we are only capturing horizontally.
Example on capturing only vertically panning. Page scrolling is prevented, but you can opt out if you wish.
Example on capturing panning on custom directions. For this, use modifiers: up
, down
, left
, right
. Page scrolling is prevented, but you can opt out if you wish.
Handling Mouse Events
When you want to handle mouse events too, use the mouse
modifier:
<!--
directive will also be triggered by mouse actions
-->
<div v-touch-pan.mouse="userHasPanned">...</div>
Preventing Scroll (on touch capable devices)
By default, the directive does not block page scrolling. If you want to prevent scrolling, then use the prevent
modifier.
<div v-touch-pan.prevent="userHasPanned">...</div>
Inhibiting TouchPan
When you want to inhibit TouchPan, you can do so by stopping propagation of the touchstart
/ mousedown
events from the inner content:
<div v-touch-pan.mouse="userHasHold">
<!-- ...content -->
<div @touchstart.stop @mousedown.stop>
<!--
TouchPan will not apply here because
we are calling stopPropagation() on touchstart
and mousedown events
-->
</div>
<!-- ...content -->
</div>
However, if you are using capture
or mouseCapture
modifiers then events will first reach the TouchPan directive then the inner content, so TouchPan will still trigger.
Example with FAB
Below is a nice example on using TouchPan on a QFab. You can drag it across the screen.
Note on HMR
Due to performance reasons, not all of the modifiers are reactive. Some require a window/page/component refresh to get updated. Please check the API card for the modifiers which are not marked as reactive.