fn
useMagicKeys
v0.0.14testeddemoReactive keys pressed state, with magical combination keys support via a Proxy.
Access combinations directly as properties, e.g. keys['ctrl+a'] or keys.ctrl_a.
Examples
ts
const keys = useMagicKeys();
const ctrlA = keys['ctrl+a'];
watch(ctrlA, v => { if (v) console.log('Ctrl + A pressed'); });ts
const { ctrl, a, current } = useMagicKeys({ reactive: true });Demo
Loading demo…
Signatures
ts
export function useMagicKeys(options?: UseMagicKeysOptions<false>): MagicKeys<false>;ts
export function useMagicKeys(options: UseMagicKeysOptions<true>): MagicKeys<true>;Parameters
| Parameter | Type | Description |
|---|---|---|
options? | UseMagicKeysOptions<boolean> | Configuration options |
Returns
MagicKeys<boolean>A Proxy of refs (or reactive booleans) plus current Set and reset