WrHotkey

import { WrHotkey } from 'ngwr/hotkey';

private readonly hotkeys = inject(WrHotkey);

constructor() {
  const handle = this.hotkeys.bind('mod+k', () => this.openPalette());
  inject(DestroyRef).onDestroy(() => handle.unbind());
}

<button [wrHotkey]="'mod+k'" (wrHotkeyMatch)="openPalette()">Search</button>

Press ⌘/ (or Ctrl/) anywhere on this page.

Name	Description	Type	Default
`bind(spec, handler, options?)`	Register a binding. Returns `{ unbind }`.	`(spec, handler, options?) => WrHotkeyHandle`	`—`
`[wrHotkey]`	Directive form: binds on init, re-binds on input change, unbinds on destroy.	`WrHotkeySpec`	`—`
`spec format`	`'+'`-separated tokens. `mod` = Cmd on macOS, Ctrl elsewhere.	`string`	`—`
`WrHotkeyOptions`	The third argument of `bind()`.	`interface`	`—`
`element`	Listen on this element instead of `document`. It must hold focus, so add `tabindex="0"`.	`HTMLElement`	`document`
`preventDefault`	Call `event.preventDefault()` on a match.	`boolean`	`true`
`allowInInput`	Fire while an input, a textarea or a contenteditable has focus.	`boolean`	`false`
`priority`	Higher runs first; a handler calling `event.preventDefault()` stops the lower ones.	`number`	`0`

Name	Description	Type	Default
`wrHotkey`required	The chord to listen for — `'mod+k'`, `'shift+?'`, or the full spec object. `mod` resolves to ⌘ on macOS and Ctrl everywhere else.	`WrHotkeySpec`	—
`scoped`	Scope the binding to the host element instead of `document`.	`boolean`	`false`
`allowInInput`	Fire even when an input / textarea has focus.	`boolean`	`false`
`preventDefault`	Suppress the default action when the binding fires.	`boolean`	`true`
`(wrHotkeyMatch)`	Emits the original KeyboardEvent on match.	`KeyboardEvent`	—

Used by	Command Palette

Installation

Usage

API

[wrHotkey] inputs

Dependencies

See also