README.md

vue3-hotKey

Vue3 hooks of Keyboard input.

📦 Install

pnpm i vue3-hotkey

or

yarn add vue3-hotkey

🦄 Usage

<script lang="ts" setup>
import useHotkey, { HotKey, RemoveHandler } from 'vue3-hotkey'
import { ref } from 'vue'
const hotkeys = ref<HotKey[]>([
  {
    keys: ['space'],
    preventDefault: true,
    handler(keys) {
      countRef.value += 5
    }
  },
  {
    keys: ['shift', 'space'],
    preventDefault: true,
    handler(keys) {
      countRef.value -= 100
    }
  }
])
const stopArr = useHotkey(hotkeys.value)

// 取消监听快捷键
const removeHotKeys = (hk: HotKey) => {
  stopArr.foreach((item: RemoveHandler) => item())
}
</script>

🌸 Thanks

This project is heavily inspired by the following awesome projects.

• vue-use-hotkey

📄 License

MIT License © 2021-PRESENT Talljack

🍺 Sponsor

如果大家喜欢我的项目的话，可以请我喝杯咖啡哦，谢谢！