Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lenvonsam/vue2-touch

A directive wrapper Hammerjs for vue2.x
https://github.com/lenvonsam/vue2-touch

hammerjs vue2-touch vuejs

Last synced: 21 days ago
JSON representation

A directive wrapper Hammerjs for vue2.x

Awesome Lists containing this project

README

        

# vue2-touch for Vue.js 2.x

> This is a directive wrapper for Hammer.js 2.0, ~~small size(just 22.7k).

## Install

``` bash
# install dependencies
npm install vue2-touch --save
```

## Usage

### ES6

``` javascript
import Vue2Touch from 'vue2-touch'
Vue.use(Vue2Touch)
```

### Add global Config

``` javascript
Vue.use(Vue2Touch, {
gestures: ['swipe'],
directions: {
swipe: ['swipeleft']
}
})
```
above configurations mean that it can override v-touch gestures which just listens to swipe event and override swipe directions which only listens to swipeleft event.

### Using the v-touch directive

``` html
Tap me!

Swipe me!

```

### callback
Callback is a name of function with two args(can use any name, but type must be a funciton);the first argument can return a touch type(swipeleft,tap ...), and the second argument can return a callback event.

## More Details
See [Hammer.js document](http://hammerjs.github.io/)

## License
[MIT](https://opensource.org/licenses/MIT)