v-hotkey3

Vue 3.2.x directive for binding hotkeys to components.

Though not a fork, this package is a direct copy of v-hotkey made to work with Vue 3 (until this PR probably gets merged).

Install

``bash
pnpm add v-hotkey3
`

Usage

`ts
import { createApp } from 'vue'
import HotkeyPlugin from 'v-hotkey3'

const app = createApp(App)

app.use(HotkeyPlugin)
`

`vue



`

Composable

`vue



`

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

$3

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

`vue

`

$3

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

`vue

`

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.

$3

`ts
import { createApp } from 'vue'
import HotkeyPlugin from 'v-hotkey3'

const app = createApp(App)

app.use(HotkeyPlugin, {
'①': 49 // the key code of character '1'
})
`

$3

`vue



``

License

MIT