AlpineHotkeys

Defined in: types.ts:127

Registrations and reactive state owned by one Alpine component.

Properties#

createAppHotkeyList#

createAppHotkeyList: () => AlpineHotkeyState<AppHotkeyListItem<AppHotkey<string, HotkeyChord | HotkeySequence | null>>[]>;

Defined in: types.ts:160

Read every app hotkey with its live status through .value.

Returns#

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

createAppHotkeys#

createAppHotkeys: () => AlpineHotkeyState<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>;

Defined in: types.ts:158

Read the effective app hotkeys from provideAppHotkeys through .value.

Returns#

AlpineHotkeyState<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>

createCustomHotkeys#

createCustomHotkeys: () => AlpineCustomHotkeys;

Defined in: types.ts:164

Read and change the user's custom hotkeys.

Returns#

AlpineCustomHotkeys

createHeldKeyCodes#

createHeldKeyCodes: () => AlpineHotkeyState<Record<string, string>>;

Defined in: types.ts:142

Read the mapping of held logical names to physical codes through .value.

Returns#

AlpineHotkeyState<Record<string, string>>

createHeldKeys#

createHeldKeys: () => AlpineHotkeyState<string[]>;

Defined in: types.ts:140

Read held logical key names through .value.

Returns#

AlpineHotkeyState<string[]>

createHotkey#

createHotkey: AlpineCreateHotkey;

Defined in: types.ts:133

Register one hotkey: a chord such as 'Mod+S', a sequence such as ['G', 'G'], or an app hotkey. Getters track changing hotkeys and options. undefined, null, or '' registers nothing, for an optional shortcut.

createHotkeyHint#

createHotkeyHint: (hotkey, options?) => AlpineHotkeyState<boolean>;

Defined in: types.ts:149

Read whether held modifiers reveal a hotkey through .value. No hotkey (undefined, null, or '') is never visible.

Parameters#

hotkey#

MaybeGetter< | RegisterableHotkey | AppHotkey<string, HotkeyChord | HotkeySequence | null> | null | undefined>

options?#

MaybeGetter<HeldModifierOptions>

Returns#

AlpineHotkeyState<boolean>

createHotkeyRegistrations#

createHotkeyRegistrations: () => HotkeyRegistrationsResult;

Defined in: types.ts:154

Read live registrations, including disabled entries.

Returns#

HotkeyRegistrationsResult

createHotkeys#

createHotkeys: (definitions, options?) => void;

Defined in: types.ts:135

Reconcile a list of hotkeys. Definition options override common options.

Parameters#

definitions#

MaybeGetter<readonly AlpineHotkeyDefinition[]>

options?#

MaybeGetter<AlpineHotkeyCommonOptions>

Returns#

void

createHotkeyScopesState#

createHotkeyScopesState: () => AlpineHotkeyState<HotkeyScopesState>;

Defined in: types.ts:156

Read the active, exclusive, allowed, and suspended scopes through .value.

Returns#

AlpineHotkeyState<HotkeyScopesState>

createKeyHold#

createKeyHold: (key) => AlpineHotkeyState<boolean>;

Defined in: types.ts:144

Read whether a key is held through .value.

Parameters#

key#

MaybeGetter<IndividualKey>

Returns#

AlpineHotkeyState<boolean>

destroy#

destroy: () => void;

Defined in: types.ts:166

Release every registration, subscription, effect, and recorder. Idempotent.

Returns#

void