AppHotkeysController

Defined in: controllers/app-hotkeys.ts:41

A Lit ReactiveController for app hotkeys provided with provideAppHotkeys: the effective app hotkeys, a cheat sheet list with live status, and the user's custom hotkeys. Requests an update when any of them change.

Example#

class CheatSheet extends LitElement {
  private app = new AppHotkeysController(this)

  render() {
    return html`<ul>
      ${this.app.list.map(
        ({ appHotkey, status }) => html`<li>${appHotkey.meta?.name}: ${status}</li>`,
      )}
    </ul>`
  }
}

Implements#

• ReactiveController

Constructors#

Constructor#

new AppHotkeysController(_host): AppHotkeysController;

Defined in: controllers/app-hotkeys.ts:44

Parameters#

_host#

ReactiveControllerHost

Returns#

AppHotkeysController

Accessors#

appHotkeys#

Get Signature#

get appHotkeys(): RegisteredAppHotkeys;

Defined in: controllers/app-hotkeys.ts:49

Effective app hotkeys, typed by Register.

Returns#

RegisteredAppHotkeys

customHotkeys#

Get Signature#

get customHotkeys(): CustomHotkeys;

Defined in: controllers/app-hotkeys.ts:65

The user's hotkeys that differ from the defaults.

Returns#

CustomHotkeys

list#

Get Signature#

get list(): AppHotkeyListItem<AppHotkey<string, HotkeyChord | HotkeySequence | null>>[];

Defined in: controllers/app-hotkeys.ts:54

Every app hotkey with its live status, in declaration order.

Returns#

AppHotkeyListItem<AppHotkey<string, HotkeyChord | HotkeySequence | null>>[]

Methods#

findConflicts()#

findConflicts(id, hotkey): AppHotkey<string, HotkeyChord | HotkeySequence | null>[];

Defined in: controllers/app-hotkeys.ts:91

Other app hotkeys that would collide if id used hotkey.

Parameters#

id#

string

hotkey#

Hotkey

Returns#

AppHotkey<string, HotkeyChord | HotkeySequence | null>[]

hostConnected()#

hostConnected(): void;

Defined in: controllers/app-hotkeys.ts:98

Called when the host is connected to the component tree. For custom element hosts, this corresponds to the connectedCallback() lifecycle, which is only called when the component is connected to the document.

Returns#

void

Implementation of#

ReactiveController.hostConnected

hostDisconnected()#

hostDisconnected(): void;

Defined in: controllers/app-hotkeys.ts:108

Called when the host is disconnected from the component tree. For custom element hosts, this corresponds to the disconnectedCallback() lifecycle, which is called the host or an ancestor component is disconnected from the document.

Returns#

void

Implementation of#

ReactiveController.hostDisconnected

resetCustomHotkey()#

resetCustomHotkey(id): void;

Defined in: controllers/app-hotkeys.ts:81

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys()#

resetCustomHotkeys(): void;

Defined in: controllers/app-hotkeys.ts:86

Restores every default hotkey.

Returns#

void

setCustomHotkey()#

setCustomHotkey(id, hotkey): AppHotkey<string, HotkeyChord | HotkeySequence | null>[];

Defined in: controllers/app-hotkeys.ts:73

Sets the user's hotkey for an app hotkey. null unbinds it. Returns conflicting app hotkeys; when any exist, nothing changes.

Parameters#

id#

string

hotkey#

Hotkey | null

Returns#

AppHotkey<string, HotkeyChord | HotkeySequence | null>[]