npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

vue-recognizer

1.0.1 • Public • Published

vue-recognizer Build Status

Vue.js plugin to recognize touch, mouse, pointer events using Hammer.js.

Install

npm install --save vue-recognizer

Usage

Import vue-recognizer and install it.

import Vue from 'vue';
import VueRecognizer from 'vue-recognizer';
 
Vue.use(VueRecognizer);
<template>
  <div
    v-recognizer:pan="onPan"
    v-recognizer:pan.right="onPanRight"
  >
    Lorem ipsum
  </div>
</template>
 
<script lang="ts">
import Vue from 'vue';
 
export default Vue.extend({
  methods: {
    onPan(e: HammerInput) {...},
    onPanRight(e: HammerInput) {...}
  }
});
</script> 

As Nuxt plugin

Prepare plugin file to install this plugin as below. Then name it such as vue-recognizer.ts and put it into plugins folder.

import Vue from 'vue';
import VueRecognizer from 'vue-recognizer';
 
Vue.use(VueRecognizer);

To load it, configure nuxt.config.js or nuxt.config.ts as below.

const config = {
  plugins: [
    {
      src: '~/plugins/vue-recognizer.ts',
      ssr: false
    }
  ]
};
 
export default config;

API

Pan

  • v-recognizer:pan="onPan"
  • v-recognizer:pan.start="onPanStart"
  • v-recognizer:pan.move="onPanMove"
  • v-recognizer:pan.end="onPanEnd"
  • v-recognizer:pan.cancel="onPanCancel"
  • v-recognizer:pan.left="onPanLeft"
  • v-recognizer:pan.right="onPanRight"
  • v-recognizer:pan.up="onPanUp"
  • v-recognizer:pan.down="onPanDown"

Pinch

  • v-recognizer:pinch="onPinch"
  • v-recognizer:pinch.start="onPinchStart"
  • v-recognizer:pinch.move="onPinchMove"
  • v-recognizer:pinch.end="onPinchEnd"
  • v-recognizer:pinch.cancel="onPinchCancel"
  • v-recognizer:pinch.in="onPinchIn"
  • v-recognizer:pinch.out="onPinchOut"

Press

  • v-recognizer:press="onPress"
  • v-recognizer:press.up="onPressUp"

Rotate

  • v-recognizer:rotate="onRotate"
  • v-recognizer:rotate.start="onRotateStart"
  • v-recognizer:rotate.move="onRotateMove"
  • v-recognizer:rotate.end="onRotateEnd"
  • v-recognizer:rotate.cancel="onRotateCancel"

Swipe

  • v-recognizer:swipe="onSwipe"
  • v-recognizer:swipe.left="onSwipeLeft"
  • v-recognizer:swipe.right="onSwipeRight"
  • v-recognizer:swipe.up="onSwipeUp"
  • v-recognizer:swipe.down="onSwipeDown"

Tap

  • v-recognizer:tap="onTap"

License

MIT © Shogo Sensui

install

npm i vue-recognizer

Downloadsweekly downloads

1

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability