Skip to content

Mitscherlich/vue-use-hotkeys

Repository files navigation

vue-use-hotkeys

Vue composition for using keyboard shortcuts in components. This is a hook version for hotkeys package.

Install

via pnpm, yarn or npm:

$ pnpm add vue-use-hotkeys
# or
$ yarn add vue-use-hotkeys
# or
$ npm i -S vue-use-hotkeys

Usage

import { defineComponent, ref } from 'vue'
import { useHotkeys } from 'vue-use-hotkeys'

export default defineComponent(() => {
  const count = ref(0)

  useHotkeys('ctrl + k', () => {
    count.value += 1
  })

  return () => (
    <p>
      Pressed <kbd>ctrl + k</kbd> {count.value} times.
    </p>
  )
})

Preview demo:

To-Do(s)

  • add support of @vue/composition-api;

License

MIT © Mitscherlich