Vue 2 Directive For Binding Hotkeys To Components

V-Hotkey Vue 2.x directive for binding hotkeys to components.

vue hotkeys, v hotkey, vue 3 hotkeys, ng keyboard shortcuts, vue hotkeys demo

Event Handler

• keydown (as default)
• keyup

Key Combination

Use one or more of following keys to fire your hotkeys.

• ctrl
• alt
• shift
• command (MacOS)
• windows (Windows)

How to make use of it:

Install

$ npm i v-hotkey
# or
$ yarn add v-hotkey

Usage

import Vue from 'vue'
import VueHotkey from 'v-hotkey'

Vue.use(VueHotkey)

<template>
  <span v-hotkey="keymap" v-show="show"> 
    Press `ctrl + esc` to toggle me! Hold `enter` to hide me!
  </span>
</template>

<script>
export default {
  data () {
    return {
      show: true
    }
  },
  methods: {
    toggle () {
      this.show = !this.show
    },
    show () {
      this.show = true
    },
    hide () {
      this.show = false
    }
  },
  computed: {
    keymap () {
      return {
        // 'esc+ctrl' is OK.
        'ctrl+esc': this.toggle,
        'enter': {
          keydown: this.hide,
          keyup: this.show
        }
      }
    }
  }
}
</script>

v-hotkey directive Plugin/Github

See Demo And Download

Official Website(Dafrok): Click Here

This superior jQuery/javascript plugin is developed by Dafrok. For extra Advanced Usages, please go to the official website.

Tags: Dafrokdirectivehotkeysv-hotkeyvuevue hotkeysvue-componentvuejs