Skip to content

Latest commit

 

History

History
143 lines (89 loc) · 3.72 KB

README.md

File metadata and controls

143 lines (89 loc) · 3.72 KB

vue-touch-events

Enable tap / swipe events for VueJS 2.x

Note: This is for Vue 2.x only.

Install

To install with npm or yarn, use

npm i -S vue2-touch-events

// or

yarn add vue2-touch-events

Usage

import Vue from 'vue'
import Vue2TouchEvents from 'vue2-touch-events'

Vue.use(Vue2TouchEvents)

In your .vue file:

<!-- bind a tap event -->
<span v-touch:tap="touchHandler">Tap Me</span>

<!-- tap is the default event, you can omit it -->
<span v-touch="touchHandler">Tap Me</span>

<!-- bind the swipe event, no matter direction -->
<span v-touch:swipe="swipeHandler">Swipe Here</span>

<!-- only when swipe left can trigger the callback -->
<span v-touch:swipe.left="swipeHandler">Swipe Here</span>

APIs

Global config (optional)

Vue.use(Vue2TouchEvents, {
    disableClick: false,
    touchClass: '',
    tapTolerance: 10,
    swipeTolerance: 30,
})

  • disableClick default false. Use touch event only, will not trigger click event.

    You should keep this value default if you use your website on both mobile and PC.

    If your website use on mobile only, it's a good choice to set this value true to get a better user experience, and it can resolve some touch pass-through issue.

  • touchClass default: ''. Add an extra CSS class when touch start, and remove it when touch end.

    If disableClick is false, it will bind mouseenter and mouseleave event on your components too. So you can use it instead of :hover and :active.

    This is a global config, and you can use v-touch-class directive to overwrite this setting in a single component.

  • tapTolerance default 10. The tolerance to ensure whether the tap event effective or not.

  • swipeTolerance default 30. The tolerance to ensure whether the swipe event effective or not.

If you don't want bind click event at same time, just set disableClick to true.

Directives

v-touch

Bind the v-touch directive to components which you want enable touch events.

v-touch accepts an argument to tell it which event you want to bind. tap and swipe are available.

The first argument of the v-swipe callback is the direction of swipe event. It could be left, right, top or bottom.

v-swipe can accept extra modifiers. It means you can bind events only for specify direction.

export default {
    methods: {
        swipeHandler (direction) {
            console.log(direction)  // May be left / right / top / bottom
        }
    }
}

v-touch-class

v-touch-class directive allows you set an extra class on your components. If you already have a global config touchClass, this value will overwrite it.

For example:

<span v-touch:tap="touchHandler" v-touch-class="'active'">Tap Me</span>

Now, when you start to touch, it will add an extra active class automatically. And remove it when touch end.

If your setting of disableClick is false (it's default), it will bind mouseenter and mouseleave events, too.

So that you can use this feature to instead of :active and :hover pseudo class, for a better user experience.

/* before */
span:active, span:hover {
  background: green;
}

/* now, you can write like this */
span.active {
  background: green;
}

Modifiers

left, right, top, bottom

This four modifiers are for v-touch:swipe only, to specify which direction you want to bind events to.

self

Same to v-on:click.self, only trigger events when the event target same to itself.

Change History

Look at here

LICENSE

MIT License