https://github.com/robinrodricks/vue3-touch-events
Simple touch events support for vue.js 3
https://github.com/robinrodricks/vue3-touch-events
Last synced: 7 months ago
JSON representation
Simple touch events support for vue.js 3
- Host: GitHub
- URL: https://github.com/robinrodricks/vue3-touch-events
- Owner: robinrodricks
- License: mit
- Created: 2021-04-30T08:23:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-31T17:36:45.000Z (9 months ago)
- Last Synced: 2025-04-06T17:03:25.933Z (7 months ago)
- Language: TypeScript
- Size: 1.36 MB
- Stars: 258
- Watchers: 2
- Forks: 31
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-vue-3 - vue3-touch-events - Enable tap / swipe / touch / hold / mouse down / mouse up events for HTML DOM elements (Packages)
README
# vue3-touch-events [](https://www.npmjs.com/package/vue3-touch-events) [](https://www.npmjs.com/package/vue3-touch-events)
**Enable tap, swipe, touch, hold, mouse down, mouse up events on any HTML DOM Element in vue.js 3.x.**
The easiest way to make your interactive vue.js content mobile-friendly. When you add `v-touch` events to your elements, it works on desktop and mobile using a fully declarative syntax. Unlike other libraries, you do not need to add any special code to your components to make this work. You simply have to register the library globally and it enables new events throughout your application.
Released under the permissive MIT License.
## What's New!
- [Cone swiping](#swipe) and [Zoom](#zoom) is new in version 5!
- We now support sending [drag](#drag-and-drop) events when users drag outside an object! (set `dragOutside: true`)
- If you encounter any issues with these, please file an issue!
## Features
- Declarative syntax for common touch events, such as [tap, hold](#touch-and-tap), [swipe](#swipe), [zoom](#zoom) and [drag](#drag-and-drop)
- Most events support desktop (mouse) and mobile devices (touch screen) with the same syntax
- Automatically add styling on hover and tap using `v-touch-class` directive
- Bind multiple touch events on one DOM element
- Customizable events with native-like events handler
- Customizable throttling for all events to control how often they are fired, and prevent crashing your application
- Global configuration that applies to all events in the application
- Ability to override global configuration on any element using `v-touch-options` directive
- Bindings for TypeScript included and also works in pure-JavaScript projects
Version:
> Note: This library is for **vue.js 3.x** only. For **vue.js 2.x** see the [older library](https://github.com/jerrybendy/vue-touch-events).
## Installation
To install:
| Package Manager | Command |
|-----------------|--------------------------------------------|
| npm | `npm install vue3-touch-events` |
| bun | `bun add vue3-touch-events` |
| yarn | `yarn add vue3-touch-events` |
Release notes are found in the [RELEASES.md](RELEASES.md) file.
### TypeScript
You need to register this plugin with vue.js in your main application file:
```js
import Vue from "vue";
import Vue3TouchEvents from "vue3-touch-events";
Vue.use(Vue3TouchEvents);
```
### TypeScript Vue 3.4+
You need to register this plugin with your vue.js app:
```js
import Vue3TouchEvents, {
type Vue3TouchEventsOptions,
} from "vue3-touch-events";
app.use(Vue3TouchEvents, {
disableClick: false
// any other global options...
})
```
Global options that can be added are [listed here](#global-configuration) and listed in each [feature section](#touch-and-tap).
### Nuxt 3+
Add the following to a file in plugins directory:
```ts
import Vue3TouchEvents from 'vue3-touch-events';
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.vueApp.use(Vue3TouchEvents)
});
```
Add `v-touch` events to any Nuxt component: (this is sample code only)
```ts
```
### JavaScript
You need to include the [UMD script](https://raw.githubusercontent.com/robinrodricks/vue3-touch-events/master/index.js) of this plugin and you do not need to register this plugin with vue.js.
```html
```
## Examples
In your `.vue` component files, use the `v-touch` directive add touch events to elements.
Specify the event using the first argument, for example `v-touch:tap` or `v-touch:swipe`.
```html
Tap Me
Tap Me
Swipe Here
Swipe Left Here
Long Tap Event
Press and Release Events
Triggered once when starting to move and tapTolerance is exceeded
Continuously triggered while dragging
Touch and hold on the screen for a while
Mix Multiple Events
Different options
Customize touch class
Customize touch class
Use multi-touch to zoom in
Use multi-touch to zoom out
```
## Usage
### Simple callback
If you simply want to execute a callback function on a `v-touch` event, use this pattern:
```html
Button
```
```js
methods: {
onTapItem(mouseEvent) { // you can remove the `mouseEvent` argument
console.log("Tapped!");
},
},
```
### Passing parameters to the event handler
If you want to add extra parameters to your `v-touch` event handler, you need to return a delegate in the event handler. You can pass as many attributes as you need.
```html
Button
```
```js
methods: {
onSwipeItem(item, i) {
return function (direction, mouseEvent) {
console.log("Swiped item ", i, ": ", item, " in direction ", direction);
};
},
},
```
## Touch and Tap
These events are provided by this library. **Most of these work on Desktop & Mobile.**
| Event | Behaviour |
| ---------------------------------------------------- | ------------------ |
| `v-touch`
`v-touch:tap` | **Desktop:** Triggered when the user clicks on the element (press and release).
**Mobile:** Triggered when the user taps on the element (tap and release) |
| `v-touch:longtap` | **Desktop:** Triggered when the user holds on the element for `longTapTimeInterval` MS and then releases it (press and release).
**Mobile:** Triggered when the user taps and holds on the element for `longTapTimeInterval` MS and then releases it (tap and release) |
| `v-touch:hold` | Triggered when the user holds the mouse button down for `touchHoldTolerance` MS while over the element (press and hold).
This will be triggered before your finger is released, similar to what native mobile apps do. |
| `v-touch:rollover` | **Desktop only:** Triggered when the user moves his mouse over the element.
This event is throttled to prevent too many events per second.
This event will fire every `rollOverFrequency` MS. |
### Tap Settings
These settings can be optionally specified in the [Global Config](#global-configuration) or [Object Config](#v-touch-options). If they are not specified, defaults are used.
| Setting | Units | Comment |
|------------------------|--------------|-------------------------------------------------------------------------|
| `touchHoldTolerance` | milliseconds | The timeout for a `hold` event. **Default:** `400` MS |
| `longTapTimeInterval` | milliseconds | The minimum time interval to detect whether long tap event effective or not. **Default:** `400` MS |
| `rollOverFrequency` | milliseconds | How often should `rollover` events be fired. **Default:** `100` MS (10 times a second) |
### System events
These are the default interactivity events supported by vue.js 3.x.
* You do not need to install this library to use them.
* They are always available for your usage alongside this library.
* The system default `mousemove` event is similar to `v-touch:rollover`, however the system event is not throttled and it will trigger hundreds of times per second, potentially crashing your application if any logic is performed in the event handler
**[Desktop devices](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent):**
- `v-on:click` - Triggered when the user presses and releases the element.
- `v-on:mousedown` - Triggered when the user presses the element.
- `v-on:mousemove` - Triggered when the user moves the mouse over the element.
- `v-on:mouseup` - Triggered when the user presses and releases the element.
- `v-on:mouseenter` - Triggered when the user moves his mouse into the element.
- `v-on:mouseleave` - Triggered when the user moves his mouse away from the element.
**[Mobile devices](https://developer.mozilla.org/en-US/docs/Web/API/Touch_events):**
- `v-on:touchstart` - Triggered when the user presses the element.
- `v-on:touchmove` - Triggered when the user presses and drags over the element.
- `v-on:touchcancel` - Triggered when the user presses the element, and releases outside the element, thereby cancelling his tap.
- `v-on:touchend` - Triggered when the user taps the element (press and release).
## Drag and Drop
These drag-and-drop events are provided by this library. **All these work on Desktop & Mobile.**
|
Event | Behaviour |
| ---------------------------------------- | ------------------ |
| `v-touch:press` | **Desktop:** Triggered when the user presses the element (mouse down).
**Mobile:** Triggered when the user taps the element without releasing. |
| `v-touch:drag.once` | Triggered when the user presses and drags the element.
Only fired once, the moment the user first drags on the element. |
| `v-touch:drag` | Triggered when the user presses and drags the element.
Fired every time the mouse moves while dragging the element.
This event is throttled to prevent too many events per second.
This event will fire every `dragFrequency` MS. Normally only fired when the mouse is **within** the element, but you can set `dragOutside` to fire it when the mouse is dragged **outside** the element too. |
| `v-touch:release` | **Desktop:** Triggered when the user releases the element (mouse up).
**Mobile:** Triggered when the user taps and releases the element. |
### Drag Settings
These settings can be optionally specified in the [Global Config](#global-configuration) or [Object Config](#v-touch-options). If they are not specified, defaults are used.
| Setting | Units | Comment |
|------------------|--------------|------------------------------------------------------------------------|
| `tapTolerance` | pixels | How many pixels the user must drag on the element for it to register as a `tap` event. **Default:** `10` pixels. |
| `dragFrequency` | milliseconds | How often should `drag` events be fired. **Default:** `10` MS (100 times a second). |
| `dragOutside` | boolean | If the `drag` event should be fired when the mouse is dragged outside the object as well. Useful to implement drag-and-drop behaviour when the object being moved is the same element you have added `v-touch` events on. **Default:** `false` |
## Swipe
These swiping events are provided by this library. **All these work on Desktop & Mobile.**
| Gesture | Event | Behaviour |
| ----------- | -------- | ------------------ |
|  | `v-touch:swipe` | Triggered when the user drags on the element (swipe).
It will detect the direction of the swipe and send it to your callback.
First argument of the callback must be `direction` attribute, which can be `left`, `right`, `top` or `bottom`.
Example callback: `onSwipe(direction){ ... }` |
|  | `v-touch:swipe.left` | Triggered when the user drags on the element within the left cone. |
|  | `v-touch:swipe.right` | Triggered when the user drags on the element within the right cone. |
|  | `v-touch:swipe.top` | Triggered when the user drags on the element within the top cone. |
| | `v-touch:swipe.bottom` | Triggered when the user drags on the element within the bottom cone. |
### Swipe Settings
These settings can be optionally specified in the [Global Config](#global-configuration) or [Object Config](#v-touch-options). If they are not specified, defaults are used.
| Setting | Units | Comment |
|------------------|--------------|------------------------------------------------------------------------|
| `swipeTolerance` | pixels | How many pixels the user must drag on the element for it to register as a `swipe` event. **Default:** `100` pixels. |
| `swipeConeSize` | number (0-1) | How wide should the "swipe cone" be. The wider the cone, the more off-axis gestures are considered as swipes. **Default:** `0.75` |
## Zoom
These zooming events are provided by this library. **These are mobile-only as they require multi-touch (at least 2 fingers) to trigger.**
| Gesture | Event | Behaviour |
| ----------- | -------- | ------------------ |
|  | `v-touch:zoom` | **Mobile only:** Triggered when the user presses 2 fingers down and moves them inward or outward. This event is continuously fired as the user is zooming.
First argument of the callback will recieve the zoom factor.
Example callback: `onZoom(zoomFactor){ ... }` |
|  | `v-touch:zoom.in` | **Mobile only:** Triggered when the user presses 2 fingers down and moves them towards each other (the normal "zoom in" gesture) |
|  | `v-touch:zoom.out` | **Mobile only:** Triggered when the user presses 2 fingers down and moves them away from each other (the normal "zoom out" gesture) |
### Zoom Settings
These settings can be optionally specified in the [Global Config](#global-configuration) or [Object Config](#v-touch-options). If they are not specified, defaults are used.
| Setting | Units | Comment |
|------------------|--------------|------------------------------------------------------------------------|
| `zoomFrequency` | milliseconds | How often should `zoom` / `zoom.in` / `zoom.out` events be fired. **Default:** `10` MS (100 times a second). |
| `zoomDistance` | pixels | How many pixels should the user move their fingers to trigger a `zoom` event. **Default:** `10` |
| `zoomInOutDistance` | pixels | How many pixels should the user move their fingers to trigger a `zoom.in` or `zoom.out` event. **Default:** `100` |
## Options
These additional directives can be added to each element.
### v-touch-options
`v-touch-options` directive allows you set a different configuration for a specified component. It will override global configurations.
### v-touch-class
`v-touch-class` directive allows you automatically add a class when the element is rolled over (desktop) or tapped (mobile). It overrides the class specified in the global config option `touchClass`.
- By default the `touchClass` is added when the element is pressed (`mousedown`), and removed when the element is released (`mouseup`).
- If desktop events are enabled (`disableClick: false`), then the `touchClass` is added on roll over (`mouseenter`) and roll out (`mouseleave`) as well.
- You can use this instead of `:active` and `:hover` pseudo classes, as it works on both desktop and mobile
Behaviour:
Device
Event name
Effect
Condition
Desktop only
Mouse enter (roll over)
`touchClass` added
desktop events must be enabled
Mouse leave (roll out)
`touchClass` removed
desktop events must be enabled
Mobile only
Mouse down (press)
`touchClass` added
Mouse up (release)
`touchClass` removed
For example:
```html
Tap Me
```
Now, when you press the element, it will add an extra `active` class automatically, and when you release the element the class will be removed.
So that you can use this feature to instead of `:active` and `:hover` pseudo class, for a better user experience.
```css
/* before */
span:active,
span:hover {
background: green;
}
/* now, you can write like this */
span.active {
background: green;
}
```
## Global configuration
```js
Vue.use(Vue3TouchEvents, {
disableClick: false, ...
});
```
General settings:
| Name | Units | Comment |
|----------------|----------|-------------------------------------------------------------------------------------------------------|
| `disableClick` | boolean | Whether to disable desktop events. **Default:** `false`.
Keep the default value or `false` if your application is used on desktop and mobile devices.
If your application is only for mobile use, set this to `true` to get a better user experience, because it can resolve some touch pass-through issues encountered on mobile devices. |
| `touchClass` | string | Which CSS class to add while an element is rolled over (desktop) or tapped (mobile). **Default:** `''`.
This is a global config, and you can use `v-touch-class` directive to override this setting for a single element. |
| `namespace` | string | Allows you to customize which Vue namespace this plugin uses. The default namespace is `touch` which adds the Vue directives: `touch`, `touch-class` and `touch-options`. Changing it to another value, for example `yolo`, would add the Vue directives: `yolo`, `yolo-class` and `yolo-options`. |
## Migration from Vue 2.x
Some events have been renamed from the vue 2.x version of this library, in order to expose a cleaner, more consistant and more descriptive naming scheme.
| Old event name | New event name |
| ---------------------------- | ------------------- |
| `v-touch:touchhold` | `v-touch:hold` |
| `v-touch:start` | `v-touch:press` |
| `v-touch:end` | `v-touch:release` |
| `v-touch:moved` | `v-touch:drag.once` |
| `v-touch:moving` | `v-touch:drag` |
## Building from Source
1. First install `bun` on your system. Node is not required.
2. Run these commands:
```
bun install
bun run build
```
## Credits
- Credits go to Jerry Bendy for creating the original project [vue2-touch-events](https://github.com/jerrybendy/vue-touch-events)
- Special thanks to Xavier Julien for creating the [Vue 3.x port](https://github.com/XjulI1/vue-touch-events/tree/migrate-to-vuejs-3)