v-hotkey

Vue 2.x directive for binding hotkeys to components.

Play with me

https://dafrok.github.io/v-hotkey

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>

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)

Modifiers

prevent

Add the prevent modifier to the directive to prevent default browser behavior.

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

stop

Add the stop modifier to the directive to stop event propagation.

<template>
  <div v-hotkey.stop="keymap">
    <span>
      Enter characters in editable areas doesn't trigger any hotkeys.
    </span>
    <input />
  </div>
</template>

forbidden

Add the forbidden modifier to the directive to allow hotkeys in forbidden elements (i.e. inputs, textfields).

<template>
  <div v-hotkey.forbidden="keymap">
    <span> Enter characters in editable areas does trigger hotkeys. </span>
    <input />
  </div>
</template>

Key Code Alias

The default key code map is based on US standard keyboard. This ability to provide their own key code alias for developers who using keyboards with different layouts. The alias name must be a single character.

Definition

import Vue from "vue";
import VueHotkey from "v-hotkey";

Vue.use(VueHotkey, {
  "①": 49, // the key code of character '1'
});

Template

<span v-hotkey="keymap"></span>
<script>
export default {
  foo() {
    console.log("Hooray!");
  },
  computed: {
    keymap() {
      return {
        "①": foo,
      };
    },
  },
};
</script>