SvelteCustomHotkeys

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:74

Properties#

current#

readonly current: CustomHotkeys;

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:76

The user's hotkeys that differ from the defaults.

findConflicts#

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

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:90

Other app hotkeys that would collide if id used hotkey.

Parameters#

id#

string

hotkey#

Hotkey

Returns#

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

resetCustomHotkey#

resetCustomHotkey: (id) => void;

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:86

Restores the default hotkey for an app hotkey.

Parameters#

id#

string

Returns#

void

resetCustomHotkeys#

resetCustomHotkeys: () => void;

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:88

Restores every default hotkey.

Returns#

void

setCustomHotkey#

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

Defined in: packages/svelte-hotkeys/src/getAppHotkeys.svelte.ts:81

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>[]