From b2be8b83f72a0a94b7de545cfac08c4365400a33 Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Thu, 10 Sep 2026 12:48:39 +0200 Subject: [PATCH 1/4] docs: remove duplicate page headings --- .../angular/reference/functions/injectDefaultHotkeysOptions.md | 2 -- .../framework/angular/reference/functions/injectHeldKeyCodes.md | 2 -- docs/framework/angular/reference/functions/injectHeldKeys.md | 2 -- docs/framework/angular/reference/functions/injectHotkey.md | 2 -- .../angular/reference/functions/injectHotkeyRecorder.md | 2 -- .../angular/reference/functions/injectHotkeyRegistrations.md | 2 -- .../angular/reference/functions/injectHotkeySequence.md | 2 -- .../angular/reference/functions/injectHotkeySequenceRecorder.md | 2 -- .../angular/reference/functions/injectHotkeySequences.md | 2 -- docs/framework/angular/reference/functions/injectHotkeys.md | 2 -- .../angular/reference/functions/injectHotkeysContext.md | 2 -- docs/framework/angular/reference/functions/injectKeyHold.md | 2 -- docs/framework/angular/reference/functions/provideHotkeys.md | 2 -- docs/framework/angular/reference/index.md | 2 -- .../angular/reference/interfaces/AngularHotkeyRecorder.md | 2 -- .../reference/interfaces/AngularHotkeySequenceRecorder.md | 2 -- .../angular/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../angular/reference/interfaces/HotkeysContextValue.md | 2 -- .../angular/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../angular/reference/interfaces/InjectHotkeyDefinition.md | 2 -- .../angular/reference/interfaces/InjectHotkeyOptions.md | 2 -- .../reference/interfaces/InjectHotkeySequenceDefinition.md | 2 -- .../angular/reference/interfaces/InjectHotkeySequenceOptions.md | 2 -- .../angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md | 2 -- docs/framework/lit/reference/classes/HeldKeyCodesController.md | 2 -- docs/framework/lit/reference/classes/HeldKeysController.md | 2 -- docs/framework/lit/reference/classes/HotkeyController.md | 2 -- .../framework/lit/reference/classes/HotkeyRecorderController.md | 2 -- .../lit/reference/classes/HotkeyRegistrationsController.md | 2 -- .../framework/lit/reference/classes/HotkeySequenceController.md | 2 -- .../lit/reference/classes/HotkeySequenceRecorderController.md | 2 -- docs/framework/lit/reference/classes/KeyHoldController.md | 2 -- docs/framework/lit/reference/functions/hotkey.md | 2 -- docs/framework/lit/reference/functions/hotkeySequence.md | 2 -- docs/framework/lit/reference/index.md | 2 -- docs/framework/preact/reference/functions/HotkeysProvider.md | 2 -- .../preact/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/preact/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/preact/reference/functions/useHeldKeys.md | 2 -- docs/framework/preact/reference/functions/useHotkey.md | 2 -- docs/framework/preact/reference/functions/useHotkeyRecorder.md | 2 -- .../preact/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/preact/reference/functions/useHotkeySequence.md | 2 -- .../preact/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/preact/reference/functions/useHotkeySequences.md | 2 -- docs/framework/preact/reference/functions/useHotkeys.md | 2 -- docs/framework/preact/reference/functions/useHotkeysContext.md | 2 -- docs/framework/preact/reference/functions/useKeyHold.md | 2 -- docs/framework/preact/reference/index.md | 2 -- .../preact/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../preact/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../preact/reference/interfaces/HotkeysProviderProps.md | 2 -- .../preact/reference/interfaces/PreactHotkeyRecorder.md | 2 -- .../preact/reference/interfaces/PreactHotkeySequenceRecorder.md | 2 -- .../preact/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/preact/reference/interfaces/UseHotkeyOptions.md | 2 -- .../preact/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../preact/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/react/reference/functions/HotkeysProvider.md | 2 -- .../react/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/react/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/react/reference/functions/useHeldKeys.md | 2 -- docs/framework/react/reference/functions/useHotkey.md | 2 -- docs/framework/react/reference/functions/useHotkeyRecorder.md | 2 -- .../react/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/react/reference/functions/useHotkeySequence.md | 2 -- .../react/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/react/reference/functions/useHotkeySequences.md | 2 -- docs/framework/react/reference/functions/useHotkeys.md | 2 -- docs/framework/react/reference/functions/useHotkeysContext.md | 2 -- docs/framework/react/reference/functions/useKeyHold.md | 2 -- docs/framework/react/reference/index.md | 2 -- .../react/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../react/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../react/reference/interfaces/HotkeysProviderProps.md | 2 -- .../framework/react/reference/interfaces/ReactHotkeyRecorder.md | 2 -- .../react/reference/interfaces/ReactHotkeySequenceRecorder.md | 2 -- .../framework/react/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/react/reference/interfaces/UseHotkeyOptions.md | 2 -- .../react/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../react/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/solid/reference/functions/createHeldKeyCodes.md | 2 -- docs/framework/solid/reference/functions/createHeldKeys.md | 2 -- docs/framework/solid/reference/functions/createHotkey.md | 2 -- .../framework/solid/reference/functions/createHotkeyRecorder.md | 2 -- .../solid/reference/functions/createHotkeyRegistrations.md | 2 -- .../framework/solid/reference/functions/createHotkeySequence.md | 2 -- .../solid/reference/functions/createHotkeySequenceRecorder.md | 2 -- .../solid/reference/functions/createHotkeySequences.md | 2 -- docs/framework/solid/reference/functions/createHotkeys.md | 2 -- docs/framework/solid/reference/functions/createKeyHold.md | 2 -- .../solid/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/solid/reference/functions/useHotkeysContext.md | 2 -- docs/framework/solid/reference/index.md | 2 -- .../solid/reference/interfaces/CreateHotkeyDefinition.md | 2 -- .../framework/solid/reference/interfaces/CreateHotkeyOptions.md | 2 -- .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 -- .../solid/reference/interfaces/CreateHotkeySequenceOptions.md | 2 -- .../solid/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../solid/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../solid/reference/interfaces/HotkeysProviderProps.md | 2 -- .../framework/solid/reference/interfaces/SolidHotkeyRecorder.md | 2 -- .../solid/reference/interfaces/SolidHotkeySequenceRecorder.md | 2 -- docs/framework/solid/reference/variables/HotkeysProvider.md | 2 -- docs/framework/svelte/reference/functions/createHotkey.md | 2 -- .../svelte/reference/functions/createHotkeyAttachment.md | 2 -- .../svelte/reference/functions/createHotkeyRecorder.md | 2 -- .../svelte/reference/functions/createHotkeySequence.md | 2 -- .../reference/functions/createHotkeySequenceAttachment.md | 2 -- .../svelte/reference/functions/createHotkeySequenceRecorder.md | 2 -- .../svelte/reference/functions/createHotkeySequences.md | 2 -- .../reference/functions/createHotkeySequencesAttachment.md | 2 -- docs/framework/svelte/reference/functions/createHotkeys.md | 2 -- .../svelte/reference/functions/createHotkeysAttachment.md | 2 -- .../svelte/reference/functions/getDefaultHotkeysOptions.md | 2 -- docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md | 2 -- docs/framework/svelte/reference/functions/getHeldKeys.md | 2 -- .../svelte/reference/functions/getHotkeyRegistrations.md | 2 -- docs/framework/svelte/reference/functions/getHotkeysContext.md | 2 -- docs/framework/svelte/reference/functions/getIsKeyHeld.md | 2 -- docs/framework/svelte/reference/functions/setHotkeysContext.md | 2 -- docs/framework/svelte/reference/index.md | 2 -- .../svelte/reference/interfaces/CreateHotkeyDefinition.md | 2 -- .../svelte/reference/interfaces/CreateHotkeyOptions.md | 2 -- .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 -- .../svelte/reference/interfaces/CreateHotkeySequenceOptions.md | 2 -- .../svelte/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../svelte/reference/interfaces/HotkeysProviderProps.md | 2 -- .../svelte/reference/interfaces/SvelteHeldKeyCodesMap.md | 2 -- .../framework/svelte/reference/interfaces/SvelteHeldKeyState.md | 2 -- docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeyRecorder.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeyRegistrations.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md | 2 -- docs/framework/svelte/reference/type-aliases/HotkeysProvider.md | 2 -- docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md | 2 -- docs/framework/svelte/reference/variables/HotkeysProvider.md | 2 -- docs/framework/vue/reference/functions/provideHotkeysContext.md | 2 -- .../vue/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/vue/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/vue/reference/functions/useHeldKeys.md | 2 -- docs/framework/vue/reference/functions/useHotkey.md | 2 -- docs/framework/vue/reference/functions/useHotkeyRecorder.md | 2 -- .../framework/vue/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/vue/reference/functions/useHotkeySequence.md | 2 -- .../vue/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/vue/reference/functions/useHotkeySequences.md | 2 -- docs/framework/vue/reference/functions/useHotkeys.md | 2 -- docs/framework/vue/reference/functions/useHotkeysContext.md | 2 -- docs/framework/vue/reference/functions/useKeyHold.md | 2 -- docs/framework/vue/reference/index.md | 2 -- .../vue/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../vue/reference/interfaces/HotkeysProviderOptions.md | 2 -- docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/vue/reference/interfaces/UseHotkeyOptions.md | 2 -- .../vue/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../vue/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md | 2 -- .../vue/reference/interfaces/VueHotkeySequenceRecorder.md | 2 -- docs/framework/vue/reference/variables/HotkeysProvider.md | 2 -- docs/reference/classes/HotkeyManager.md | 2 -- docs/reference/classes/HotkeyRecorder.md | 2 -- docs/reference/classes/HotkeySequenceRecorder.md | 2 -- docs/reference/classes/KeyStateTracker.md | 2 -- docs/reference/classes/SequenceManager.md | 2 -- docs/reference/functions/assertValidHotkey.md | 2 -- docs/reference/functions/checkHotkey.md | 2 -- docs/reference/functions/createHotkeyHandler.md | 2 -- docs/reference/functions/createMultiHotkeyHandler.md | 2 -- docs/reference/functions/createSequenceMatcher.md | 2 -- docs/reference/functions/detectPlatform.md | 2 -- docs/reference/functions/formatForDisplay.md | 2 -- docs/reference/functions/formatHotkey.md | 2 -- docs/reference/functions/formatHotkeySequence.md | 2 -- docs/reference/functions/formatWithLabels.md | 2 -- docs/reference/functions/getHotkeyManager.md | 2 -- docs/reference/functions/getKeyStateTracker.md | 2 -- docs/reference/functions/getSequenceManager.md | 2 -- docs/reference/functions/hasNonModifierKey.md | 2 -- docs/reference/functions/isModifierKey.md | 2 -- docs/reference/functions/isSingleLetterKey.md | 2 -- docs/reference/functions/matchesKeyboardEvent.md | 2 -- docs/reference/functions/normalizeHotkey.md | 2 -- docs/reference/functions/normalizeHotkeyFromEvent.md | 2 -- docs/reference/functions/normalizeHotkeyFromParsed.md | 2 -- docs/reference/functions/normalizeKeyName.md | 2 -- docs/reference/functions/normalizeRegisterableHotkey.md | 2 -- docs/reference/functions/parseHotkey.md | 2 -- docs/reference/functions/parseKeyboardEvent.md | 2 -- docs/reference/functions/rawHotkeyToParsedHotkey.md | 2 -- docs/reference/functions/resolveModifier.md | 2 -- docs/reference/functions/toHotkeyRegistrationView.md | 2 -- docs/reference/functions/validateHotkey.md | 2 -- docs/reference/index.md | 2 -- docs/reference/interfaces/CreateHotkeyHandlerOptions.md | 2 -- docs/reference/interfaces/FormatDisplayOptions.md | 2 -- docs/reference/interfaces/HotkeyCallbackContext.md | 2 -- docs/reference/interfaces/HotkeyMeta.md | 2 -- docs/reference/interfaces/HotkeyOptions.md | 2 -- docs/reference/interfaces/HotkeyRecorderOptions.md | 2 -- docs/reference/interfaces/HotkeyRecorderState.md | 2 -- docs/reference/interfaces/HotkeyRegistration.md | 2 -- docs/reference/interfaces/HotkeyRegistrationHandle.md | 2 -- docs/reference/interfaces/HotkeyRegistrationView.md | 2 -- docs/reference/interfaces/HotkeySequenceRecorderOptions.md | 2 -- docs/reference/interfaces/HotkeySequenceRecorderState.md | 2 -- docs/reference/interfaces/KeyStateTrackerState.md | 2 -- docs/reference/interfaces/ParsedHotkey.md | 2 -- docs/reference/interfaces/RawHotkey.md | 2 -- docs/reference/interfaces/SequenceOptions.md | 2 -- docs/reference/interfaces/SequenceRegistrationHandle.md | 2 -- docs/reference/interfaces/SequenceRegistrationView.md | 2 -- docs/reference/interfaces/ValidationResult.md | 2 -- docs/reference/type-aliases/CanonicalModifier.md | 2 -- docs/reference/type-aliases/ConflictBehavior.md | 2 -- docs/reference/type-aliases/EditingKey.md | 2 -- docs/reference/type-aliases/FunctionKey.md | 2 -- docs/reference/type-aliases/Hotkey.md | 2 -- docs/reference/type-aliases/HotkeyCallback.md | 2 -- docs/reference/type-aliases/HotkeySequence.md | 2 -- docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md | 2 -- docs/reference/type-aliases/IndividualKey.md | 2 -- docs/reference/type-aliases/Key.md | 2 -- docs/reference/type-aliases/LetterKey.md | 2 -- docs/reference/type-aliases/Modifier.md | 2 -- docs/reference/type-aliases/NavigationKey.md | 2 -- docs/reference/type-aliases/NumberKey.md | 2 -- docs/reference/type-aliases/PunctuationKey.md | 2 -- docs/reference/type-aliases/RegisterableHotkey.md | 2 -- docs/reference/variables/ALL_KEYS.md | 2 -- docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md | 2 -- docs/reference/variables/EDITING_KEYS.md | 2 -- docs/reference/variables/FUNCTION_KEYS.md | 2 -- docs/reference/variables/KEY_DISPLAY_SYMBOLS.md | 2 -- docs/reference/variables/LETTER_KEYS.md | 2 -- docs/reference/variables/LINUX_MODIFIER_LABELS.md | 2 -- docs/reference/variables/MAC_MODIFIER_LABELS.md | 2 -- docs/reference/variables/MAC_MODIFIER_SYMBOLS.md | 2 -- docs/reference/variables/MODIFIER_ALIASES.md | 2 -- docs/reference/variables/MODIFIER_KEYS.md | 2 -- docs/reference/variables/MODIFIER_ORDER.md | 2 -- docs/reference/variables/NAVIGATION_KEYS.md | 2 -- docs/reference/variables/NUMBER_KEYS.md | 2 -- docs/reference/variables/PUNCTUATION_CODE_MAP.md | 2 -- docs/reference/variables/PUNCTUATION_KEYS.md | 2 -- docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md | 2 -- docs/reference/variables/WINDOWS_MODIFIER_LABELS.md | 2 -- 247 files changed, 494 deletions(-) diff --git a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md index 71a523f4..0ac393f9 100644 --- a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md +++ b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: injectDefaultHotkeysOptions title: injectDefaultHotkeysOptions --- -# Function: injectDefaultHotkeysOptions() - ```ts function injectDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md index d36f56e7..bab1a867 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md +++ b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md @@ -3,8 +3,6 @@ id: injectHeldKeyCodes title: injectHeldKeyCodes --- -# Function: injectHeldKeyCodes() - ```ts function injectHeldKeyCodes(): Signal>; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeys.md b/docs/framework/angular/reference/functions/injectHeldKeys.md index cf812db9..991a2a01 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeys.md +++ b/docs/framework/angular/reference/functions/injectHeldKeys.md @@ -3,8 +3,6 @@ id: injectHeldKeys title: injectHeldKeys --- -# Function: injectHeldKeys() - ```ts function injectHeldKeys(): Signal; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkey.md b/docs/framework/angular/reference/functions/injectHotkey.md index ad4ba5ac..5a58c5ab 100644 --- a/docs/framework/angular/reference/functions/injectHotkey.md +++ b/docs/framework/angular/reference/functions/injectHotkey.md @@ -3,8 +3,6 @@ id: injectHotkey title: injectHotkey --- -# Function: injectHotkey() - ```ts function injectHotkey( hotkey, diff --git a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md index cd79601a..cedfe147 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md @@ -3,8 +3,6 @@ id: injectHotkeyRecorder title: injectHotkeyRecorder --- -# Function: injectHotkeyRecorder() - ```ts function injectHotkeyRecorder(options): AngularHotkeyRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md index 4412da71..c34f975a 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: injectHotkeyRegistrations title: injectHotkeyRegistrations --- -# Function: injectHotkeyRegistrations() - ```ts function injectHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequence.md b/docs/framework/angular/reference/functions/injectHotkeySequence.md index 9e6dc675..fc37a367 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequence.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequence.md @@ -3,8 +3,6 @@ id: injectHotkeySequence title: injectHotkeySequence --- -# Function: injectHotkeySequence() - ```ts function injectHotkeySequence( sequence, diff --git a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md index 324886b4..5aabe108 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: injectHotkeySequenceRecorder title: injectHotkeySequenceRecorder --- -# Function: injectHotkeySequenceRecorder() - ```ts function injectHotkeySequenceRecorder(options): AngularHotkeySequenceRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequences.md b/docs/framework/angular/reference/functions/injectHotkeySequences.md index c4f43988..1c2559d8 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequences.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequences.md @@ -3,8 +3,6 @@ id: injectHotkeySequences title: injectHotkeySequences --- -# Function: injectHotkeySequences() - ```ts function injectHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeys.md b/docs/framework/angular/reference/functions/injectHotkeys.md index b18292c9..1498f7ff 100644 --- a/docs/framework/angular/reference/functions/injectHotkeys.md +++ b/docs/framework/angular/reference/functions/injectHotkeys.md @@ -3,8 +3,6 @@ id: injectHotkeys title: injectHotkeys --- -# Function: injectHotkeys() - ```ts function injectHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeysContext.md b/docs/framework/angular/reference/functions/injectHotkeysContext.md index 39a91965..a92e51c7 100644 --- a/docs/framework/angular/reference/functions/injectHotkeysContext.md +++ b/docs/framework/angular/reference/functions/injectHotkeysContext.md @@ -3,8 +3,6 @@ id: injectHotkeysContext title: injectHotkeysContext --- -# Function: injectHotkeysContext() - ```ts function injectHotkeysContext(): HotkeysContextValue; ``` diff --git a/docs/framework/angular/reference/functions/injectKeyHold.md b/docs/framework/angular/reference/functions/injectKeyHold.md index 28bc5712..d5a2c2b7 100644 --- a/docs/framework/angular/reference/functions/injectKeyHold.md +++ b/docs/framework/angular/reference/functions/injectKeyHold.md @@ -3,8 +3,6 @@ id: injectKeyHold title: injectKeyHold --- -# Function: injectKeyHold() - ```ts function injectKeyHold(key): Signal; ``` diff --git a/docs/framework/angular/reference/functions/provideHotkeys.md b/docs/framework/angular/reference/functions/provideHotkeys.md index 9a88d0a5..37d6a97c 100644 --- a/docs/framework/angular/reference/functions/provideHotkeys.md +++ b/docs/framework/angular/reference/functions/provideHotkeys.md @@ -3,8 +3,6 @@ id: provideHotkeys title: provideHotkeys --- -# Function: provideHotkeys() - ```ts function provideHotkeys(defaultOptions): StaticProvider; ``` diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 2058e458..5eadd207 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/angular-hotkeys" title: "@tanstack/angular-hotkeys" --- -# @tanstack/angular-hotkeys - ## Interfaces - [AngularHotkeyRecorder](interfaces/AngularHotkeyRecorder.md) diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md index 8b85b288..f5692a63 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md @@ -3,8 +3,6 @@ id: AngularHotkeyRecorder title: AngularHotkeyRecorder --- -# Interface: AngularHotkeyRecorder - Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L15) ## Properties diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md index 042d0ee8..55ad4ea3 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: AngularHotkeySequenceRecorder title: AngularHotkeySequenceRecorder --- -# Interface: AngularHotkeySequenceRecorder - Defined in: [injectHotkeySequenceRecorder.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequenceRecorder.ts#L18) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md index 09bdf8d0..28ef11f4 100644 --- a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [injectHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRegistrations.ts#L16) Return type for injectHotkeyRegistrations. diff --git a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md index 953af39e..28d84013 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md +++ b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md @@ -3,8 +3,6 @@ id: HotkeysContextValue title: HotkeysContextValue --- -# Interface: HotkeysContextValue - Defined in: [hotkeys-provider.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L17) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md index d9639cbb..6784299b 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [hotkeys-provider.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L10) ## Properties diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md index fc42bb6b..9343a3f1 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md @@ -3,8 +3,6 @@ id: InjectHotkeyDefinition title: InjectHotkeyDefinition --- -# Interface: InjectHotkeyDefinition - Defined in: [injectHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeys.ts#L19) A single hotkey definition for use with `injectHotkeys`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md index 548a7d43..1eb59425 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md @@ -3,8 +3,6 @@ id: InjectHotkeyOptions title: InjectHotkeyOptions --- -# Interface: InjectHotkeyOptions - Defined in: [injectHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkey.ts#L16) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md index 77e35da7..b436b9fb 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: InjectHotkeySequenceDefinition title: InjectHotkeySequenceDefinition --- -# Interface: InjectHotkeySequenceDefinition - Defined in: [injectHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L14) A single sequence definition for use with `injectHotkeySequences`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md index e5663ee2..2ac683eb 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: InjectHotkeySequenceOptions title: InjectHotkeySequenceOptions --- -# Interface: InjectHotkeySequenceOptions - Defined in: [injectHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md index 23e3fafe..e7c6d03c 100644 --- a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md +++ b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md @@ -3,8 +3,6 @@ id: HOTKEYS_INJECTION_TOKEN title: HOTKEYS_INJECTION_TOKEN --- -# Variable: HOTKEYS\_INJECTION\_TOKEN - ```ts const HOTKEYS_INJECTION_TOKEN: InjectionToken; ``` diff --git a/docs/framework/lit/reference/classes/HeldKeyCodesController.md b/docs/framework/lit/reference/classes/HeldKeyCodesController.md index 1a0581aa..2ee3eb8d 100644 --- a/docs/framework/lit/reference/classes/HeldKeyCodesController.md +++ b/docs/framework/lit/reference/classes/HeldKeyCodesController.md @@ -3,8 +3,6 @@ id: HeldKeyCodesController title: HeldKeyCodesController --- -# Class: HeldKeyCodesController - Defined in: [controllers/held-key-codes.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-key-codes.ts#L27) A Lit ReactiveController that tracks all currently held key names to their physical `event.code` values. diff --git a/docs/framework/lit/reference/classes/HeldKeysController.md b/docs/framework/lit/reference/classes/HeldKeysController.md index 687c5d92..1a4f5d78 100644 --- a/docs/framework/lit/reference/classes/HeldKeysController.md +++ b/docs/framework/lit/reference/classes/HeldKeysController.md @@ -3,8 +3,6 @@ id: HeldKeysController title: HeldKeysController --- -# Class: HeldKeysController - Defined in: [controllers/held-keys.ts:26](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-keys.ts#L26) A Lit ReactiveController that tracks all currently held keyboard keys. diff --git a/docs/framework/lit/reference/classes/HotkeyController.md b/docs/framework/lit/reference/classes/HotkeyController.md index bb323a90..0d12622c 100644 --- a/docs/framework/lit/reference/classes/HotkeyController.md +++ b/docs/framework/lit/reference/classes/HotkeyController.md @@ -3,8 +3,6 @@ id: HotkeyController title: HotkeyController --- -# Class: HotkeyController - Defined in: [controllers/hotkey.ts:34](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey.ts#L34) A Lit ReactiveController that registers a keyboard hotkey when the host diff --git a/docs/framework/lit/reference/classes/HotkeyRecorderController.md b/docs/framework/lit/reference/classes/HotkeyRecorderController.md index 20f077ff..09b7d31b 100644 --- a/docs/framework/lit/reference/classes/HotkeyRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeyRecorderController.md @@ -3,8 +3,6 @@ id: HotkeyRecorderController title: HotkeyRecorderController --- -# Class: HotkeyRecorderController - Defined in: [controllers/hotkey-recorder.ts:40](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-recorder.ts#L40) A Lit ReactiveController that records keyboard shortcuts. diff --git a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md index 0aa6fb24..703fd76b 100644 --- a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md +++ b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsController title: HotkeyRegistrationsController --- -# Class: HotkeyRegistrationsController - Defined in: [controllers/hotkey-registrations.ts:35](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-registrations.ts#L35) A Lit ReactiveController that tracks all hotkey and sequence registrations. diff --git a/docs/framework/lit/reference/classes/HotkeySequenceController.md b/docs/framework/lit/reference/classes/HotkeySequenceController.md index 96f10ab0..50a18e17 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceController.md @@ -3,8 +3,6 @@ id: HotkeySequenceController title: HotkeySequenceController --- -# Class: HotkeySequenceController - Defined in: [controllers/hotkey-sequence.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence.ts#L28) A Lit ReactiveController that registers a keyboard sequence (e.g. Vim-style) diff --git a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md index 8a228404..58dde745 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderController title: HotkeySequenceRecorderController --- -# Class: HotkeySequenceRecorderController - Defined in: [controllers/hotkey-sequence-recorder.ts:45](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence-recorder.ts#L45) A Lit ReactiveController that records multi-chord sequences (Vim-style shortcuts). diff --git a/docs/framework/lit/reference/classes/KeyHoldController.md b/docs/framework/lit/reference/classes/KeyHoldController.md index 2aa575cf..27ffe6d5 100644 --- a/docs/framework/lit/reference/classes/KeyHoldController.md +++ b/docs/framework/lit/reference/classes/KeyHoldController.md @@ -3,8 +3,6 @@ id: KeyHoldController title: KeyHoldController --- -# Class: KeyHoldController - Defined in: [controllers/key-hold.ts:43](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/key-hold.ts#L43) A Lit ReactiveController that tracks whether a specific key is currently held. diff --git a/docs/framework/lit/reference/functions/hotkey.md b/docs/framework/lit/reference/functions/hotkey.md index a9e3c908..dbe41638 100644 --- a/docs/framework/lit/reference/functions/hotkey.md +++ b/docs/framework/lit/reference/functions/hotkey.md @@ -3,8 +3,6 @@ id: hotkey title: hotkey --- -# Function: hotkey() - ```ts function hotkey(hotkey, options): (proto, propertyKey, descriptor?) => void; ``` diff --git a/docs/framework/lit/reference/functions/hotkeySequence.md b/docs/framework/lit/reference/functions/hotkeySequence.md index 175fae9e..8fd40ef6 100644 --- a/docs/framework/lit/reference/functions/hotkeySequence.md +++ b/docs/framework/lit/reference/functions/hotkeySequence.md @@ -3,8 +3,6 @@ id: hotkeySequence title: hotkeySequence --- -# Function: hotkeySequence() - ```ts function hotkeySequence(sequence, options): (proto, methodName, descriptor) => void; ``` diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md index 2dfc191d..c4c882c7 100644 --- a/docs/framework/lit/reference/index.md +++ b/docs/framework/lit/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/lit-hotkeys" title: "@tanstack/lit-hotkeys" --- -# @tanstack/lit-hotkeys - ## Classes - [HeldKeyCodesController](classes/HeldKeyCodesController.md) diff --git a/docs/framework/preact/reference/functions/HotkeysProvider.md b/docs/framework/preact/reference/functions/HotkeysProvider.md index 439bf749..2fe89161 100644 --- a/docs/framework/preact/reference/functions/HotkeysProvider.md +++ b/docs/framework/preact/reference/functions/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Function: HotkeysProvider() - ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md index 449602a2..a0f351bb 100644 --- a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeyCodes.md b/docs/framework/preact/reference/functions/useHeldKeyCodes.md index 586b59cf..897748e2 100644 --- a/docs/framework/preact/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/preact/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeys.md b/docs/framework/preact/reference/functions/useHeldKeys.md index 6508c07c..04a8cef0 100644 --- a/docs/framework/preact/reference/functions/useHeldKeys.md +++ b/docs/framework/preact/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/preact/reference/functions/useHotkey.md b/docs/framework/preact/reference/functions/useHotkey.md index 5e1ccd43..c05188d4 100644 --- a/docs/framework/preact/reference/functions/useHotkey.md +++ b/docs/framework/preact/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/preact/reference/functions/useHotkeyRecorder.md b/docs/framework/preact/reference/functions/useHotkeyRecorder.md index 7d5ff107..55773770 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): PreactHotkeyRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md index c47313f6..e3460584 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequence.md b/docs/framework/preact/reference/functions/useHotkeySequence.md index 348b9f5b..72bf74dc 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequence.md +++ b/docs/framework/preact/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md index ae5efd38..650713a5 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): PreactHotkeySequenceRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequences.md b/docs/framework/preact/reference/functions/useHotkeySequences.md index 0820ffd9..eb432ebc 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequences.md +++ b/docs/framework/preact/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeys.md b/docs/framework/preact/reference/functions/useHotkeys.md index f2fdb9de..b026304b 100644 --- a/docs/framework/preact/reference/functions/useHotkeys.md +++ b/docs/framework/preact/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeysContext.md b/docs/framework/preact/reference/functions/useHotkeysContext.md index 70ab7367..8a084f1f 100644 --- a/docs/framework/preact/reference/functions/useHotkeysContext.md +++ b/docs/framework/preact/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/preact/reference/functions/useKeyHold.md b/docs/framework/preact/reference/functions/useKeyHold.md index 5d67feb0..0c14980d 100644 --- a/docs/framework/preact/reference/functions/useKeyHold.md +++ b/docs/framework/preact/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index ab63eb09..3cefc3b1 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/preact-hotkeys" title: "@tanstack/preact-hotkeys" --- -# @tanstack/preact-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md index cea192a6..7a498ba3 100644 --- a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md index 2455d300..17b11151 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:11](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L11) ## Properties diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md index 674f2e03..913ad85d 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:24](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L24) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md index d4d369de..af9f4e8e 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md @@ -3,8 +3,6 @@ id: PreactHotkeyRecorder title: PreactHotkeyRecorder --- -# Interface: PreactHotkeyRecorder - Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md index 1c2c6c8e..77bb65e2 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: PreactHotkeySequenceRecorder title: PreactHotkeySequenceRecorder --- -# Interface: PreactHotkeySequenceRecorder - Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md index 978c5543..001375a6 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md index 3f541626..77b1d253 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md index 9534c315..aac46d36 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md index f5f6ba85..092b908b 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [useHotkeySequence.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequence.ts#L14) ## Extends diff --git a/docs/framework/react/reference/functions/HotkeysProvider.md b/docs/framework/react/reference/functions/HotkeysProvider.md index 3144e8d2..e0b17212 100644 --- a/docs/framework/react/reference/functions/HotkeysProvider.md +++ b/docs/framework/react/reference/functions/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Function: HotkeysProvider() - ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md index b3a13795..2ccb7409 100644 --- a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeyCodes.md b/docs/framework/react/reference/functions/useHeldKeyCodes.md index 285c78c8..ea8806f9 100644 --- a/docs/framework/react/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/react/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeys.md b/docs/framework/react/reference/functions/useHeldKeys.md index 4dd17e1b..dd6f6609 100644 --- a/docs/framework/react/reference/functions/useHeldKeys.md +++ b/docs/framework/react/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/react/reference/functions/useHotkey.md b/docs/framework/react/reference/functions/useHotkey.md index baf595da..4c912c26 100644 --- a/docs/framework/react/reference/functions/useHotkey.md +++ b/docs/framework/react/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/react/reference/functions/useHotkeyRecorder.md b/docs/framework/react/reference/functions/useHotkeyRecorder.md index 57c513ae..25cadc6a 100644 --- a/docs/framework/react/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): ReactHotkeyRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeyRegistrations.md b/docs/framework/react/reference/functions/useHotkeyRegistrations.md index 583b2aba..943bced8 100644 --- a/docs/framework/react/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/react/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequence.md b/docs/framework/react/reference/functions/useHotkeySequence.md index de36b75c..1c55990c 100644 --- a/docs/framework/react/reference/functions/useHotkeySequence.md +++ b/docs/framework/react/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md index ab311cc1..35380c35 100644 --- a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): ReactHotkeySequenceRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequences.md b/docs/framework/react/reference/functions/useHotkeySequences.md index 057d7015..7653d7e4 100644 --- a/docs/framework/react/reference/functions/useHotkeySequences.md +++ b/docs/framework/react/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeys.md b/docs/framework/react/reference/functions/useHotkeys.md index 5986e28c..2fe4865a 100644 --- a/docs/framework/react/reference/functions/useHotkeys.md +++ b/docs/framework/react/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeysContext.md b/docs/framework/react/reference/functions/useHotkeysContext.md index 8141e0d7..f84f7aa2 100644 --- a/docs/framework/react/reference/functions/useHotkeysContext.md +++ b/docs/framework/react/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/react/reference/functions/useKeyHold.md b/docs/framework/react/reference/functions/useKeyHold.md index 29cd205f..bc823728 100644 --- a/docs/framework/react/reference/functions/useKeyHold.md +++ b/docs/framework/react/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 20bb1082..c9fc0843 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/react-hotkeys" title: "@tanstack/react-hotkeys" --- -# @tanstack/react-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md index 25352781..05b0e482 100644 --- a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md index e50aae7e..7e8d0dd2 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md index 4f92bf13..14dc70f0 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md index 146ab032..e61f8c0a 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md @@ -3,8 +3,6 @@ id: ReactHotkeyRecorder title: ReactHotkeyRecorder --- -# Interface: ReactHotkeyRecorder - Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md index 8b4cdb26..a307b321 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: ReactHotkeySequenceRecorder title: ReactHotkeySequenceRecorder --- -# Interface: ReactHotkeySequenceRecorder - Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md index 1a7bfca1..6f1ade22 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md index e21ddac8..6ca9653c 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [useHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkey.ts#L16) ## Extends diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md index 7965ef8d..e7c3daf4 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md index 6797d6e4..ca20e65a 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [useHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/solid/reference/functions/createHeldKeyCodes.md b/docs/framework/solid/reference/functions/createHeldKeyCodes.md index 4ca31b41..29a166c5 100644 --- a/docs/framework/solid/reference/functions/createHeldKeyCodes.md +++ b/docs/framework/solid/reference/functions/createHeldKeyCodes.md @@ -3,8 +3,6 @@ id: createHeldKeyCodes title: createHeldKeyCodes --- -# Function: createHeldKeyCodes() - ```ts function createHeldKeyCodes(): () => Record; ``` diff --git a/docs/framework/solid/reference/functions/createHeldKeys.md b/docs/framework/solid/reference/functions/createHeldKeys.md index bd4bcfd8..0cf87e1b 100644 --- a/docs/framework/solid/reference/functions/createHeldKeys.md +++ b/docs/framework/solid/reference/functions/createHeldKeys.md @@ -3,8 +3,6 @@ id: createHeldKeys title: createHeldKeys --- -# Function: createHeldKeys() - ```ts function createHeldKeys(): () => string[]; ``` diff --git a/docs/framework/solid/reference/functions/createHotkey.md b/docs/framework/solid/reference/functions/createHotkey.md index e665b974..c7d55b7b 100644 --- a/docs/framework/solid/reference/functions/createHotkey.md +++ b/docs/framework/solid/reference/functions/createHotkey.md @@ -3,8 +3,6 @@ id: createHotkey title: createHotkey --- -# Function: createHotkey() - ```ts function createHotkey( hotkey, diff --git a/docs/framework/solid/reference/functions/createHotkeyRecorder.md b/docs/framework/solid/reference/functions/createHotkeyRecorder.md index f5b9d62e..fe04fa8e 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeyRecorder.md @@ -3,8 +3,6 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- -# Function: createHotkeyRecorder() - ```ts function createHotkeyRecorder(options): SolidHotkeyRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md index fcbc1b16..3e6a9b7f 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md +++ b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: createHotkeyRegistrations title: createHotkeyRegistrations --- -# Function: createHotkeyRegistrations() - ```ts function createHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequence.md b/docs/framework/solid/reference/functions/createHotkeySequence.md index f2efeafa..1389508b 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequence.md +++ b/docs/framework/solid/reference/functions/createHotkeySequence.md @@ -3,8 +3,6 @@ id: createHotkeySequence title: createHotkeySequence --- -# Function: createHotkeySequence() - ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md index 15bed5fc..61648e77 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- -# Function: createHotkeySequenceRecorder() - ```ts function createHotkeySequenceRecorder(options): SolidHotkeySequenceRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequences.md b/docs/framework/solid/reference/functions/createHotkeySequences.md index e92fd09a..4c57c469 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequences.md +++ b/docs/framework/solid/reference/functions/createHotkeySequences.md @@ -3,8 +3,6 @@ id: createHotkeySequences title: createHotkeySequences --- -# Function: createHotkeySequences() - ```ts function createHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeys.md b/docs/framework/solid/reference/functions/createHotkeys.md index d8d86810..b0c5c862 100644 --- a/docs/framework/solid/reference/functions/createHotkeys.md +++ b/docs/framework/solid/reference/functions/createHotkeys.md @@ -3,8 +3,6 @@ id: createHotkeys title: createHotkeys --- -# Function: createHotkeys() - ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createKeyHold.md b/docs/framework/solid/reference/functions/createKeyHold.md index 380ed74f..4f8cf0fe 100644 --- a/docs/framework/solid/reference/functions/createKeyHold.md +++ b/docs/framework/solid/reference/functions/createKeyHold.md @@ -3,8 +3,6 @@ id: createKeyHold title: createKeyHold --- -# Function: createKeyHold() - ```ts function createKeyHold(key): () => boolean; ``` diff --git a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md index d1513375..a83e38f1 100644 --- a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/solid/reference/functions/useHotkeysContext.md b/docs/framework/solid/reference/functions/useHotkeysContext.md index 87c57f48..4baa22ff 100644 --- a/docs/framework/solid/reference/functions/useHotkeysContext.md +++ b/docs/framework/solid/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index f8b75907..14f58470 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/solid-hotkeys" title: "@tanstack/solid-hotkeys" --- -# @tanstack/solid-hotkeys - ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md index d3bcbaa5..726050f9 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- -# Interface: CreateHotkeyDefinition - Defined in: [createHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeys.ts#L19) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md index a8f721a1..c03c61ba 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- -# Interface: CreateHotkeyOptions - Defined in: [createHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkey.ts#L16) ## Extends diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md index d5d4ab66..a4d54a4d 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- -# Interface: CreateHotkeySequenceDefinition - Defined in: [createHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L14) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md index d3a3913c..4a226508 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- -# Interface: CreateHotkeySequenceOptions - Defined in: [createHotkeySequence.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequence.ts#L11) ## Extends diff --git a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md index 48d89a61..1c9adf93 100644 --- a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [createHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRegistrations.ts#L15) Return type for createHotkeyRegistrations. diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md index c4d77c58..259ead17 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md index d963098e..26c3eed9 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md index f1640633..42d5c61b 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md @@ -3,8 +3,6 @@ id: SolidHotkeyRecorder title: SolidHotkeyRecorder --- -# Interface: SolidHotkeyRecorder - Defined in: [createHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md index 7fcd1594..b72f9995 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: SolidHotkeySequenceRecorder title: SolidHotkeySequenceRecorder --- -# Interface: SolidHotkeySequenceRecorder - Defined in: [createHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/solid/reference/variables/HotkeysProvider.md b/docs/framework/solid/reference/variables/HotkeysProvider.md index 6a622bb8..4804d333 100644 --- a/docs/framework/solid/reference/variables/HotkeysProvider.md +++ b/docs/framework/solid/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: ParentComponent; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkey.md b/docs/framework/svelte/reference/functions/createHotkey.md index d21dcd05..a87fbbb2 100644 --- a/docs/framework/svelte/reference/functions/createHotkey.md +++ b/docs/framework/svelte/reference/functions/createHotkey.md @@ -3,8 +3,6 @@ id: createHotkey title: createHotkey --- -# Function: createHotkey() - ```ts function createHotkey( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md index 1172ba9b..ce2df77d 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md @@ -3,8 +3,6 @@ id: createHotkeyAttachment title: createHotkeyAttachment --- -# Function: createHotkeyAttachment() - ```ts function createHotkeyAttachment( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md index 41e3db29..feb27572 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md @@ -3,8 +3,6 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- -# Function: createHotkeyRecorder() - ```ts function createHotkeyRecorder(options): SvelteHotkeyRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequence.md b/docs/framework/svelte/reference/functions/createHotkeySequence.md index 46ccede2..47a69976 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequence.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequence.md @@ -3,8 +3,6 @@ id: createHotkeySequence title: createHotkeySequence --- -# Function: createHotkeySequence() - ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md index 5a01feaa..8e3c1112 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md @@ -3,8 +3,6 @@ id: createHotkeySequenceAttachment title: createHotkeySequenceAttachment --- -# Function: createHotkeySequenceAttachment() - ```ts function createHotkeySequenceAttachment( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md index 7a16ea72..aae69ff4 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- -# Function: createHotkeySequenceRecorder() - ```ts function createHotkeySequenceRecorder(options): SvelteHotkeySequenceRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequences.md b/docs/framework/svelte/reference/functions/createHotkeySequences.md index 503f12c8..9b697647 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequences.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequences.md @@ -3,8 +3,6 @@ id: createHotkeySequences title: createHotkeySequences --- -# Function: createHotkeySequences() - ```ts function createHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md index d843bb45..7d7a2f28 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md @@ -3,8 +3,6 @@ id: createHotkeySequencesAttachment title: createHotkeySequencesAttachment --- -# Function: createHotkeySequencesAttachment() - ```ts function createHotkeySequencesAttachment(definitions, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeys.md b/docs/framework/svelte/reference/functions/createHotkeys.md index 3686160a..a39f22af 100644 --- a/docs/framework/svelte/reference/functions/createHotkeys.md +++ b/docs/framework/svelte/reference/functions/createHotkeys.md @@ -3,8 +3,6 @@ id: createHotkeys title: createHotkeys --- -# Function: createHotkeys() - ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md index 331db686..1990e14a 100644 --- a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md @@ -3,8 +3,6 @@ id: createHotkeysAttachment title: createHotkeysAttachment --- -# Function: createHotkeysAttachment() - ```ts function createHotkeysAttachment(hotkeys, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md index 2828e8de..6faf5355 100644 --- a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md +++ b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: getDefaultHotkeysOptions title: getDefaultHotkeysOptions --- -# Function: getDefaultHotkeysOptions() - ```ts function getDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md index 11767fc4..9d3d20b5 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md @@ -3,8 +3,6 @@ id: getHeldKeyCodesMap title: getHeldKeyCodesMap --- -# Function: getHeldKeyCodesMap() - ```ts function getHeldKeyCodesMap(): SvelteHeldKeyCodesMap; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeys.md b/docs/framework/svelte/reference/functions/getHeldKeys.md index a50cd94b..746b00a2 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeys.md +++ b/docs/framework/svelte/reference/functions/getHeldKeys.md @@ -3,8 +3,6 @@ id: getHeldKeys title: getHeldKeys --- -# Function: getHeldKeys() - ```ts function getHeldKeys(): SvelteHeldKeys; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md index ee988c1c..892d2a43 100644 --- a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: getHotkeyRegistrations title: getHotkeyRegistrations --- -# Function: getHotkeyRegistrations() - ```ts function getHotkeyRegistrations(): SvelteHotkeyRegistrations; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeysContext.md b/docs/framework/svelte/reference/functions/getHotkeysContext.md index 82b71f0a..9ded3519 100644 --- a/docs/framework/svelte/reference/functions/getHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/getHotkeysContext.md @@ -3,8 +3,6 @@ id: getHotkeysContext title: getHotkeysContext --- -# Function: getHotkeysContext() - ```ts function getHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/svelte/reference/functions/getIsKeyHeld.md b/docs/framework/svelte/reference/functions/getIsKeyHeld.md index d0f9cbb5..e72b4281 100644 --- a/docs/framework/svelte/reference/functions/getIsKeyHeld.md +++ b/docs/framework/svelte/reference/functions/getIsKeyHeld.md @@ -3,8 +3,6 @@ id: getIsKeyHeld title: getIsKeyHeld --- -# Function: getIsKeyHeld() - ```ts function getIsKeyHeld(key): SvelteHeldKeyState; ``` diff --git a/docs/framework/svelte/reference/functions/setHotkeysContext.md b/docs/framework/svelte/reference/functions/setHotkeysContext.md index ad085eed..70b94e38 100644 --- a/docs/framework/svelte/reference/functions/setHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/setHotkeysContext.md @@ -3,8 +3,6 @@ id: setHotkeysContext title: setHotkeysContext --- -# Function: setHotkeysContext() - ```ts function setHotkeysContext(defaultOptions): HotkeysContextValue; ``` diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 5acb3b0b..603a9da0 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/svelte-hotkeys" title: "@tanstack/svelte-hotkeys" --- -# @tanstack/svelte-hotkeys - ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md index 7287ad44..77f588a2 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- -# Interface: CreateHotkeyDefinition - Defined in: [packages/svelte-hotkeys/src/createHotkeys.svelte.ts:23](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeys.svelte.ts#L23) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md index 0a5ee817..a6e25cfd 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- -# Interface: CreateHotkeyOptions - Defined in: [packages/svelte-hotkeys/src/createHotkey.svelte.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkey.svelte.ts#L19) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md index 7347a8b9..933a29be 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- -# Interface: CreateHotkeySequenceDefinition - Defined in: [packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts#L18) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md index a2e34667..01dd97d2 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- -# Interface: CreateHotkeySequenceOptions - Defined in: [packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts#L14) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md index cce1c297..3b527405 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L10) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md index 15ca21a8..309ad4f9 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L17) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md index dfa75646..9a57484b 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md @@ -3,8 +3,6 @@ id: SvelteHeldKeyCodesMap title: SvelteHeldKeyCodesMap --- -# Interface: SvelteHeldKeyCodesMap - Defined in: [packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md index 31ecd19e..5f4a29a5 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md @@ -3,8 +3,6 @@ id: SvelteHeldKeyState title: SvelteHeldKeyState --- -# Interface: SvelteHeldKeyState - Defined in: [packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts:5](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts#L5) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md index 259e1305..8ed747f9 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md @@ -3,8 +3,6 @@ id: SvelteHeldKeys title: SvelteHeldKeys --- -# Interface: SvelteHeldKeys - Defined in: [packages/svelte-hotkeys/src/getHeldKeys.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeys.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md index a2e7f442..071d5d9c 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md @@ -3,8 +3,6 @@ id: SvelteHotkeyRecorder title: SvelteHotkeyRecorder --- -# Interface: SvelteHotkeyRecorder - Defined in: [packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts#L8) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md index ae2d29d3..a1485bb6 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: SvelteHotkeyRegistrations title: SvelteHotkeyRegistrations --- -# Interface: SvelteHotkeyRegistrations - Defined in: [packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts#L12) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md index 3b11bb07..e21e3d71 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: SvelteHotkeySequenceRecorder title: SvelteHotkeySequenceRecorder --- -# Interface: SvelteHotkeySequenceRecorder - Defined in: [packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts#L11) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md index fba4fb47..62b66d67 100644 --- a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md +++ b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Type Alias: HotkeysProvider - ```ts type HotkeysProvider = SvelteComponent; ``` diff --git a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md index a5263772..55ea1d73 100644 --- a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md +++ b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md @@ -3,8 +3,6 @@ id: DEFAULT_OPTIONS title: DEFAULT_OPTIONS --- -# Variable: DEFAULT\_OPTIONS - ```ts const DEFAULT_OPTIONS: HotkeysProviderOptions = {}; ``` diff --git a/docs/framework/svelte/reference/variables/HotkeysProvider.md b/docs/framework/svelte/reference/variables/HotkeysProvider.md index bee07fb6..dfa5884b 100644 --- a/docs/framework/svelte/reference/variables/HotkeysProvider.md +++ b/docs/framework/svelte/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: LegacyComponentType; ``` diff --git a/docs/framework/vue/reference/functions/provideHotkeysContext.md b/docs/framework/vue/reference/functions/provideHotkeysContext.md index fce843db..3b1b6276 100644 --- a/docs/framework/vue/reference/functions/provideHotkeysContext.md +++ b/docs/framework/vue/reference/functions/provideHotkeysContext.md @@ -3,8 +3,6 @@ id: provideHotkeysContext title: provideHotkeysContext --- -# Function: provideHotkeysContext() - ```ts function provideHotkeysContext(defaultOptions?): void; ``` diff --git a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md index 0f2a1618..1a24f5b6 100644 --- a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeyCodes.md b/docs/framework/vue/reference/functions/useHeldKeyCodes.md index 0c966e33..b842e8ec 100644 --- a/docs/framework/vue/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/vue/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Ref>; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeys.md b/docs/framework/vue/reference/functions/useHeldKeys.md index a542a24e..01c56135 100644 --- a/docs/framework/vue/reference/functions/useHeldKeys.md +++ b/docs/framework/vue/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): Ref; ``` diff --git a/docs/framework/vue/reference/functions/useHotkey.md b/docs/framework/vue/reference/functions/useHotkey.md index ada21331..7beac482 100644 --- a/docs/framework/vue/reference/functions/useHotkey.md +++ b/docs/framework/vue/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/vue/reference/functions/useHotkeyRecorder.md b/docs/framework/vue/reference/functions/useHotkeyRecorder.md index ec662e10..b1bc2cd9 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): VueHotkeyRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md index ca2ac234..c560858a 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequence.md b/docs/framework/vue/reference/functions/useHotkeySequence.md index ab7449aa..649007a5 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequence.md +++ b/docs/framework/vue/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md index 39cab190..2575b6c5 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): VueHotkeySequenceRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequences.md b/docs/framework/vue/reference/functions/useHotkeySequences.md index 81d75a4f..4474e240 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequences.md +++ b/docs/framework/vue/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeys.md b/docs/framework/vue/reference/functions/useHotkeys.md index 46c0a2fc..18d39f39 100644 --- a/docs/framework/vue/reference/functions/useHotkeys.md +++ b/docs/framework/vue/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeysContext.md b/docs/framework/vue/reference/functions/useHotkeysContext.md index eb046dcd..4cab43e7 100644 --- a/docs/framework/vue/reference/functions/useHotkeysContext.md +++ b/docs/framework/vue/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/vue/reference/functions/useKeyHold.md b/docs/framework/vue/reference/functions/useKeyHold.md index 0a9aab55..99307045 100644 --- a/docs/framework/vue/reference/functions/useKeyHold.md +++ b/docs/framework/vue/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): Ref; ``` diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 9152bc1c..aa5a3f02 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/vue-hotkeys" title: "@tanstack/vue-hotkeys" --- -# @tanstack/vue-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md index 3efc2c54..ef325fd8 100644 --- a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [packages/vue-hotkeys/src/useHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRegistrations.ts#L16) Return type for useHotkeyRegistrations. diff --git a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md index 3f0337e9..9f3f89ce 100644 --- a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [packages/vue-hotkeys/src/HotkeysProviderContext.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/HotkeysProviderContext.ts#L10) ## Properties diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md index 5ddaf0f5..aa9d40d1 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [packages/vue-hotkeys/src/useHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeys.ts#L19) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md index 345c018e..5706100b 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [packages/vue-hotkeys/src/useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md index 669d1ead..c8f4dacc 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [packages/vue-hotkeys/src/useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md index 1f743bb7..ffb39d89 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [packages/vue-hotkeys/src/useHotkeySequence.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequence.ts#L12) ## Extends diff --git a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md index 27c3783c..359eed7c 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md @@ -3,8 +3,6 @@ id: VueHotkeyRecorder title: VueHotkeyRecorder --- -# Interface: VueHotkeyRecorder - Defined in: [packages/vue-hotkeys/src/useHotkeyRecorder.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRecorder.ts#L8) ## Properties diff --git a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md index 4a8ed2ba..6626466b 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: VueHotkeySequenceRecorder title: VueHotkeySequenceRecorder --- -# Interface: VueHotkeySequenceRecorder - Defined in: [packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts#L11) ## Properties diff --git a/docs/framework/vue/reference/variables/HotkeysProvider.md b/docs/framework/vue/reference/variables/HotkeysProvider.md index eaef0d1d..9915de95 100644 --- a/docs/framework/vue/reference/variables/HotkeysProvider.md +++ b/docs/framework/vue/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: DefineComponent void; ``` diff --git a/docs/reference/functions/createSequenceMatcher.md b/docs/reference/functions/createSequenceMatcher.md index dd9e94a8..2f010229 100644 --- a/docs/reference/functions/createSequenceMatcher.md +++ b/docs/reference/functions/createSequenceMatcher.md @@ -3,8 +3,6 @@ id: createSequenceMatcher title: createSequenceMatcher --- -# Function: createSequenceMatcher() - ```ts function createSequenceMatcher(sequence, options): object; ``` diff --git a/docs/reference/functions/detectPlatform.md b/docs/reference/functions/detectPlatform.md index 398b396f..602a755e 100644 --- a/docs/reference/functions/detectPlatform.md +++ b/docs/reference/functions/detectPlatform.md @@ -3,8 +3,6 @@ id: detectPlatform title: detectPlatform --- -# Function: detectPlatform() - ```ts function detectPlatform(): "mac" | "windows" | "linux"; ``` diff --git a/docs/reference/functions/formatForDisplay.md b/docs/reference/functions/formatForDisplay.md index 2f6ed013..592d8c09 100644 --- a/docs/reference/functions/formatForDisplay.md +++ b/docs/reference/functions/formatForDisplay.md @@ -3,8 +3,6 @@ id: formatForDisplay title: formatForDisplay --- -# Function: formatForDisplay() - ```ts function formatForDisplay(hotkey, options): string; ``` diff --git a/docs/reference/functions/formatHotkey.md b/docs/reference/functions/formatHotkey.md index 205c3db7..3ec71059 100644 --- a/docs/reference/functions/formatHotkey.md +++ b/docs/reference/functions/formatHotkey.md @@ -3,8 +3,6 @@ id: formatHotkey title: formatHotkey --- -# Function: formatHotkey() - ```ts function formatHotkey(parsed): string; ``` diff --git a/docs/reference/functions/formatHotkeySequence.md b/docs/reference/functions/formatHotkeySequence.md index 78ba16d6..8dc91096 100644 --- a/docs/reference/functions/formatHotkeySequence.md +++ b/docs/reference/functions/formatHotkeySequence.md @@ -3,8 +3,6 @@ id: formatHotkeySequence title: formatHotkeySequence --- -# Function: formatHotkeySequence() - ```ts function formatHotkeySequence(sequence): string; ``` diff --git a/docs/reference/functions/formatWithLabels.md b/docs/reference/functions/formatWithLabels.md index 5bb4540f..67bc9641 100644 --- a/docs/reference/functions/formatWithLabels.md +++ b/docs/reference/functions/formatWithLabels.md @@ -3,8 +3,6 @@ id: formatWithLabels title: formatWithLabels --- -# ~~Function: formatWithLabels()~~ - ```ts function formatWithLabels(hotkey, options): string; ``` diff --git a/docs/reference/functions/getHotkeyManager.md b/docs/reference/functions/getHotkeyManager.md index a207e54e..7b5e6a46 100644 --- a/docs/reference/functions/getHotkeyManager.md +++ b/docs/reference/functions/getHotkeyManager.md @@ -3,8 +3,6 @@ id: getHotkeyManager title: getHotkeyManager --- -# Function: getHotkeyManager() - ```ts function getHotkeyManager(): HotkeyManager; ``` diff --git a/docs/reference/functions/getKeyStateTracker.md b/docs/reference/functions/getKeyStateTracker.md index c49f8c30..7253ae59 100644 --- a/docs/reference/functions/getKeyStateTracker.md +++ b/docs/reference/functions/getKeyStateTracker.md @@ -3,8 +3,6 @@ id: getKeyStateTracker title: getKeyStateTracker --- -# Function: getKeyStateTracker() - ```ts function getKeyStateTracker(): KeyStateTracker; ``` diff --git a/docs/reference/functions/getSequenceManager.md b/docs/reference/functions/getSequenceManager.md index 227147b6..990e21af 100644 --- a/docs/reference/functions/getSequenceManager.md +++ b/docs/reference/functions/getSequenceManager.md @@ -3,8 +3,6 @@ id: getSequenceManager title: getSequenceManager --- -# Function: getSequenceManager() - ```ts function getSequenceManager(): SequenceManager; ``` diff --git a/docs/reference/functions/hasNonModifierKey.md b/docs/reference/functions/hasNonModifierKey.md index 064c711b..208f6d67 100644 --- a/docs/reference/functions/hasNonModifierKey.md +++ b/docs/reference/functions/hasNonModifierKey.md @@ -3,8 +3,6 @@ id: hasNonModifierKey title: hasNonModifierKey --- -# Function: hasNonModifierKey() - ```ts function hasNonModifierKey(hotkey, platform): boolean; ``` diff --git a/docs/reference/functions/isModifierKey.md b/docs/reference/functions/isModifierKey.md index 092649ae..c71001f5 100644 --- a/docs/reference/functions/isModifierKey.md +++ b/docs/reference/functions/isModifierKey.md @@ -3,8 +3,6 @@ id: isModifierKey title: isModifierKey --- -# Function: isModifierKey() - ```ts function isModifierKey(key): key is string; ``` diff --git a/docs/reference/functions/isSingleLetterKey.md b/docs/reference/functions/isSingleLetterKey.md index 1ea427a2..278fcb3a 100644 --- a/docs/reference/functions/isSingleLetterKey.md +++ b/docs/reference/functions/isSingleLetterKey.md @@ -3,8 +3,6 @@ id: isSingleLetterKey title: isSingleLetterKey --- -# Function: isSingleLetterKey() - ```ts function isSingleLetterKey(key): boolean; ``` diff --git a/docs/reference/functions/matchesKeyboardEvent.md b/docs/reference/functions/matchesKeyboardEvent.md index f42c110e..eaa950c5 100644 --- a/docs/reference/functions/matchesKeyboardEvent.md +++ b/docs/reference/functions/matchesKeyboardEvent.md @@ -3,8 +3,6 @@ id: matchesKeyboardEvent title: matchesKeyboardEvent --- -# Function: matchesKeyboardEvent() - ```ts function matchesKeyboardEvent( event, diff --git a/docs/reference/functions/normalizeHotkey.md b/docs/reference/functions/normalizeHotkey.md index dd0517c0..d99ef9dd 100644 --- a/docs/reference/functions/normalizeHotkey.md +++ b/docs/reference/functions/normalizeHotkey.md @@ -3,8 +3,6 @@ id: normalizeHotkey title: normalizeHotkey --- -# Function: normalizeHotkey() - ```ts function normalizeHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromEvent.md b/docs/reference/functions/normalizeHotkeyFromEvent.md index 08e50a4a..a1ecc4e8 100644 --- a/docs/reference/functions/normalizeHotkeyFromEvent.md +++ b/docs/reference/functions/normalizeHotkeyFromEvent.md @@ -3,8 +3,6 @@ id: normalizeHotkeyFromEvent title: normalizeHotkeyFromEvent --- -# Function: normalizeHotkeyFromEvent() - ```ts function normalizeHotkeyFromEvent(event, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromParsed.md b/docs/reference/functions/normalizeHotkeyFromParsed.md index a758a693..68be83c3 100644 --- a/docs/reference/functions/normalizeHotkeyFromParsed.md +++ b/docs/reference/functions/normalizeHotkeyFromParsed.md @@ -3,8 +3,6 @@ id: normalizeHotkeyFromParsed title: normalizeHotkeyFromParsed --- -# Function: normalizeHotkeyFromParsed() - ```ts function normalizeHotkeyFromParsed(parsed, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeKeyName.md b/docs/reference/functions/normalizeKeyName.md index cb9e252d..d8c17cc2 100644 --- a/docs/reference/functions/normalizeKeyName.md +++ b/docs/reference/functions/normalizeKeyName.md @@ -3,8 +3,6 @@ id: normalizeKeyName title: normalizeKeyName --- -# Function: normalizeKeyName() - ```ts function normalizeKeyName(key): string; ``` diff --git a/docs/reference/functions/normalizeRegisterableHotkey.md b/docs/reference/functions/normalizeRegisterableHotkey.md index 4ef427a2..e52f60dc 100644 --- a/docs/reference/functions/normalizeRegisterableHotkey.md +++ b/docs/reference/functions/normalizeRegisterableHotkey.md @@ -3,8 +3,6 @@ id: normalizeRegisterableHotkey title: normalizeRegisterableHotkey --- -# Function: normalizeRegisterableHotkey() - ```ts function normalizeRegisterableHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/parseHotkey.md b/docs/reference/functions/parseHotkey.md index 5dd538e5..31e38958 100644 --- a/docs/reference/functions/parseHotkey.md +++ b/docs/reference/functions/parseHotkey.md @@ -3,8 +3,6 @@ id: parseHotkey title: parseHotkey --- -# Function: parseHotkey() - ```ts function parseHotkey(hotkey, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/parseKeyboardEvent.md b/docs/reference/functions/parseKeyboardEvent.md index 10f41a76..bd38db36 100644 --- a/docs/reference/functions/parseKeyboardEvent.md +++ b/docs/reference/functions/parseKeyboardEvent.md @@ -3,8 +3,6 @@ id: parseKeyboardEvent title: parseKeyboardEvent --- -# Function: parseKeyboardEvent() - ```ts function parseKeyboardEvent(event): ParsedHotkey; ``` diff --git a/docs/reference/functions/rawHotkeyToParsedHotkey.md b/docs/reference/functions/rawHotkeyToParsedHotkey.md index 94583c4e..c32bd52b 100644 --- a/docs/reference/functions/rawHotkeyToParsedHotkey.md +++ b/docs/reference/functions/rawHotkeyToParsedHotkey.md @@ -3,8 +3,6 @@ id: rawHotkeyToParsedHotkey title: rawHotkeyToParsedHotkey --- -# Function: rawHotkeyToParsedHotkey() - ```ts function rawHotkeyToParsedHotkey(raw, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/resolveModifier.md b/docs/reference/functions/resolveModifier.md index 81b4fb95..473d6a65 100644 --- a/docs/reference/functions/resolveModifier.md +++ b/docs/reference/functions/resolveModifier.md @@ -3,8 +3,6 @@ id: resolveModifier title: resolveModifier --- -# Function: resolveModifier() - ```ts function resolveModifier(modifier, platform): CanonicalModifier; ``` diff --git a/docs/reference/functions/toHotkeyRegistrationView.md b/docs/reference/functions/toHotkeyRegistrationView.md index cea0babe..df1a5f75 100644 --- a/docs/reference/functions/toHotkeyRegistrationView.md +++ b/docs/reference/functions/toHotkeyRegistrationView.md @@ -3,8 +3,6 @@ id: toHotkeyRegistrationView title: toHotkeyRegistrationView --- -# Function: toHotkeyRegistrationView() - ```ts function toHotkeyRegistrationView(reg): HotkeyRegistrationView; ``` diff --git a/docs/reference/functions/validateHotkey.md b/docs/reference/functions/validateHotkey.md index d75bd402..176cd973 100644 --- a/docs/reference/functions/validateHotkey.md +++ b/docs/reference/functions/validateHotkey.md @@ -3,8 +3,6 @@ id: validateHotkey title: validateHotkey --- -# Function: validateHotkey() - ```ts function validateHotkey(hotkey): ValidationResult; ``` diff --git a/docs/reference/index.md b/docs/reference/index.md index fd8f77db..b4307222 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/hotkeys" title: "@tanstack/hotkeys" --- -# @tanstack/hotkeys - ## Classes - [HotkeyManager](classes/HotkeyManager.md) diff --git a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md index 7ff01012..d0a7d280 100644 --- a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md +++ b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyHandlerOptions title: CreateHotkeyHandlerOptions --- -# Interface: CreateHotkeyHandlerOptions - Defined in: [match.ts:132](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/match.ts#L132) Options for creating a hotkey handler. diff --git a/docs/reference/interfaces/FormatDisplayOptions.md b/docs/reference/interfaces/FormatDisplayOptions.md index 724e2044..ba92ff51 100644 --- a/docs/reference/interfaces/FormatDisplayOptions.md +++ b/docs/reference/interfaces/FormatDisplayOptions.md @@ -3,8 +3,6 @@ id: FormatDisplayOptions title: FormatDisplayOptions --- -# Interface: FormatDisplayOptions - Defined in: [hotkey.ts:367](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L367) Options for formatting hotkeys for display. diff --git a/docs/reference/interfaces/HotkeyCallbackContext.md b/docs/reference/interfaces/HotkeyCallbackContext.md index edacfce8..c323fb71 100644 --- a/docs/reference/interfaces/HotkeyCallbackContext.md +++ b/docs/reference/interfaces/HotkeyCallbackContext.md @@ -3,8 +3,6 @@ id: HotkeyCallbackContext title: HotkeyCallbackContext --- -# Interface: HotkeyCallbackContext - Defined in: [hotkey.ts:391](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L391) Context passed to hotkey callbacks along with the keyboard event. diff --git a/docs/reference/interfaces/HotkeyMeta.md b/docs/reference/interfaces/HotkeyMeta.md index f0d5fe6f..46b379be 100644 --- a/docs/reference/interfaces/HotkeyMeta.md +++ b/docs/reference/interfaces/HotkeyMeta.md @@ -3,8 +3,6 @@ id: HotkeyMeta title: HotkeyMeta --- -# Interface: HotkeyMeta - Defined in: [hotkey.ts:431](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L431) Metadata for hotkey and sequence registrations. diff --git a/docs/reference/interfaces/HotkeyOptions.md b/docs/reference/interfaces/HotkeyOptions.md index 0e637c02..c172d129 100644 --- a/docs/reference/interfaces/HotkeyOptions.md +++ b/docs/reference/interfaces/HotkeyOptions.md @@ -3,8 +3,6 @@ id: HotkeyOptions title: HotkeyOptions --- -# Interface: HotkeyOptions - Defined in: [hotkey-manager.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L28) Options for registering a hotkey. diff --git a/docs/reference/interfaces/HotkeyRecorderOptions.md b/docs/reference/interfaces/HotkeyRecorderOptions.md index 20b6fb57..e1e108bf 100644 --- a/docs/reference/interfaces/HotkeyRecorderOptions.md +++ b/docs/reference/interfaces/HotkeyRecorderOptions.md @@ -3,8 +3,6 @@ id: HotkeyRecorderOptions title: HotkeyRecorderOptions --- -# Interface: HotkeyRecorderOptions - Defined in: [hotkey-recorder.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L20) Options for configuring a HotkeyRecorder instance. diff --git a/docs/reference/interfaces/HotkeyRecorderState.md b/docs/reference/interfaces/HotkeyRecorderState.md index cda4de56..0ed52a47 100644 --- a/docs/reference/interfaces/HotkeyRecorderState.md +++ b/docs/reference/interfaces/HotkeyRecorderState.md @@ -3,8 +3,6 @@ id: HotkeyRecorderState title: HotkeyRecorderState --- -# Interface: HotkeyRecorderState - Defined in: [hotkey-recorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L10) State interface for the HotkeyRecorder. diff --git a/docs/reference/interfaces/HotkeyRegistration.md b/docs/reference/interfaces/HotkeyRegistration.md index 775f7d88..083e9c79 100644 --- a/docs/reference/interfaces/HotkeyRegistration.md +++ b/docs/reference/interfaces/HotkeyRegistration.md @@ -3,8 +3,6 @@ id: HotkeyRegistration title: HotkeyRegistration --- -# Interface: HotkeyRegistration - Defined in: [hotkey-manager.ts:58](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L58) A registered hotkey handler in the HotkeyManager. diff --git a/docs/reference/interfaces/HotkeyRegistrationHandle.md b/docs/reference/interfaces/HotkeyRegistrationHandle.md index 981883db..608fb6d5 100644 --- a/docs/reference/interfaces/HotkeyRegistrationHandle.md +++ b/docs/reference/interfaces/HotkeyRegistrationHandle.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationHandle title: HotkeyRegistrationHandle --- -# Interface: HotkeyRegistrationHandle - Defined in: [hotkey-manager.ts:139](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L139) A handle returned from HotkeyManager.register() that allows updating diff --git a/docs/reference/interfaces/HotkeyRegistrationView.md b/docs/reference/interfaces/HotkeyRegistrationView.md index b7c4d8d3..c93f2101 100644 --- a/docs/reference/interfaces/HotkeyRegistrationView.md +++ b/docs/reference/interfaces/HotkeyRegistrationView.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationView title: HotkeyRegistrationView --- -# Interface: HotkeyRegistrationView - Defined in: [hotkey-manager.ts:81](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L81) Public view of a hotkey registration for display and introspection. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md index a330eb36..7984ab20 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderOptions title: HotkeySequenceRecorderOptions --- -# Interface: HotkeySequenceRecorderOptions - Defined in: [hotkey-sequence-recorder.ts:29](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L29) Options for configuring a HotkeySequenceRecorder instance. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderState.md b/docs/reference/interfaces/HotkeySequenceRecorderState.md index 10330799..c66a6be1 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderState.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderState.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderState title: HotkeySequenceRecorderState --- -# Interface: HotkeySequenceRecorderState - Defined in: [hotkey-sequence-recorder.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L17) State interface for the HotkeySequenceRecorder. diff --git a/docs/reference/interfaces/KeyStateTrackerState.md b/docs/reference/interfaces/KeyStateTrackerState.md index d256a258..e0c4cbc7 100644 --- a/docs/reference/interfaces/KeyStateTrackerState.md +++ b/docs/reference/interfaces/KeyStateTrackerState.md @@ -3,8 +3,6 @@ id: KeyStateTrackerState title: KeyStateTrackerState --- -# Interface: KeyStateTrackerState - Defined in: [key-state-tracker.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/key-state-tracker.ts#L7) State interface for the KeyStateTracker. diff --git a/docs/reference/interfaces/ParsedHotkey.md b/docs/reference/interfaces/ParsedHotkey.md index a142d43c..7facd5ad 100644 --- a/docs/reference/interfaces/ParsedHotkey.md +++ b/docs/reference/interfaces/ParsedHotkey.md @@ -3,8 +3,6 @@ id: ParsedHotkey title: ParsedHotkey --- -# Interface: ParsedHotkey - Defined in: [hotkey.ts:308](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L308) A parsed representation of a hotkey string. diff --git a/docs/reference/interfaces/RawHotkey.md b/docs/reference/interfaces/RawHotkey.md index a0255a8f..36646b3e 100644 --- a/docs/reference/interfaces/RawHotkey.md +++ b/docs/reference/interfaces/RawHotkey.md @@ -3,8 +3,6 @@ id: RawHotkey title: RawHotkey --- -# Interface: RawHotkey - Defined in: [hotkey.ts:343](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L343) A raw hotkey object for programmatic registration. diff --git a/docs/reference/interfaces/SequenceOptions.md b/docs/reference/interfaces/SequenceOptions.md index b021d339..0bbdad42 100644 --- a/docs/reference/interfaces/SequenceOptions.md +++ b/docs/reference/interfaces/SequenceOptions.md @@ -3,8 +3,6 @@ id: SequenceOptions title: SequenceOptions --- -# Interface: SequenceOptions - Defined in: [sequence-manager.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L27) Options for hotkey sequence matching. diff --git a/docs/reference/interfaces/SequenceRegistrationHandle.md b/docs/reference/interfaces/SequenceRegistrationHandle.md index c659add7..291816d7 100644 --- a/docs/reference/interfaces/SequenceRegistrationHandle.md +++ b/docs/reference/interfaces/SequenceRegistrationHandle.md @@ -3,8 +3,6 @@ id: SequenceRegistrationHandle title: SequenceRegistrationHandle --- -# Interface: SequenceRegistrationHandle - Defined in: [sequence-manager.ts:119](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L119) A handle returned from SequenceManager.register() that allows updating diff --git a/docs/reference/interfaces/SequenceRegistrationView.md b/docs/reference/interfaces/SequenceRegistrationView.md index 55df6d72..0272083e 100644 --- a/docs/reference/interfaces/SequenceRegistrationView.md +++ b/docs/reference/interfaces/SequenceRegistrationView.md @@ -3,8 +3,6 @@ id: SequenceRegistrationView title: SequenceRegistrationView --- -# Interface: SequenceRegistrationView - Defined in: [sequence-manager.ts:76](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L76) View of a sequence registration for devtools display. diff --git a/docs/reference/interfaces/ValidationResult.md b/docs/reference/interfaces/ValidationResult.md index fc7e9c1e..240718fa 100644 --- a/docs/reference/interfaces/ValidationResult.md +++ b/docs/reference/interfaces/ValidationResult.md @@ -3,8 +3,6 @@ id: ValidationResult title: ValidationResult --- -# Interface: ValidationResult - Defined in: [hotkey.ts:379](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L379) Result of validating a hotkey string. diff --git a/docs/reference/type-aliases/CanonicalModifier.md b/docs/reference/type-aliases/CanonicalModifier.md index 02292671..53756874 100644 --- a/docs/reference/type-aliases/CanonicalModifier.md +++ b/docs/reference/type-aliases/CanonicalModifier.md @@ -3,8 +3,6 @@ id: CanonicalModifier title: CanonicalModifier --- -# Type Alias: CanonicalModifier - ```ts type CanonicalModifier = "Control" | "Shift" | "Alt" | "Meta"; ``` diff --git a/docs/reference/type-aliases/ConflictBehavior.md b/docs/reference/type-aliases/ConflictBehavior.md index 50f06ca9..3d6eac28 100644 --- a/docs/reference/type-aliases/ConflictBehavior.md +++ b/docs/reference/type-aliases/ConflictBehavior.md @@ -3,8 +3,6 @@ id: ConflictBehavior title: ConflictBehavior --- -# Type Alias: ConflictBehavior - ```ts type ConflictBehavior = "warn" | "error" | "replace" | "allow"; ``` diff --git a/docs/reference/type-aliases/EditingKey.md b/docs/reference/type-aliases/EditingKey.md index 7c1bb264..b2c6d964 100644 --- a/docs/reference/type-aliases/EditingKey.md +++ b/docs/reference/type-aliases/EditingKey.md @@ -3,8 +3,6 @@ id: EditingKey title: EditingKey --- -# Type Alias: EditingKey - ```ts type EditingKey = "Enter" | "Escape" | "Space" | "Tab" | "Backspace" | "Delete"; ``` diff --git a/docs/reference/type-aliases/FunctionKey.md b/docs/reference/type-aliases/FunctionKey.md index d2b42f26..7474b4c2 100644 --- a/docs/reference/type-aliases/FunctionKey.md +++ b/docs/reference/type-aliases/FunctionKey.md @@ -3,8 +3,6 @@ id: FunctionKey title: FunctionKey --- -# Type Alias: FunctionKey - ```ts type FunctionKey = | "F1" diff --git a/docs/reference/type-aliases/Hotkey.md b/docs/reference/type-aliases/Hotkey.md index 6a8c5ad0..d1fbd3e3 100644 --- a/docs/reference/type-aliases/Hotkey.md +++ b/docs/reference/type-aliases/Hotkey.md @@ -3,8 +3,6 @@ id: Hotkey title: Hotkey --- -# Type Alias: Hotkey - ```ts type Hotkey = | Key diff --git a/docs/reference/type-aliases/HotkeyCallback.md b/docs/reference/type-aliases/HotkeyCallback.md index 9189e693..cdabb517 100644 --- a/docs/reference/type-aliases/HotkeyCallback.md +++ b/docs/reference/type-aliases/HotkeyCallback.md @@ -3,8 +3,6 @@ id: HotkeyCallback title: HotkeyCallback --- -# Type Alias: HotkeyCallback() - ```ts type HotkeyCallback = (event, context) => void; ``` diff --git a/docs/reference/type-aliases/HotkeySequence.md b/docs/reference/type-aliases/HotkeySequence.md index 9fc95653..fd66c317 100644 --- a/docs/reference/type-aliases/HotkeySequence.md +++ b/docs/reference/type-aliases/HotkeySequence.md @@ -3,8 +3,6 @@ id: HotkeySequence title: HotkeySequence --- -# Type Alias: HotkeySequence - ```ts type HotkeySequence = Hotkey[]; ``` diff --git a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md index 8a84b6ca..0dcdb13b 100644 --- a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md +++ b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderCommitKeys title: HotkeySequenceRecorderCommitKeys --- -# Type Alias: HotkeySequenceRecorderCommitKeys - ```ts type HotkeySequenceRecorderCommitKeys = "enter" | "none"; ``` diff --git a/docs/reference/type-aliases/IndividualKey.md b/docs/reference/type-aliases/IndividualKey.md index 84f2e4ca..0a207795 100644 --- a/docs/reference/type-aliases/IndividualKey.md +++ b/docs/reference/type-aliases/IndividualKey.md @@ -3,8 +3,6 @@ id: IndividualKey title: IndividualKey --- -# Type Alias: IndividualKey - ```ts type IndividualKey = CanonicalModifier | Key; ``` diff --git a/docs/reference/type-aliases/Key.md b/docs/reference/type-aliases/Key.md index 01baa032..6b86598b 100644 --- a/docs/reference/type-aliases/Key.md +++ b/docs/reference/type-aliases/Key.md @@ -3,8 +3,6 @@ id: Key title: Key --- -# Type Alias: Key - ```ts type Key = NonPunctuationKey | PunctuationKey; ``` diff --git a/docs/reference/type-aliases/LetterKey.md b/docs/reference/type-aliases/LetterKey.md index 916c7fbc..d26b41ef 100644 --- a/docs/reference/type-aliases/LetterKey.md +++ b/docs/reference/type-aliases/LetterKey.md @@ -3,8 +3,6 @@ id: LetterKey title: LetterKey --- -# Type Alias: LetterKey - ```ts type LetterKey = | "A" diff --git a/docs/reference/type-aliases/Modifier.md b/docs/reference/type-aliases/Modifier.md index 854d8b14..b7b70cf6 100644 --- a/docs/reference/type-aliases/Modifier.md +++ b/docs/reference/type-aliases/Modifier.md @@ -3,8 +3,6 @@ id: Modifier title: Modifier --- -# Type Alias: Modifier - ```ts type Modifier = | "Control" diff --git a/docs/reference/type-aliases/NavigationKey.md b/docs/reference/type-aliases/NavigationKey.md index a1f940b2..4322f82f 100644 --- a/docs/reference/type-aliases/NavigationKey.md +++ b/docs/reference/type-aliases/NavigationKey.md @@ -3,8 +3,6 @@ id: NavigationKey title: NavigationKey --- -# Type Alias: NavigationKey - ```ts type NavigationKey = | "ArrowUp" diff --git a/docs/reference/type-aliases/NumberKey.md b/docs/reference/type-aliases/NumberKey.md index 639b3664..3a2cf3c1 100644 --- a/docs/reference/type-aliases/NumberKey.md +++ b/docs/reference/type-aliases/NumberKey.md @@ -3,8 +3,6 @@ id: NumberKey title: NumberKey --- -# Type Alias: NumberKey - ```ts type NumberKey = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"; ``` diff --git a/docs/reference/type-aliases/PunctuationKey.md b/docs/reference/type-aliases/PunctuationKey.md index 9dda1dbe..086300a6 100644 --- a/docs/reference/type-aliases/PunctuationKey.md +++ b/docs/reference/type-aliases/PunctuationKey.md @@ -3,8 +3,6 @@ id: PunctuationKey title: PunctuationKey --- -# Type Alias: PunctuationKey - ```ts type PunctuationKey = "/" | "[" | "]" | "\" | "=" | "-" | "," | "." | ";" | "`"; ``` diff --git a/docs/reference/type-aliases/RegisterableHotkey.md b/docs/reference/type-aliases/RegisterableHotkey.md index ca996bbf..ff361eca 100644 --- a/docs/reference/type-aliases/RegisterableHotkey.md +++ b/docs/reference/type-aliases/RegisterableHotkey.md @@ -3,8 +3,6 @@ id: RegisterableHotkey title: RegisterableHotkey --- -# Type Alias: RegisterableHotkey - ```ts type RegisterableHotkey = Hotkey | RawHotkey; ``` diff --git a/docs/reference/variables/ALL_KEYS.md b/docs/reference/variables/ALL_KEYS.md index fa471104..eea26a0b 100644 --- a/docs/reference/variables/ALL_KEYS.md +++ b/docs/reference/variables/ALL_KEYS.md @@ -3,8 +3,6 @@ id: ALL_KEYS title: ALL_KEYS --- -# Variable: ALL\_KEYS - ```ts const ALL_KEYS: Set< | LetterKey diff --git a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md index 44098858..21b43843 100644 --- a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md +++ b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md @@ -3,8 +3,6 @@ id: DEFAULT_SEQUENCE_TIMEOUT title: DEFAULT_SEQUENCE_TIMEOUT --- -# Variable: DEFAULT\_SEQUENCE\_TIMEOUT - ```ts const DEFAULT_SEQUENCE_TIMEOUT: 1000 = 1000; ``` diff --git a/docs/reference/variables/EDITING_KEYS.md b/docs/reference/variables/EDITING_KEYS.md index 9d7d717b..8ab1867d 100644 --- a/docs/reference/variables/EDITING_KEYS.md +++ b/docs/reference/variables/EDITING_KEYS.md @@ -3,8 +3,6 @@ id: EDITING_KEYS title: EDITING_KEYS --- -# Variable: EDITING\_KEYS - ```ts const EDITING_KEYS: Set; ``` diff --git a/docs/reference/variables/FUNCTION_KEYS.md b/docs/reference/variables/FUNCTION_KEYS.md index 7dc7311c..a080334b 100644 --- a/docs/reference/variables/FUNCTION_KEYS.md +++ b/docs/reference/variables/FUNCTION_KEYS.md @@ -3,8 +3,6 @@ id: FUNCTION_KEYS title: FUNCTION_KEYS --- -# Variable: FUNCTION\_KEYS - ```ts const FUNCTION_KEYS: Set; ``` diff --git a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md index 3e7a1715..ab3ae732 100644 --- a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md +++ b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md @@ -3,8 +3,6 @@ id: KEY_DISPLAY_SYMBOLS title: KEY_DISPLAY_SYMBOLS --- -# Variable: KEY\_DISPLAY\_SYMBOLS - ```ts const KEY_DISPLAY_SYMBOLS: object; ``` diff --git a/docs/reference/variables/LETTER_KEYS.md b/docs/reference/variables/LETTER_KEYS.md index 029e2998..ff488ad5 100644 --- a/docs/reference/variables/LETTER_KEYS.md +++ b/docs/reference/variables/LETTER_KEYS.md @@ -3,8 +3,6 @@ id: LETTER_KEYS title: LETTER_KEYS --- -# Variable: LETTER\_KEYS - ```ts const LETTER_KEYS: Set; ``` diff --git a/docs/reference/variables/LINUX_MODIFIER_LABELS.md b/docs/reference/variables/LINUX_MODIFIER_LABELS.md index ccd7bb39..b6b0bbbd 100644 --- a/docs/reference/variables/LINUX_MODIFIER_LABELS.md +++ b/docs/reference/variables/LINUX_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: LINUX_MODIFIER_LABELS title: LINUX_MODIFIER_LABELS --- -# Variable: LINUX\_MODIFIER\_LABELS - ```ts const LINUX_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_LABELS.md b/docs/reference/variables/MAC_MODIFIER_LABELS.md index 4d2dd13b..3a67ab96 100644 --- a/docs/reference/variables/MAC_MODIFIER_LABELS.md +++ b/docs/reference/variables/MAC_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: MAC_MODIFIER_LABELS title: MAC_MODIFIER_LABELS --- -# Variable: MAC\_MODIFIER\_LABELS - ```ts const MAC_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md index 66f0949f..2a5fb855 100644 --- a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md +++ b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md @@ -3,8 +3,6 @@ id: MAC_MODIFIER_SYMBOLS title: MAC_MODIFIER_SYMBOLS --- -# Variable: MAC\_MODIFIER\_SYMBOLS - ```ts const MAC_MODIFIER_SYMBOLS: Record; ``` diff --git a/docs/reference/variables/MODIFIER_ALIASES.md b/docs/reference/variables/MODIFIER_ALIASES.md index d9f2e146..bf1c705f 100644 --- a/docs/reference/variables/MODIFIER_ALIASES.md +++ b/docs/reference/variables/MODIFIER_ALIASES.md @@ -3,8 +3,6 @@ id: MODIFIER_ALIASES title: MODIFIER_ALIASES --- -# Variable: MODIFIER\_ALIASES - ```ts const MODIFIER_ALIASES: Record; ``` diff --git a/docs/reference/variables/MODIFIER_KEYS.md b/docs/reference/variables/MODIFIER_KEYS.md index b289d5ae..d106ab14 100644 --- a/docs/reference/variables/MODIFIER_KEYS.md +++ b/docs/reference/variables/MODIFIER_KEYS.md @@ -3,8 +3,6 @@ id: MODIFIER_KEYS title: MODIFIER_KEYS --- -# Variable: MODIFIER\_KEYS - ```ts const MODIFIER_KEYS: Set; ``` diff --git a/docs/reference/variables/MODIFIER_ORDER.md b/docs/reference/variables/MODIFIER_ORDER.md index df05181b..397794eb 100644 --- a/docs/reference/variables/MODIFIER_ORDER.md +++ b/docs/reference/variables/MODIFIER_ORDER.md @@ -3,8 +3,6 @@ id: MODIFIER_ORDER title: MODIFIER_ORDER --- -# Variable: MODIFIER\_ORDER - ```ts const MODIFIER_ORDER: CanonicalModifier[]; ``` diff --git a/docs/reference/variables/NAVIGATION_KEYS.md b/docs/reference/variables/NAVIGATION_KEYS.md index 176feb07..917c62ba 100644 --- a/docs/reference/variables/NAVIGATION_KEYS.md +++ b/docs/reference/variables/NAVIGATION_KEYS.md @@ -3,8 +3,6 @@ id: NAVIGATION_KEYS title: NAVIGATION_KEYS --- -# Variable: NAVIGATION\_KEYS - ```ts const NAVIGATION_KEYS: Set; ``` diff --git a/docs/reference/variables/NUMBER_KEYS.md b/docs/reference/variables/NUMBER_KEYS.md index d1258c24..6da27051 100644 --- a/docs/reference/variables/NUMBER_KEYS.md +++ b/docs/reference/variables/NUMBER_KEYS.md @@ -3,8 +3,6 @@ id: NUMBER_KEYS title: NUMBER_KEYS --- -# Variable: NUMBER\_KEYS - ```ts const NUMBER_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_CODE_MAP.md b/docs/reference/variables/PUNCTUATION_CODE_MAP.md index 69f58b48..6d8bf6ae 100644 --- a/docs/reference/variables/PUNCTUATION_CODE_MAP.md +++ b/docs/reference/variables/PUNCTUATION_CODE_MAP.md @@ -3,8 +3,6 @@ id: PUNCTUATION_CODE_MAP title: PUNCTUATION_CODE_MAP --- -# Variable: PUNCTUATION\_CODE\_MAP - ```ts const PUNCTUATION_CODE_MAP: Record; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEYS.md b/docs/reference/variables/PUNCTUATION_KEYS.md index 4824f594..90f76148 100644 --- a/docs/reference/variables/PUNCTUATION_KEYS.md +++ b/docs/reference/variables/PUNCTUATION_KEYS.md @@ -3,8 +3,6 @@ id: PUNCTUATION_KEYS title: PUNCTUATION_KEYS --- -# Variable: PUNCTUATION\_KEYS - ```ts const PUNCTUATION_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md index 5891854c..3cac002c 100644 --- a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md +++ b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md @@ -3,8 +3,6 @@ id: PUNCTUATION_KEY_DISPLAY_LABELS title: PUNCTUATION_KEY_DISPLAY_LABELS --- -# Variable: PUNCTUATION\_KEY\_DISPLAY\_LABELS - ```ts const PUNCTUATION_KEY_DISPLAY_LABELS: object; ``` diff --git a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md index fb85e6c1..4b1f6829 100644 --- a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md +++ b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: WINDOWS_MODIFIER_LABELS title: WINDOWS_MODIFIER_LABELS --- -# Variable: WINDOWS\_MODIFIER\_LABELS - ```ts const WINDOWS_MODIFIER_LABELS: Record; ``` From 611920ff51d1c3a269f49a6d3a628f5fa188e02d Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 10:49:58 +0000 Subject: [PATCH 2/4] ci: apply automated fixes --- .../angular/reference/functions/injectDefaultHotkeysOptions.md | 2 ++ .../framework/angular/reference/functions/injectHeldKeyCodes.md | 2 ++ docs/framework/angular/reference/functions/injectHeldKeys.md | 2 ++ docs/framework/angular/reference/functions/injectHotkey.md | 2 ++ .../angular/reference/functions/injectHotkeyRecorder.md | 2 ++ .../angular/reference/functions/injectHotkeyRegistrations.md | 2 ++ .../angular/reference/functions/injectHotkeySequence.md | 2 ++ .../angular/reference/functions/injectHotkeySequenceRecorder.md | 2 ++ .../angular/reference/functions/injectHotkeySequences.md | 2 ++ docs/framework/angular/reference/functions/injectHotkeys.md | 2 ++ .../angular/reference/functions/injectHotkeysContext.md | 2 ++ docs/framework/angular/reference/functions/injectKeyHold.md | 2 ++ docs/framework/angular/reference/functions/provideHotkeys.md | 2 ++ docs/framework/angular/reference/index.md | 2 ++ .../angular/reference/interfaces/AngularHotkeyRecorder.md | 2 ++ .../reference/interfaces/AngularHotkeySequenceRecorder.md | 2 ++ .../angular/reference/interfaces/HotkeyRegistrationsResult.md | 2 ++ .../angular/reference/interfaces/HotkeysContextValue.md | 2 ++ .../angular/reference/interfaces/HotkeysProviderOptions.md | 2 ++ .../angular/reference/interfaces/InjectHotkeyDefinition.md | 2 ++ .../angular/reference/interfaces/InjectHotkeyOptions.md | 2 ++ .../reference/interfaces/InjectHotkeySequenceDefinition.md | 2 ++ .../angular/reference/interfaces/InjectHotkeySequenceOptions.md | 2 ++ .../angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md | 2 ++ docs/framework/lit/reference/classes/HeldKeyCodesController.md | 2 ++ docs/framework/lit/reference/classes/HeldKeysController.md | 2 ++ docs/framework/lit/reference/classes/HotkeyController.md | 2 ++ .../framework/lit/reference/classes/HotkeyRecorderController.md | 2 ++ .../lit/reference/classes/HotkeyRegistrationsController.md | 2 ++ .../framework/lit/reference/classes/HotkeySequenceController.md | 2 ++ .../lit/reference/classes/HotkeySequenceRecorderController.md | 2 ++ docs/framework/lit/reference/classes/KeyHoldController.md | 2 ++ docs/framework/lit/reference/functions/hotkey.md | 2 ++ docs/framework/lit/reference/functions/hotkeySequence.md | 2 ++ docs/framework/lit/reference/index.md | 2 ++ docs/framework/preact/reference/functions/HotkeysProvider.md | 2 ++ .../preact/reference/functions/useDefaultHotkeysOptions.md | 2 ++ docs/framework/preact/reference/functions/useHeldKeyCodes.md | 2 ++ docs/framework/preact/reference/functions/useHeldKeys.md | 2 ++ docs/framework/preact/reference/functions/useHotkey.md | 2 ++ docs/framework/preact/reference/functions/useHotkeyRecorder.md | 2 ++ .../preact/reference/functions/useHotkeyRegistrations.md | 2 ++ docs/framework/preact/reference/functions/useHotkeySequence.md | 2 ++ .../preact/reference/functions/useHotkeySequenceRecorder.md | 2 ++ docs/framework/preact/reference/functions/useHotkeySequences.md | 2 ++ docs/framework/preact/reference/functions/useHotkeys.md | 2 ++ docs/framework/preact/reference/functions/useHotkeysContext.md | 2 ++ docs/framework/preact/reference/functions/useKeyHold.md | 2 ++ docs/framework/preact/reference/index.md | 2 ++ .../preact/reference/interfaces/HotkeyRegistrationsResult.md | 2 ++ .../preact/reference/interfaces/HotkeysProviderOptions.md | 2 ++ .../preact/reference/interfaces/HotkeysProviderProps.md | 2 ++ .../preact/reference/interfaces/PreactHotkeyRecorder.md | 2 ++ .../preact/reference/interfaces/PreactHotkeySequenceRecorder.md | 2 ++ .../preact/reference/interfaces/UseHotkeyDefinition.md | 2 ++ docs/framework/preact/reference/interfaces/UseHotkeyOptions.md | 2 ++ .../preact/reference/interfaces/UseHotkeySequenceDefinition.md | 2 ++ .../preact/reference/interfaces/UseHotkeySequenceOptions.md | 2 ++ docs/framework/react/reference/functions/HotkeysProvider.md | 2 ++ .../react/reference/functions/useDefaultHotkeysOptions.md | 2 ++ docs/framework/react/reference/functions/useHeldKeyCodes.md | 2 ++ docs/framework/react/reference/functions/useHeldKeys.md | 2 ++ docs/framework/react/reference/functions/useHotkey.md | 2 ++ docs/framework/react/reference/functions/useHotkeyRecorder.md | 2 ++ .../react/reference/functions/useHotkeyRegistrations.md | 2 ++ docs/framework/react/reference/functions/useHotkeySequence.md | 2 ++ .../react/reference/functions/useHotkeySequenceRecorder.md | 2 ++ docs/framework/react/reference/functions/useHotkeySequences.md | 2 ++ docs/framework/react/reference/functions/useHotkeys.md | 2 ++ docs/framework/react/reference/functions/useHotkeysContext.md | 2 ++ docs/framework/react/reference/functions/useKeyHold.md | 2 ++ docs/framework/react/reference/index.md | 2 ++ .../react/reference/interfaces/HotkeyRegistrationsResult.md | 2 ++ .../react/reference/interfaces/HotkeysProviderOptions.md | 2 ++ .../react/reference/interfaces/HotkeysProviderProps.md | 2 ++ .../framework/react/reference/interfaces/ReactHotkeyRecorder.md | 2 ++ .../react/reference/interfaces/ReactHotkeySequenceRecorder.md | 2 ++ .../framework/react/reference/interfaces/UseHotkeyDefinition.md | 2 ++ docs/framework/react/reference/interfaces/UseHotkeyOptions.md | 2 ++ .../react/reference/interfaces/UseHotkeySequenceDefinition.md | 2 ++ .../react/reference/interfaces/UseHotkeySequenceOptions.md | 2 ++ docs/framework/solid/reference/functions/createHeldKeyCodes.md | 2 ++ docs/framework/solid/reference/functions/createHeldKeys.md | 2 ++ docs/framework/solid/reference/functions/createHotkey.md | 2 ++ .../framework/solid/reference/functions/createHotkeyRecorder.md | 2 ++ .../solid/reference/functions/createHotkeyRegistrations.md | 2 ++ .../framework/solid/reference/functions/createHotkeySequence.md | 2 ++ .../solid/reference/functions/createHotkeySequenceRecorder.md | 2 ++ .../solid/reference/functions/createHotkeySequences.md | 2 ++ docs/framework/solid/reference/functions/createHotkeys.md | 2 ++ docs/framework/solid/reference/functions/createKeyHold.md | 2 ++ .../solid/reference/functions/useDefaultHotkeysOptions.md | 2 ++ docs/framework/solid/reference/functions/useHotkeysContext.md | 2 ++ docs/framework/solid/reference/index.md | 2 ++ .../solid/reference/interfaces/CreateHotkeyDefinition.md | 2 ++ .../framework/solid/reference/interfaces/CreateHotkeyOptions.md | 2 ++ .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 ++ .../solid/reference/interfaces/CreateHotkeySequenceOptions.md | 2 ++ .../solid/reference/interfaces/HotkeyRegistrationsResult.md | 2 ++ .../solid/reference/interfaces/HotkeysProviderOptions.md | 2 ++ .../solid/reference/interfaces/HotkeysProviderProps.md | 2 ++ .../framework/solid/reference/interfaces/SolidHotkeyRecorder.md | 2 ++ .../solid/reference/interfaces/SolidHotkeySequenceRecorder.md | 2 ++ docs/framework/solid/reference/variables/HotkeysProvider.md | 2 ++ docs/framework/svelte/reference/functions/createHotkey.md | 2 ++ .../svelte/reference/functions/createHotkeyAttachment.md | 2 ++ .../svelte/reference/functions/createHotkeyRecorder.md | 2 ++ .../svelte/reference/functions/createHotkeySequence.md | 2 ++ .../reference/functions/createHotkeySequenceAttachment.md | 2 ++ .../svelte/reference/functions/createHotkeySequenceRecorder.md | 2 ++ .../svelte/reference/functions/createHotkeySequences.md | 2 ++ .../reference/functions/createHotkeySequencesAttachment.md | 2 ++ docs/framework/svelte/reference/functions/createHotkeys.md | 2 ++ .../svelte/reference/functions/createHotkeysAttachment.md | 2 ++ .../svelte/reference/functions/getDefaultHotkeysOptions.md | 2 ++ docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md | 2 ++ docs/framework/svelte/reference/functions/getHeldKeys.md | 2 ++ .../svelte/reference/functions/getHotkeyRegistrations.md | 2 ++ docs/framework/svelte/reference/functions/getHotkeysContext.md | 2 ++ docs/framework/svelte/reference/functions/getIsKeyHeld.md | 2 ++ docs/framework/svelte/reference/functions/setHotkeysContext.md | 2 ++ docs/framework/svelte/reference/index.md | 2 ++ .../svelte/reference/interfaces/CreateHotkeyDefinition.md | 2 ++ .../svelte/reference/interfaces/CreateHotkeyOptions.md | 2 ++ .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 ++ .../svelte/reference/interfaces/CreateHotkeySequenceOptions.md | 2 ++ .../svelte/reference/interfaces/HotkeysProviderOptions.md | 2 ++ .../svelte/reference/interfaces/HotkeysProviderProps.md | 2 ++ .../svelte/reference/interfaces/SvelteHeldKeyCodesMap.md | 2 ++ .../framework/svelte/reference/interfaces/SvelteHeldKeyState.md | 2 ++ docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md | 2 ++ .../svelte/reference/interfaces/SvelteHotkeyRecorder.md | 2 ++ .../svelte/reference/interfaces/SvelteHotkeyRegistrations.md | 2 ++ .../svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md | 2 ++ docs/framework/svelte/reference/type-aliases/HotkeysProvider.md | 2 ++ docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md | 2 ++ docs/framework/svelte/reference/variables/HotkeysProvider.md | 2 ++ docs/framework/vue/reference/functions/provideHotkeysContext.md | 2 ++ .../vue/reference/functions/useDefaultHotkeysOptions.md | 2 ++ docs/framework/vue/reference/functions/useHeldKeyCodes.md | 2 ++ docs/framework/vue/reference/functions/useHeldKeys.md | 2 ++ docs/framework/vue/reference/functions/useHotkey.md | 2 ++ docs/framework/vue/reference/functions/useHotkeyRecorder.md | 2 ++ .../framework/vue/reference/functions/useHotkeyRegistrations.md | 2 ++ docs/framework/vue/reference/functions/useHotkeySequence.md | 2 ++ .../vue/reference/functions/useHotkeySequenceRecorder.md | 2 ++ docs/framework/vue/reference/functions/useHotkeySequences.md | 2 ++ docs/framework/vue/reference/functions/useHotkeys.md | 2 ++ docs/framework/vue/reference/functions/useHotkeysContext.md | 2 ++ docs/framework/vue/reference/functions/useKeyHold.md | 2 ++ docs/framework/vue/reference/index.md | 2 ++ .../vue/reference/interfaces/HotkeyRegistrationsResult.md | 2 ++ .../vue/reference/interfaces/HotkeysProviderOptions.md | 2 ++ docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md | 2 ++ docs/framework/vue/reference/interfaces/UseHotkeyOptions.md | 2 ++ .../vue/reference/interfaces/UseHotkeySequenceDefinition.md | 2 ++ .../vue/reference/interfaces/UseHotkeySequenceOptions.md | 2 ++ docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md | 2 ++ .../vue/reference/interfaces/VueHotkeySequenceRecorder.md | 2 ++ docs/framework/vue/reference/variables/HotkeysProvider.md | 2 ++ docs/reference/classes/HotkeyManager.md | 2 ++ docs/reference/classes/HotkeyRecorder.md | 2 ++ docs/reference/classes/HotkeySequenceRecorder.md | 2 ++ docs/reference/classes/KeyStateTracker.md | 2 ++ docs/reference/classes/SequenceManager.md | 2 ++ docs/reference/functions/assertValidHotkey.md | 2 ++ docs/reference/functions/checkHotkey.md | 2 ++ docs/reference/functions/createHotkeyHandler.md | 2 ++ docs/reference/functions/createMultiHotkeyHandler.md | 2 ++ docs/reference/functions/createSequenceMatcher.md | 2 ++ docs/reference/functions/detectPlatform.md | 2 ++ docs/reference/functions/formatForDisplay.md | 2 ++ docs/reference/functions/formatHotkey.md | 2 ++ docs/reference/functions/formatHotkeySequence.md | 2 ++ docs/reference/functions/formatWithLabels.md | 2 ++ docs/reference/functions/getHotkeyManager.md | 2 ++ docs/reference/functions/getKeyStateTracker.md | 2 ++ docs/reference/functions/getSequenceManager.md | 2 ++ docs/reference/functions/hasNonModifierKey.md | 2 ++ docs/reference/functions/isModifierKey.md | 2 ++ docs/reference/functions/isSingleLetterKey.md | 2 ++ docs/reference/functions/matchesKeyboardEvent.md | 2 ++ docs/reference/functions/normalizeHotkey.md | 2 ++ docs/reference/functions/normalizeHotkeyFromEvent.md | 2 ++ docs/reference/functions/normalizeHotkeyFromParsed.md | 2 ++ docs/reference/functions/normalizeKeyName.md | 2 ++ docs/reference/functions/normalizeRegisterableHotkey.md | 2 ++ docs/reference/functions/parseHotkey.md | 2 ++ docs/reference/functions/parseKeyboardEvent.md | 2 ++ docs/reference/functions/rawHotkeyToParsedHotkey.md | 2 ++ docs/reference/functions/resolveModifier.md | 2 ++ docs/reference/functions/toHotkeyRegistrationView.md | 2 ++ docs/reference/functions/validateHotkey.md | 2 ++ docs/reference/index.md | 2 ++ docs/reference/interfaces/CreateHotkeyHandlerOptions.md | 2 ++ docs/reference/interfaces/FormatDisplayOptions.md | 2 ++ docs/reference/interfaces/HotkeyCallbackContext.md | 2 ++ docs/reference/interfaces/HotkeyMeta.md | 2 ++ docs/reference/interfaces/HotkeyOptions.md | 2 ++ docs/reference/interfaces/HotkeyRecorderOptions.md | 2 ++ docs/reference/interfaces/HotkeyRecorderState.md | 2 ++ docs/reference/interfaces/HotkeyRegistration.md | 2 ++ docs/reference/interfaces/HotkeyRegistrationHandle.md | 2 ++ docs/reference/interfaces/HotkeyRegistrationView.md | 2 ++ docs/reference/interfaces/HotkeySequenceRecorderOptions.md | 2 ++ docs/reference/interfaces/HotkeySequenceRecorderState.md | 2 ++ docs/reference/interfaces/KeyStateTrackerState.md | 2 ++ docs/reference/interfaces/ParsedHotkey.md | 2 ++ docs/reference/interfaces/RawHotkey.md | 2 ++ docs/reference/interfaces/SequenceOptions.md | 2 ++ docs/reference/interfaces/SequenceRegistrationHandle.md | 2 ++ docs/reference/interfaces/SequenceRegistrationView.md | 2 ++ docs/reference/interfaces/ValidationResult.md | 2 ++ docs/reference/type-aliases/CanonicalModifier.md | 2 ++ docs/reference/type-aliases/ConflictBehavior.md | 2 ++ docs/reference/type-aliases/EditingKey.md | 2 ++ docs/reference/type-aliases/FunctionKey.md | 2 ++ docs/reference/type-aliases/Hotkey.md | 2 ++ docs/reference/type-aliases/HotkeyCallback.md | 2 ++ docs/reference/type-aliases/HotkeySequence.md | 2 ++ docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md | 2 ++ docs/reference/type-aliases/IndividualKey.md | 2 ++ docs/reference/type-aliases/Key.md | 2 ++ docs/reference/type-aliases/LetterKey.md | 2 ++ docs/reference/type-aliases/Modifier.md | 2 ++ docs/reference/type-aliases/NavigationKey.md | 2 ++ docs/reference/type-aliases/NumberKey.md | 2 ++ docs/reference/type-aliases/PunctuationKey.md | 2 ++ docs/reference/type-aliases/RegisterableHotkey.md | 2 ++ docs/reference/variables/ALL_KEYS.md | 2 ++ docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md | 2 ++ docs/reference/variables/EDITING_KEYS.md | 2 ++ docs/reference/variables/FUNCTION_KEYS.md | 2 ++ docs/reference/variables/KEY_DISPLAY_SYMBOLS.md | 2 ++ docs/reference/variables/LETTER_KEYS.md | 2 ++ docs/reference/variables/LINUX_MODIFIER_LABELS.md | 2 ++ docs/reference/variables/MAC_MODIFIER_LABELS.md | 2 ++ docs/reference/variables/MAC_MODIFIER_SYMBOLS.md | 2 ++ docs/reference/variables/MODIFIER_ALIASES.md | 2 ++ docs/reference/variables/MODIFIER_KEYS.md | 2 ++ docs/reference/variables/MODIFIER_ORDER.md | 2 ++ docs/reference/variables/NAVIGATION_KEYS.md | 2 ++ docs/reference/variables/NUMBER_KEYS.md | 2 ++ docs/reference/variables/PUNCTUATION_CODE_MAP.md | 2 ++ docs/reference/variables/PUNCTUATION_KEYS.md | 2 ++ docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md | 2 ++ docs/reference/variables/WINDOWS_MODIFIER_LABELS.md | 2 ++ 247 files changed, 494 insertions(+) diff --git a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md index 0ac393f9..71a523f4 100644 --- a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md +++ b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: injectDefaultHotkeysOptions title: injectDefaultHotkeysOptions --- +# Function: injectDefaultHotkeysOptions() + ```ts function injectDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md index bab1a867..d36f56e7 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md +++ b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md @@ -3,6 +3,8 @@ id: injectHeldKeyCodes title: injectHeldKeyCodes --- +# Function: injectHeldKeyCodes() + ```ts function injectHeldKeyCodes(): Signal>; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeys.md b/docs/framework/angular/reference/functions/injectHeldKeys.md index 991a2a01..cf812db9 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeys.md +++ b/docs/framework/angular/reference/functions/injectHeldKeys.md @@ -3,6 +3,8 @@ id: injectHeldKeys title: injectHeldKeys --- +# Function: injectHeldKeys() + ```ts function injectHeldKeys(): Signal; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkey.md b/docs/framework/angular/reference/functions/injectHotkey.md index 5a58c5ab..ad4ba5ac 100644 --- a/docs/framework/angular/reference/functions/injectHotkey.md +++ b/docs/framework/angular/reference/functions/injectHotkey.md @@ -3,6 +3,8 @@ id: injectHotkey title: injectHotkey --- +# Function: injectHotkey() + ```ts function injectHotkey( hotkey, diff --git a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md index cedfe147..cd79601a 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md @@ -3,6 +3,8 @@ id: injectHotkeyRecorder title: injectHotkeyRecorder --- +# Function: injectHotkeyRecorder() + ```ts function injectHotkeyRecorder(options): AngularHotkeyRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md index c34f975a..4412da71 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: injectHotkeyRegistrations title: injectHotkeyRegistrations --- +# Function: injectHotkeyRegistrations() + ```ts function injectHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequence.md b/docs/framework/angular/reference/functions/injectHotkeySequence.md index fc37a367..9e6dc675 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequence.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequence.md @@ -3,6 +3,8 @@ id: injectHotkeySequence title: injectHotkeySequence --- +# Function: injectHotkeySequence() + ```ts function injectHotkeySequence( sequence, diff --git a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md index 5aabe108..324886b4 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: injectHotkeySequenceRecorder title: injectHotkeySequenceRecorder --- +# Function: injectHotkeySequenceRecorder() + ```ts function injectHotkeySequenceRecorder(options): AngularHotkeySequenceRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequences.md b/docs/framework/angular/reference/functions/injectHotkeySequences.md index 1c2559d8..c4f43988 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequences.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequences.md @@ -3,6 +3,8 @@ id: injectHotkeySequences title: injectHotkeySequences --- +# Function: injectHotkeySequences() + ```ts function injectHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeys.md b/docs/framework/angular/reference/functions/injectHotkeys.md index 1498f7ff..b18292c9 100644 --- a/docs/framework/angular/reference/functions/injectHotkeys.md +++ b/docs/framework/angular/reference/functions/injectHotkeys.md @@ -3,6 +3,8 @@ id: injectHotkeys title: injectHotkeys --- +# Function: injectHotkeys() + ```ts function injectHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeysContext.md b/docs/framework/angular/reference/functions/injectHotkeysContext.md index a92e51c7..39a91965 100644 --- a/docs/framework/angular/reference/functions/injectHotkeysContext.md +++ b/docs/framework/angular/reference/functions/injectHotkeysContext.md @@ -3,6 +3,8 @@ id: injectHotkeysContext title: injectHotkeysContext --- +# Function: injectHotkeysContext() + ```ts function injectHotkeysContext(): HotkeysContextValue; ``` diff --git a/docs/framework/angular/reference/functions/injectKeyHold.md b/docs/framework/angular/reference/functions/injectKeyHold.md index d5a2c2b7..28bc5712 100644 --- a/docs/framework/angular/reference/functions/injectKeyHold.md +++ b/docs/framework/angular/reference/functions/injectKeyHold.md @@ -3,6 +3,8 @@ id: injectKeyHold title: injectKeyHold --- +# Function: injectKeyHold() + ```ts function injectKeyHold(key): Signal; ``` diff --git a/docs/framework/angular/reference/functions/provideHotkeys.md b/docs/framework/angular/reference/functions/provideHotkeys.md index 37d6a97c..9a88d0a5 100644 --- a/docs/framework/angular/reference/functions/provideHotkeys.md +++ b/docs/framework/angular/reference/functions/provideHotkeys.md @@ -3,6 +3,8 @@ id: provideHotkeys title: provideHotkeys --- +# Function: provideHotkeys() + ```ts function provideHotkeys(defaultOptions): StaticProvider; ``` diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 5eadd207..2058e458 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/angular-hotkeys" title: "@tanstack/angular-hotkeys" --- +# @tanstack/angular-hotkeys + ## Interfaces - [AngularHotkeyRecorder](interfaces/AngularHotkeyRecorder.md) diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md index f5692a63..8b85b288 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md @@ -3,6 +3,8 @@ id: AngularHotkeyRecorder title: AngularHotkeyRecorder --- +# Interface: AngularHotkeyRecorder + Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L15) ## Properties diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md index 55ad4ea3..042d0ee8 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: AngularHotkeySequenceRecorder title: AngularHotkeySequenceRecorder --- +# Interface: AngularHotkeySequenceRecorder + Defined in: [injectHotkeySequenceRecorder.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequenceRecorder.ts#L18) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md index 28ef11f4..09bdf8d0 100644 --- a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- +# Interface: HotkeyRegistrationsResult + Defined in: [injectHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRegistrations.ts#L16) Return type for injectHotkeyRegistrations. diff --git a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md index 28d84013..953af39e 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md +++ b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md @@ -3,6 +3,8 @@ id: HotkeysContextValue title: HotkeysContextValue --- +# Interface: HotkeysContextValue + Defined in: [hotkeys-provider.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L17) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md index 6784299b..d9639cbb 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [hotkeys-provider.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L10) ## Properties diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md index 9343a3f1..fc42bb6b 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md @@ -3,6 +3,8 @@ id: InjectHotkeyDefinition title: InjectHotkeyDefinition --- +# Interface: InjectHotkeyDefinition + Defined in: [injectHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeys.ts#L19) A single hotkey definition for use with `injectHotkeys`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md index 1eb59425..548a7d43 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md @@ -3,6 +3,8 @@ id: InjectHotkeyOptions title: InjectHotkeyOptions --- +# Interface: InjectHotkeyOptions + Defined in: [injectHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkey.ts#L16) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md index b436b9fb..77e35da7 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: InjectHotkeySequenceDefinition title: InjectHotkeySequenceDefinition --- +# Interface: InjectHotkeySequenceDefinition + Defined in: [injectHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L14) A single sequence definition for use with `injectHotkeySequences`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md index 2ac683eb..e5663ee2 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: InjectHotkeySequenceOptions title: InjectHotkeySequenceOptions --- +# Interface: InjectHotkeySequenceOptions + Defined in: [injectHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md index e7c6d03c..23e3fafe 100644 --- a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md +++ b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md @@ -3,6 +3,8 @@ id: HOTKEYS_INJECTION_TOKEN title: HOTKEYS_INJECTION_TOKEN --- +# Variable: HOTKEYS\_INJECTION\_TOKEN + ```ts const HOTKEYS_INJECTION_TOKEN: InjectionToken; ``` diff --git a/docs/framework/lit/reference/classes/HeldKeyCodesController.md b/docs/framework/lit/reference/classes/HeldKeyCodesController.md index 2ee3eb8d..1a0581aa 100644 --- a/docs/framework/lit/reference/classes/HeldKeyCodesController.md +++ b/docs/framework/lit/reference/classes/HeldKeyCodesController.md @@ -3,6 +3,8 @@ id: HeldKeyCodesController title: HeldKeyCodesController --- +# Class: HeldKeyCodesController + Defined in: [controllers/held-key-codes.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-key-codes.ts#L27) A Lit ReactiveController that tracks all currently held key names to their physical `event.code` values. diff --git a/docs/framework/lit/reference/classes/HeldKeysController.md b/docs/framework/lit/reference/classes/HeldKeysController.md index 1a4f5d78..687c5d92 100644 --- a/docs/framework/lit/reference/classes/HeldKeysController.md +++ b/docs/framework/lit/reference/classes/HeldKeysController.md @@ -3,6 +3,8 @@ id: HeldKeysController title: HeldKeysController --- +# Class: HeldKeysController + Defined in: [controllers/held-keys.ts:26](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-keys.ts#L26) A Lit ReactiveController that tracks all currently held keyboard keys. diff --git a/docs/framework/lit/reference/classes/HotkeyController.md b/docs/framework/lit/reference/classes/HotkeyController.md index 0d12622c..bb323a90 100644 --- a/docs/framework/lit/reference/classes/HotkeyController.md +++ b/docs/framework/lit/reference/classes/HotkeyController.md @@ -3,6 +3,8 @@ id: HotkeyController title: HotkeyController --- +# Class: HotkeyController + Defined in: [controllers/hotkey.ts:34](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey.ts#L34) A Lit ReactiveController that registers a keyboard hotkey when the host diff --git a/docs/framework/lit/reference/classes/HotkeyRecorderController.md b/docs/framework/lit/reference/classes/HotkeyRecorderController.md index 09b7d31b..20f077ff 100644 --- a/docs/framework/lit/reference/classes/HotkeyRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeyRecorderController.md @@ -3,6 +3,8 @@ id: HotkeyRecorderController title: HotkeyRecorderController --- +# Class: HotkeyRecorderController + Defined in: [controllers/hotkey-recorder.ts:40](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-recorder.ts#L40) A Lit ReactiveController that records keyboard shortcuts. diff --git a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md index 703fd76b..0aa6fb24 100644 --- a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md +++ b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsController title: HotkeyRegistrationsController --- +# Class: HotkeyRegistrationsController + Defined in: [controllers/hotkey-registrations.ts:35](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-registrations.ts#L35) A Lit ReactiveController that tracks all hotkey and sequence registrations. diff --git a/docs/framework/lit/reference/classes/HotkeySequenceController.md b/docs/framework/lit/reference/classes/HotkeySequenceController.md index 50a18e17..96f10ab0 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceController.md @@ -3,6 +3,8 @@ id: HotkeySequenceController title: HotkeySequenceController --- +# Class: HotkeySequenceController + Defined in: [controllers/hotkey-sequence.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence.ts#L28) A Lit ReactiveController that registers a keyboard sequence (e.g. Vim-style) diff --git a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md index 58dde745..8a228404 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md @@ -3,6 +3,8 @@ id: HotkeySequenceRecorderController title: HotkeySequenceRecorderController --- +# Class: HotkeySequenceRecorderController + Defined in: [controllers/hotkey-sequence-recorder.ts:45](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence-recorder.ts#L45) A Lit ReactiveController that records multi-chord sequences (Vim-style shortcuts). diff --git a/docs/framework/lit/reference/classes/KeyHoldController.md b/docs/framework/lit/reference/classes/KeyHoldController.md index 27ffe6d5..2aa575cf 100644 --- a/docs/framework/lit/reference/classes/KeyHoldController.md +++ b/docs/framework/lit/reference/classes/KeyHoldController.md @@ -3,6 +3,8 @@ id: KeyHoldController title: KeyHoldController --- +# Class: KeyHoldController + Defined in: [controllers/key-hold.ts:43](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/key-hold.ts#L43) A Lit ReactiveController that tracks whether a specific key is currently held. diff --git a/docs/framework/lit/reference/functions/hotkey.md b/docs/framework/lit/reference/functions/hotkey.md index dbe41638..a9e3c908 100644 --- a/docs/framework/lit/reference/functions/hotkey.md +++ b/docs/framework/lit/reference/functions/hotkey.md @@ -3,6 +3,8 @@ id: hotkey title: hotkey --- +# Function: hotkey() + ```ts function hotkey(hotkey, options): (proto, propertyKey, descriptor?) => void; ``` diff --git a/docs/framework/lit/reference/functions/hotkeySequence.md b/docs/framework/lit/reference/functions/hotkeySequence.md index 8fd40ef6..175fae9e 100644 --- a/docs/framework/lit/reference/functions/hotkeySequence.md +++ b/docs/framework/lit/reference/functions/hotkeySequence.md @@ -3,6 +3,8 @@ id: hotkeySequence title: hotkeySequence --- +# Function: hotkeySequence() + ```ts function hotkeySequence(sequence, options): (proto, methodName, descriptor) => void; ``` diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md index c4c882c7..2dfc191d 100644 --- a/docs/framework/lit/reference/index.md +++ b/docs/framework/lit/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/lit-hotkeys" title: "@tanstack/lit-hotkeys" --- +# @tanstack/lit-hotkeys + ## Classes - [HeldKeyCodesController](classes/HeldKeyCodesController.md) diff --git a/docs/framework/preact/reference/functions/HotkeysProvider.md b/docs/framework/preact/reference/functions/HotkeysProvider.md index 2fe89161..439bf749 100644 --- a/docs/framework/preact/reference/functions/HotkeysProvider.md +++ b/docs/framework/preact/reference/functions/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Function: HotkeysProvider() + ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md index a0f351bb..449602a2 100644 --- a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- +# Function: useDefaultHotkeysOptions() + ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeyCodes.md b/docs/framework/preact/reference/functions/useHeldKeyCodes.md index 897748e2..586b59cf 100644 --- a/docs/framework/preact/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/preact/reference/functions/useHeldKeyCodes.md @@ -3,6 +3,8 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- +# Function: useHeldKeyCodes() + ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeys.md b/docs/framework/preact/reference/functions/useHeldKeys.md index 04a8cef0..6508c07c 100644 --- a/docs/framework/preact/reference/functions/useHeldKeys.md +++ b/docs/framework/preact/reference/functions/useHeldKeys.md @@ -3,6 +3,8 @@ id: useHeldKeys title: useHeldKeys --- +# Function: useHeldKeys() + ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/preact/reference/functions/useHotkey.md b/docs/framework/preact/reference/functions/useHotkey.md index c05188d4..5e1ccd43 100644 --- a/docs/framework/preact/reference/functions/useHotkey.md +++ b/docs/framework/preact/reference/functions/useHotkey.md @@ -3,6 +3,8 @@ id: useHotkey title: useHotkey --- +# Function: useHotkey() + ```ts function useHotkey( hotkey, diff --git a/docs/framework/preact/reference/functions/useHotkeyRecorder.md b/docs/framework/preact/reference/functions/useHotkeyRecorder.md index 55773770..7d5ff107 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeyRecorder.md @@ -3,6 +3,8 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- +# Function: useHotkeyRecorder() + ```ts function useHotkeyRecorder(options): PreactHotkeyRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md index e3460584..c47313f6 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- +# Function: useHotkeyRegistrations() + ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequence.md b/docs/framework/preact/reference/functions/useHotkeySequence.md index 72bf74dc..348b9f5b 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequence.md +++ b/docs/framework/preact/reference/functions/useHotkeySequence.md @@ -3,6 +3,8 @@ id: useHotkeySequence title: useHotkeySequence --- +# Function: useHotkeySequence() + ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md index 650713a5..ae5efd38 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- +# Function: useHotkeySequenceRecorder() + ```ts function useHotkeySequenceRecorder(options): PreactHotkeySequenceRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequences.md b/docs/framework/preact/reference/functions/useHotkeySequences.md index eb432ebc..0820ffd9 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequences.md +++ b/docs/framework/preact/reference/functions/useHotkeySequences.md @@ -3,6 +3,8 @@ id: useHotkeySequences title: useHotkeySequences --- +# Function: useHotkeySequences() + ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeys.md b/docs/framework/preact/reference/functions/useHotkeys.md index b026304b..f2fdb9de 100644 --- a/docs/framework/preact/reference/functions/useHotkeys.md +++ b/docs/framework/preact/reference/functions/useHotkeys.md @@ -3,6 +3,8 @@ id: useHotkeys title: useHotkeys --- +# Function: useHotkeys() + ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeysContext.md b/docs/framework/preact/reference/functions/useHotkeysContext.md index 8a084f1f..70ab7367 100644 --- a/docs/framework/preact/reference/functions/useHotkeysContext.md +++ b/docs/framework/preact/reference/functions/useHotkeysContext.md @@ -3,6 +3,8 @@ id: useHotkeysContext title: useHotkeysContext --- +# Function: useHotkeysContext() + ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/preact/reference/functions/useKeyHold.md b/docs/framework/preact/reference/functions/useKeyHold.md index 0c14980d..5d67feb0 100644 --- a/docs/framework/preact/reference/functions/useKeyHold.md +++ b/docs/framework/preact/reference/functions/useKeyHold.md @@ -3,6 +3,8 @@ id: useKeyHold title: useKeyHold --- +# Function: useKeyHold() + ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index 3cefc3b1..ab63eb09 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/preact-hotkeys" title: "@tanstack/preact-hotkeys" --- +# @tanstack/preact-hotkeys + ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md index 7a498ba3..cea192a6 100644 --- a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- +# Interface: HotkeyRegistrationsResult + Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md index 17b11151..2455d300 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [HotkeysProvider.tsx:11](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L11) ## Properties diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md index 913ad85d..674f2e03 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md @@ -3,6 +3,8 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- +# Interface: HotkeysProviderProps + Defined in: [HotkeysProvider.tsx:24](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L24) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md index af9f4e8e..d4d369de 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md @@ -3,6 +3,8 @@ id: PreactHotkeyRecorder title: PreactHotkeyRecorder --- +# Interface: PreactHotkeyRecorder + Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md index 77bb65e2..1c2c6c8e 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: PreactHotkeySequenceRecorder title: PreactHotkeySequenceRecorder --- +# Interface: PreactHotkeySequenceRecorder + Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md index 001375a6..978c5543 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- +# Interface: UseHotkeyDefinition + Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md index 77b1d253..3f541626 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md @@ -3,6 +3,8 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- +# Interface: UseHotkeyOptions + Defined in: [useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md index aac46d36..9534c315 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- +# Interface: UseHotkeySequenceDefinition + Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md index 092b908b..f5f6ba85 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- +# Interface: UseHotkeySequenceOptions + Defined in: [useHotkeySequence.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequence.ts#L14) ## Extends diff --git a/docs/framework/react/reference/functions/HotkeysProvider.md b/docs/framework/react/reference/functions/HotkeysProvider.md index e0b17212..3144e8d2 100644 --- a/docs/framework/react/reference/functions/HotkeysProvider.md +++ b/docs/framework/react/reference/functions/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Function: HotkeysProvider() + ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md index 2ccb7409..b3a13795 100644 --- a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- +# Function: useDefaultHotkeysOptions() + ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeyCodes.md b/docs/framework/react/reference/functions/useHeldKeyCodes.md index ea8806f9..285c78c8 100644 --- a/docs/framework/react/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/react/reference/functions/useHeldKeyCodes.md @@ -3,6 +3,8 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- +# Function: useHeldKeyCodes() + ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeys.md b/docs/framework/react/reference/functions/useHeldKeys.md index dd6f6609..4dd17e1b 100644 --- a/docs/framework/react/reference/functions/useHeldKeys.md +++ b/docs/framework/react/reference/functions/useHeldKeys.md @@ -3,6 +3,8 @@ id: useHeldKeys title: useHeldKeys --- +# Function: useHeldKeys() + ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/react/reference/functions/useHotkey.md b/docs/framework/react/reference/functions/useHotkey.md index 4c912c26..baf595da 100644 --- a/docs/framework/react/reference/functions/useHotkey.md +++ b/docs/framework/react/reference/functions/useHotkey.md @@ -3,6 +3,8 @@ id: useHotkey title: useHotkey --- +# Function: useHotkey() + ```ts function useHotkey( hotkey, diff --git a/docs/framework/react/reference/functions/useHotkeyRecorder.md b/docs/framework/react/reference/functions/useHotkeyRecorder.md index 25cadc6a..57c513ae 100644 --- a/docs/framework/react/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeyRecorder.md @@ -3,6 +3,8 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- +# Function: useHotkeyRecorder() + ```ts function useHotkeyRecorder(options): ReactHotkeyRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeyRegistrations.md b/docs/framework/react/reference/functions/useHotkeyRegistrations.md index 943bced8..583b2aba 100644 --- a/docs/framework/react/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/react/reference/functions/useHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- +# Function: useHotkeyRegistrations() + ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequence.md b/docs/framework/react/reference/functions/useHotkeySequence.md index 1c55990c..de36b75c 100644 --- a/docs/framework/react/reference/functions/useHotkeySequence.md +++ b/docs/framework/react/reference/functions/useHotkeySequence.md @@ -3,6 +3,8 @@ id: useHotkeySequence title: useHotkeySequence --- +# Function: useHotkeySequence() + ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md index 35380c35..ab311cc1 100644 --- a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- +# Function: useHotkeySequenceRecorder() + ```ts function useHotkeySequenceRecorder(options): ReactHotkeySequenceRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequences.md b/docs/framework/react/reference/functions/useHotkeySequences.md index 7653d7e4..057d7015 100644 --- a/docs/framework/react/reference/functions/useHotkeySequences.md +++ b/docs/framework/react/reference/functions/useHotkeySequences.md @@ -3,6 +3,8 @@ id: useHotkeySequences title: useHotkeySequences --- +# Function: useHotkeySequences() + ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeys.md b/docs/framework/react/reference/functions/useHotkeys.md index 2fe4865a..5986e28c 100644 --- a/docs/framework/react/reference/functions/useHotkeys.md +++ b/docs/framework/react/reference/functions/useHotkeys.md @@ -3,6 +3,8 @@ id: useHotkeys title: useHotkeys --- +# Function: useHotkeys() + ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeysContext.md b/docs/framework/react/reference/functions/useHotkeysContext.md index f84f7aa2..8141e0d7 100644 --- a/docs/framework/react/reference/functions/useHotkeysContext.md +++ b/docs/framework/react/reference/functions/useHotkeysContext.md @@ -3,6 +3,8 @@ id: useHotkeysContext title: useHotkeysContext --- +# Function: useHotkeysContext() + ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/react/reference/functions/useKeyHold.md b/docs/framework/react/reference/functions/useKeyHold.md index bc823728..29cd205f 100644 --- a/docs/framework/react/reference/functions/useKeyHold.md +++ b/docs/framework/react/reference/functions/useKeyHold.md @@ -3,6 +3,8 @@ id: useKeyHold title: useKeyHold --- +# Function: useKeyHold() + ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index c9fc0843..20bb1082 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/react-hotkeys" title: "@tanstack/react-hotkeys" --- +# @tanstack/react-hotkeys + ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md index 05b0e482..25352781 100644 --- a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- +# Interface: HotkeyRegistrationsResult + Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md index 7e8d0dd2..e50aae7e 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md index 14dc70f0..4f92bf13 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md @@ -3,6 +3,8 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- +# Interface: HotkeysProviderProps + Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md index e61f8c0a..146ab032 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md @@ -3,6 +3,8 @@ id: ReactHotkeyRecorder title: ReactHotkeyRecorder --- +# Interface: ReactHotkeyRecorder + Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md index a307b321..8b4cdb26 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: ReactHotkeySequenceRecorder title: ReactHotkeySequenceRecorder --- +# Interface: ReactHotkeySequenceRecorder + Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md index 6f1ade22..1a7bfca1 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- +# Interface: UseHotkeyDefinition + Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md index 6ca9653c..e21ddac8 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md @@ -3,6 +3,8 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- +# Interface: UseHotkeyOptions + Defined in: [useHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkey.ts#L16) ## Extends diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md index e7c3daf4..7965ef8d 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- +# Interface: UseHotkeySequenceDefinition + Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md index ca20e65a..6797d6e4 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- +# Interface: UseHotkeySequenceOptions + Defined in: [useHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/solid/reference/functions/createHeldKeyCodes.md b/docs/framework/solid/reference/functions/createHeldKeyCodes.md index 29a166c5..4ca31b41 100644 --- a/docs/framework/solid/reference/functions/createHeldKeyCodes.md +++ b/docs/framework/solid/reference/functions/createHeldKeyCodes.md @@ -3,6 +3,8 @@ id: createHeldKeyCodes title: createHeldKeyCodes --- +# Function: createHeldKeyCodes() + ```ts function createHeldKeyCodes(): () => Record; ``` diff --git a/docs/framework/solid/reference/functions/createHeldKeys.md b/docs/framework/solid/reference/functions/createHeldKeys.md index 0cf87e1b..bd4bcfd8 100644 --- a/docs/framework/solid/reference/functions/createHeldKeys.md +++ b/docs/framework/solid/reference/functions/createHeldKeys.md @@ -3,6 +3,8 @@ id: createHeldKeys title: createHeldKeys --- +# Function: createHeldKeys() + ```ts function createHeldKeys(): () => string[]; ``` diff --git a/docs/framework/solid/reference/functions/createHotkey.md b/docs/framework/solid/reference/functions/createHotkey.md index c7d55b7b..e665b974 100644 --- a/docs/framework/solid/reference/functions/createHotkey.md +++ b/docs/framework/solid/reference/functions/createHotkey.md @@ -3,6 +3,8 @@ id: createHotkey title: createHotkey --- +# Function: createHotkey() + ```ts function createHotkey( hotkey, diff --git a/docs/framework/solid/reference/functions/createHotkeyRecorder.md b/docs/framework/solid/reference/functions/createHotkeyRecorder.md index fe04fa8e..f5b9d62e 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeyRecorder.md @@ -3,6 +3,8 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- +# Function: createHotkeyRecorder() + ```ts function createHotkeyRecorder(options): SolidHotkeyRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md index 3e6a9b7f..fcbc1b16 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md +++ b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: createHotkeyRegistrations title: createHotkeyRegistrations --- +# Function: createHotkeyRegistrations() + ```ts function createHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequence.md b/docs/framework/solid/reference/functions/createHotkeySequence.md index 1389508b..f2efeafa 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequence.md +++ b/docs/framework/solid/reference/functions/createHotkeySequence.md @@ -3,6 +3,8 @@ id: createHotkeySequence title: createHotkeySequence --- +# Function: createHotkeySequence() + ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md index 61648e77..15bed5fc 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- +# Function: createHotkeySequenceRecorder() + ```ts function createHotkeySequenceRecorder(options): SolidHotkeySequenceRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequences.md b/docs/framework/solid/reference/functions/createHotkeySequences.md index 4c57c469..e92fd09a 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequences.md +++ b/docs/framework/solid/reference/functions/createHotkeySequences.md @@ -3,6 +3,8 @@ id: createHotkeySequences title: createHotkeySequences --- +# Function: createHotkeySequences() + ```ts function createHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeys.md b/docs/framework/solid/reference/functions/createHotkeys.md index b0c5c862..d8d86810 100644 --- a/docs/framework/solid/reference/functions/createHotkeys.md +++ b/docs/framework/solid/reference/functions/createHotkeys.md @@ -3,6 +3,8 @@ id: createHotkeys title: createHotkeys --- +# Function: createHotkeys() + ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createKeyHold.md b/docs/framework/solid/reference/functions/createKeyHold.md index 4f8cf0fe..380ed74f 100644 --- a/docs/framework/solid/reference/functions/createKeyHold.md +++ b/docs/framework/solid/reference/functions/createKeyHold.md @@ -3,6 +3,8 @@ id: createKeyHold title: createKeyHold --- +# Function: createKeyHold() + ```ts function createKeyHold(key): () => boolean; ``` diff --git a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md index a83e38f1..d1513375 100644 --- a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- +# Function: useDefaultHotkeysOptions() + ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/solid/reference/functions/useHotkeysContext.md b/docs/framework/solid/reference/functions/useHotkeysContext.md index 4baa22ff..87c57f48 100644 --- a/docs/framework/solid/reference/functions/useHotkeysContext.md +++ b/docs/framework/solid/reference/functions/useHotkeysContext.md @@ -3,6 +3,8 @@ id: useHotkeysContext title: useHotkeysContext --- +# Function: useHotkeysContext() + ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 14f58470..f8b75907 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/solid-hotkeys" title: "@tanstack/solid-hotkeys" --- +# @tanstack/solid-hotkeys + ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md index 726050f9..d3bcbaa5 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md @@ -3,6 +3,8 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- +# Interface: CreateHotkeyDefinition + Defined in: [createHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeys.ts#L19) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md index c03c61ba..a8f721a1 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md @@ -3,6 +3,8 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- +# Interface: CreateHotkeyOptions + Defined in: [createHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkey.ts#L16) ## Extends diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md index a4d54a4d..d5d4ab66 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- +# Interface: CreateHotkeySequenceDefinition + Defined in: [createHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L14) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md index 4a226508..d3a3913c 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- +# Interface: CreateHotkeySequenceOptions + Defined in: [createHotkeySequence.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequence.ts#L11) ## Extends diff --git a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md index 1c9adf93..48d89a61 100644 --- a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- +# Interface: HotkeyRegistrationsResult + Defined in: [createHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRegistrations.ts#L15) Return type for createHotkeyRegistrations. diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md index 259ead17..c4d77c58 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md index 26c3eed9..d963098e 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md @@ -3,6 +3,8 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- +# Interface: HotkeysProviderProps + Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md index 42d5c61b..f1640633 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md @@ -3,6 +3,8 @@ id: SolidHotkeyRecorder title: SolidHotkeyRecorder --- +# Interface: SolidHotkeyRecorder + Defined in: [createHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md index b72f9995..7fcd1594 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: SolidHotkeySequenceRecorder title: SolidHotkeySequenceRecorder --- +# Interface: SolidHotkeySequenceRecorder + Defined in: [createHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/solid/reference/variables/HotkeysProvider.md b/docs/framework/solid/reference/variables/HotkeysProvider.md index 4804d333..6a622bb8 100644 --- a/docs/framework/solid/reference/variables/HotkeysProvider.md +++ b/docs/framework/solid/reference/variables/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Variable: HotkeysProvider + ```ts const HotkeysProvider: ParentComponent; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkey.md b/docs/framework/svelte/reference/functions/createHotkey.md index a87fbbb2..d21dcd05 100644 --- a/docs/framework/svelte/reference/functions/createHotkey.md +++ b/docs/framework/svelte/reference/functions/createHotkey.md @@ -3,6 +3,8 @@ id: createHotkey title: createHotkey --- +# Function: createHotkey() + ```ts function createHotkey( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md index ce2df77d..1172ba9b 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md @@ -3,6 +3,8 @@ id: createHotkeyAttachment title: createHotkeyAttachment --- +# Function: createHotkeyAttachment() + ```ts function createHotkeyAttachment( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md index feb27572..41e3db29 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md @@ -3,6 +3,8 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- +# Function: createHotkeyRecorder() + ```ts function createHotkeyRecorder(options): SvelteHotkeyRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequence.md b/docs/framework/svelte/reference/functions/createHotkeySequence.md index 47a69976..46ccede2 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequence.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequence.md @@ -3,6 +3,8 @@ id: createHotkeySequence title: createHotkeySequence --- +# Function: createHotkeySequence() + ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md index 8e3c1112..5a01feaa 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md @@ -3,6 +3,8 @@ id: createHotkeySequenceAttachment title: createHotkeySequenceAttachment --- +# Function: createHotkeySequenceAttachment() + ```ts function createHotkeySequenceAttachment( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md index aae69ff4..7a16ea72 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- +# Function: createHotkeySequenceRecorder() + ```ts function createHotkeySequenceRecorder(options): SvelteHotkeySequenceRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequences.md b/docs/framework/svelte/reference/functions/createHotkeySequences.md index 9b697647..503f12c8 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequences.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequences.md @@ -3,6 +3,8 @@ id: createHotkeySequences title: createHotkeySequences --- +# Function: createHotkeySequences() + ```ts function createHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md index 7d7a2f28..d843bb45 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md @@ -3,6 +3,8 @@ id: createHotkeySequencesAttachment title: createHotkeySequencesAttachment --- +# Function: createHotkeySequencesAttachment() + ```ts function createHotkeySequencesAttachment(definitions, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeys.md b/docs/framework/svelte/reference/functions/createHotkeys.md index a39f22af..3686160a 100644 --- a/docs/framework/svelte/reference/functions/createHotkeys.md +++ b/docs/framework/svelte/reference/functions/createHotkeys.md @@ -3,6 +3,8 @@ id: createHotkeys title: createHotkeys --- +# Function: createHotkeys() + ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md index 1990e14a..331db686 100644 --- a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md @@ -3,6 +3,8 @@ id: createHotkeysAttachment title: createHotkeysAttachment --- +# Function: createHotkeysAttachment() + ```ts function createHotkeysAttachment(hotkeys, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md index 6faf5355..2828e8de 100644 --- a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md +++ b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: getDefaultHotkeysOptions title: getDefaultHotkeysOptions --- +# Function: getDefaultHotkeysOptions() + ```ts function getDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md index 9d3d20b5..11767fc4 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md @@ -3,6 +3,8 @@ id: getHeldKeyCodesMap title: getHeldKeyCodesMap --- +# Function: getHeldKeyCodesMap() + ```ts function getHeldKeyCodesMap(): SvelteHeldKeyCodesMap; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeys.md b/docs/framework/svelte/reference/functions/getHeldKeys.md index 746b00a2..a50cd94b 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeys.md +++ b/docs/framework/svelte/reference/functions/getHeldKeys.md @@ -3,6 +3,8 @@ id: getHeldKeys title: getHeldKeys --- +# Function: getHeldKeys() + ```ts function getHeldKeys(): SvelteHeldKeys; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md index 892d2a43..ee988c1c 100644 --- a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: getHotkeyRegistrations title: getHotkeyRegistrations --- +# Function: getHotkeyRegistrations() + ```ts function getHotkeyRegistrations(): SvelteHotkeyRegistrations; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeysContext.md b/docs/framework/svelte/reference/functions/getHotkeysContext.md index 9ded3519..82b71f0a 100644 --- a/docs/framework/svelte/reference/functions/getHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/getHotkeysContext.md @@ -3,6 +3,8 @@ id: getHotkeysContext title: getHotkeysContext --- +# Function: getHotkeysContext() + ```ts function getHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/svelte/reference/functions/getIsKeyHeld.md b/docs/framework/svelte/reference/functions/getIsKeyHeld.md index e72b4281..d0f9cbb5 100644 --- a/docs/framework/svelte/reference/functions/getIsKeyHeld.md +++ b/docs/framework/svelte/reference/functions/getIsKeyHeld.md @@ -3,6 +3,8 @@ id: getIsKeyHeld title: getIsKeyHeld --- +# Function: getIsKeyHeld() + ```ts function getIsKeyHeld(key): SvelteHeldKeyState; ``` diff --git a/docs/framework/svelte/reference/functions/setHotkeysContext.md b/docs/framework/svelte/reference/functions/setHotkeysContext.md index 70b94e38..ad085eed 100644 --- a/docs/framework/svelte/reference/functions/setHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/setHotkeysContext.md @@ -3,6 +3,8 @@ id: setHotkeysContext title: setHotkeysContext --- +# Function: setHotkeysContext() + ```ts function setHotkeysContext(defaultOptions): HotkeysContextValue; ``` diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 603a9da0..5acb3b0b 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/svelte-hotkeys" title: "@tanstack/svelte-hotkeys" --- +# @tanstack/svelte-hotkeys + ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md index 77f588a2..7287ad44 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md @@ -3,6 +3,8 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- +# Interface: CreateHotkeyDefinition + Defined in: [packages/svelte-hotkeys/src/createHotkeys.svelte.ts:23](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeys.svelte.ts#L23) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md index a6e25cfd..0a5ee817 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md @@ -3,6 +3,8 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- +# Interface: CreateHotkeyOptions + Defined in: [packages/svelte-hotkeys/src/createHotkey.svelte.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkey.svelte.ts#L19) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md index 933a29be..7347a8b9 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- +# Interface: CreateHotkeySequenceDefinition + Defined in: [packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts#L18) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md index 01dd97d2..a2e34667 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- +# Interface: CreateHotkeySequenceOptions + Defined in: [packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts#L14) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md index 3b527405..cce1c297 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L10) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md index 309ad4f9..15ca21a8 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md @@ -3,6 +3,8 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- +# Interface: HotkeysProviderProps + Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L17) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md index 9a57484b..dfa75646 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md @@ -3,6 +3,8 @@ id: SvelteHeldKeyCodesMap title: SvelteHeldKeyCodesMap --- +# Interface: SvelteHeldKeyCodesMap + Defined in: [packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md index 5f4a29a5..31ecd19e 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md @@ -3,6 +3,8 @@ id: SvelteHeldKeyState title: SvelteHeldKeyState --- +# Interface: SvelteHeldKeyState + Defined in: [packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts:5](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts#L5) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md index 8ed747f9..259e1305 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md @@ -3,6 +3,8 @@ id: SvelteHeldKeys title: SvelteHeldKeys --- +# Interface: SvelteHeldKeys + Defined in: [packages/svelte-hotkeys/src/getHeldKeys.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeys.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md index 071d5d9c..a2e7f442 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md @@ -3,6 +3,8 @@ id: SvelteHotkeyRecorder title: SvelteHotkeyRecorder --- +# Interface: SvelteHotkeyRecorder + Defined in: [packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts#L8) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md index a1485bb6..ae2d29d3 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: SvelteHotkeyRegistrations title: SvelteHotkeyRegistrations --- +# Interface: SvelteHotkeyRegistrations + Defined in: [packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts#L12) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md index e21e3d71..3b11bb07 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: SvelteHotkeySequenceRecorder title: SvelteHotkeySequenceRecorder --- +# Interface: SvelteHotkeySequenceRecorder + Defined in: [packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts#L11) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md index 62b66d67..fba4fb47 100644 --- a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md +++ b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Type Alias: HotkeysProvider + ```ts type HotkeysProvider = SvelteComponent; ``` diff --git a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md index 55ea1d73..a5263772 100644 --- a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md +++ b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md @@ -3,6 +3,8 @@ id: DEFAULT_OPTIONS title: DEFAULT_OPTIONS --- +# Variable: DEFAULT\_OPTIONS + ```ts const DEFAULT_OPTIONS: HotkeysProviderOptions = {}; ``` diff --git a/docs/framework/svelte/reference/variables/HotkeysProvider.md b/docs/framework/svelte/reference/variables/HotkeysProvider.md index dfa5884b..bee07fb6 100644 --- a/docs/framework/svelte/reference/variables/HotkeysProvider.md +++ b/docs/framework/svelte/reference/variables/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Variable: HotkeysProvider + ```ts const HotkeysProvider: LegacyComponentType; ``` diff --git a/docs/framework/vue/reference/functions/provideHotkeysContext.md b/docs/framework/vue/reference/functions/provideHotkeysContext.md index 3b1b6276..fce843db 100644 --- a/docs/framework/vue/reference/functions/provideHotkeysContext.md +++ b/docs/framework/vue/reference/functions/provideHotkeysContext.md @@ -3,6 +3,8 @@ id: provideHotkeysContext title: provideHotkeysContext --- +# Function: provideHotkeysContext() + ```ts function provideHotkeysContext(defaultOptions?): void; ``` diff --git a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md index 1a24f5b6..0f2a1618 100644 --- a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md @@ -3,6 +3,8 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- +# Function: useDefaultHotkeysOptions() + ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeyCodes.md b/docs/framework/vue/reference/functions/useHeldKeyCodes.md index b842e8ec..0c966e33 100644 --- a/docs/framework/vue/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/vue/reference/functions/useHeldKeyCodes.md @@ -3,6 +3,8 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- +# Function: useHeldKeyCodes() + ```ts function useHeldKeyCodes(): Ref>; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeys.md b/docs/framework/vue/reference/functions/useHeldKeys.md index 01c56135..a542a24e 100644 --- a/docs/framework/vue/reference/functions/useHeldKeys.md +++ b/docs/framework/vue/reference/functions/useHeldKeys.md @@ -3,6 +3,8 @@ id: useHeldKeys title: useHeldKeys --- +# Function: useHeldKeys() + ```ts function useHeldKeys(): Ref; ``` diff --git a/docs/framework/vue/reference/functions/useHotkey.md b/docs/framework/vue/reference/functions/useHotkey.md index 7beac482..ada21331 100644 --- a/docs/framework/vue/reference/functions/useHotkey.md +++ b/docs/framework/vue/reference/functions/useHotkey.md @@ -3,6 +3,8 @@ id: useHotkey title: useHotkey --- +# Function: useHotkey() + ```ts function useHotkey( hotkey, diff --git a/docs/framework/vue/reference/functions/useHotkeyRecorder.md b/docs/framework/vue/reference/functions/useHotkeyRecorder.md index b1bc2cd9..ec662e10 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeyRecorder.md @@ -3,6 +3,8 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- +# Function: useHotkeyRecorder() + ```ts function useHotkeyRecorder(options): VueHotkeyRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md index c560858a..ca2ac234 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md @@ -3,6 +3,8 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- +# Function: useHotkeyRegistrations() + ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequence.md b/docs/framework/vue/reference/functions/useHotkeySequence.md index 649007a5..ab7449aa 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequence.md +++ b/docs/framework/vue/reference/functions/useHotkeySequence.md @@ -3,6 +3,8 @@ id: useHotkeySequence title: useHotkeySequence --- +# Function: useHotkeySequence() + ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md index 2575b6c5..39cab190 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- +# Function: useHotkeySequenceRecorder() + ```ts function useHotkeySequenceRecorder(options): VueHotkeySequenceRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequences.md b/docs/framework/vue/reference/functions/useHotkeySequences.md index 4474e240..81d75a4f 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequences.md +++ b/docs/framework/vue/reference/functions/useHotkeySequences.md @@ -3,6 +3,8 @@ id: useHotkeySequences title: useHotkeySequences --- +# Function: useHotkeySequences() + ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeys.md b/docs/framework/vue/reference/functions/useHotkeys.md index 18d39f39..46c0a2fc 100644 --- a/docs/framework/vue/reference/functions/useHotkeys.md +++ b/docs/framework/vue/reference/functions/useHotkeys.md @@ -3,6 +3,8 @@ id: useHotkeys title: useHotkeys --- +# Function: useHotkeys() + ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeysContext.md b/docs/framework/vue/reference/functions/useHotkeysContext.md index 4cab43e7..eb046dcd 100644 --- a/docs/framework/vue/reference/functions/useHotkeysContext.md +++ b/docs/framework/vue/reference/functions/useHotkeysContext.md @@ -3,6 +3,8 @@ id: useHotkeysContext title: useHotkeysContext --- +# Function: useHotkeysContext() + ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/vue/reference/functions/useKeyHold.md b/docs/framework/vue/reference/functions/useKeyHold.md index 99307045..0a9aab55 100644 --- a/docs/framework/vue/reference/functions/useKeyHold.md +++ b/docs/framework/vue/reference/functions/useKeyHold.md @@ -3,6 +3,8 @@ id: useKeyHold title: useKeyHold --- +# Function: useKeyHold() + ```ts function useKeyHold(key): Ref; ``` diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index aa5a3f02..9152bc1c 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/vue-hotkeys" title: "@tanstack/vue-hotkeys" --- +# @tanstack/vue-hotkeys + ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md index ef325fd8..3efc2c54 100644 --- a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- +# Interface: HotkeyRegistrationsResult + Defined in: [packages/vue-hotkeys/src/useHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRegistrations.ts#L16) Return type for useHotkeyRegistrations. diff --git a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md index 9f3f89ce..3f0337e9 100644 --- a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md @@ -3,6 +3,8 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- +# Interface: HotkeysProviderOptions + Defined in: [packages/vue-hotkeys/src/HotkeysProviderContext.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/HotkeysProviderContext.ts#L10) ## Properties diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md index aa9d40d1..5ddaf0f5 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- +# Interface: UseHotkeyDefinition + Defined in: [packages/vue-hotkeys/src/useHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeys.ts#L19) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md index 5706100b..345c018e 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md @@ -3,6 +3,8 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- +# Interface: UseHotkeyOptions + Defined in: [packages/vue-hotkeys/src/useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md index c8f4dacc..669d1ead 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- +# Interface: UseHotkeySequenceDefinition + Defined in: [packages/vue-hotkeys/src/useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md index ffb39d89..1f743bb7 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,6 +3,8 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- +# Interface: UseHotkeySequenceOptions + Defined in: [packages/vue-hotkeys/src/useHotkeySequence.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequence.ts#L12) ## Extends diff --git a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md index 359eed7c..27c3783c 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md @@ -3,6 +3,8 @@ id: VueHotkeyRecorder title: VueHotkeyRecorder --- +# Interface: VueHotkeyRecorder + Defined in: [packages/vue-hotkeys/src/useHotkeyRecorder.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRecorder.ts#L8) ## Properties diff --git a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md index 6626466b..4a8ed2ba 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md @@ -3,6 +3,8 @@ id: VueHotkeySequenceRecorder title: VueHotkeySequenceRecorder --- +# Interface: VueHotkeySequenceRecorder + Defined in: [packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts#L11) ## Properties diff --git a/docs/framework/vue/reference/variables/HotkeysProvider.md b/docs/framework/vue/reference/variables/HotkeysProvider.md index 9915de95..eaef0d1d 100644 --- a/docs/framework/vue/reference/variables/HotkeysProvider.md +++ b/docs/framework/vue/reference/variables/HotkeysProvider.md @@ -3,6 +3,8 @@ id: HotkeysProvider title: HotkeysProvider --- +# Variable: HotkeysProvider + ```ts const HotkeysProvider: DefineComponent void; ``` diff --git a/docs/reference/functions/createSequenceMatcher.md b/docs/reference/functions/createSequenceMatcher.md index 2f010229..dd9e94a8 100644 --- a/docs/reference/functions/createSequenceMatcher.md +++ b/docs/reference/functions/createSequenceMatcher.md @@ -3,6 +3,8 @@ id: createSequenceMatcher title: createSequenceMatcher --- +# Function: createSequenceMatcher() + ```ts function createSequenceMatcher(sequence, options): object; ``` diff --git a/docs/reference/functions/detectPlatform.md b/docs/reference/functions/detectPlatform.md index 602a755e..398b396f 100644 --- a/docs/reference/functions/detectPlatform.md +++ b/docs/reference/functions/detectPlatform.md @@ -3,6 +3,8 @@ id: detectPlatform title: detectPlatform --- +# Function: detectPlatform() + ```ts function detectPlatform(): "mac" | "windows" | "linux"; ``` diff --git a/docs/reference/functions/formatForDisplay.md b/docs/reference/functions/formatForDisplay.md index 592d8c09..2f6ed013 100644 --- a/docs/reference/functions/formatForDisplay.md +++ b/docs/reference/functions/formatForDisplay.md @@ -3,6 +3,8 @@ id: formatForDisplay title: formatForDisplay --- +# Function: formatForDisplay() + ```ts function formatForDisplay(hotkey, options): string; ``` diff --git a/docs/reference/functions/formatHotkey.md b/docs/reference/functions/formatHotkey.md index 3ec71059..205c3db7 100644 --- a/docs/reference/functions/formatHotkey.md +++ b/docs/reference/functions/formatHotkey.md @@ -3,6 +3,8 @@ id: formatHotkey title: formatHotkey --- +# Function: formatHotkey() + ```ts function formatHotkey(parsed): string; ``` diff --git a/docs/reference/functions/formatHotkeySequence.md b/docs/reference/functions/formatHotkeySequence.md index 8dc91096..78ba16d6 100644 --- a/docs/reference/functions/formatHotkeySequence.md +++ b/docs/reference/functions/formatHotkeySequence.md @@ -3,6 +3,8 @@ id: formatHotkeySequence title: formatHotkeySequence --- +# Function: formatHotkeySequence() + ```ts function formatHotkeySequence(sequence): string; ``` diff --git a/docs/reference/functions/formatWithLabels.md b/docs/reference/functions/formatWithLabels.md index 67bc9641..5bb4540f 100644 --- a/docs/reference/functions/formatWithLabels.md +++ b/docs/reference/functions/formatWithLabels.md @@ -3,6 +3,8 @@ id: formatWithLabels title: formatWithLabels --- +# ~~Function: formatWithLabels()~~ + ```ts function formatWithLabels(hotkey, options): string; ``` diff --git a/docs/reference/functions/getHotkeyManager.md b/docs/reference/functions/getHotkeyManager.md index 7b5e6a46..a207e54e 100644 --- a/docs/reference/functions/getHotkeyManager.md +++ b/docs/reference/functions/getHotkeyManager.md @@ -3,6 +3,8 @@ id: getHotkeyManager title: getHotkeyManager --- +# Function: getHotkeyManager() + ```ts function getHotkeyManager(): HotkeyManager; ``` diff --git a/docs/reference/functions/getKeyStateTracker.md b/docs/reference/functions/getKeyStateTracker.md index 7253ae59..c49f8c30 100644 --- a/docs/reference/functions/getKeyStateTracker.md +++ b/docs/reference/functions/getKeyStateTracker.md @@ -3,6 +3,8 @@ id: getKeyStateTracker title: getKeyStateTracker --- +# Function: getKeyStateTracker() + ```ts function getKeyStateTracker(): KeyStateTracker; ``` diff --git a/docs/reference/functions/getSequenceManager.md b/docs/reference/functions/getSequenceManager.md index 990e21af..227147b6 100644 --- a/docs/reference/functions/getSequenceManager.md +++ b/docs/reference/functions/getSequenceManager.md @@ -3,6 +3,8 @@ id: getSequenceManager title: getSequenceManager --- +# Function: getSequenceManager() + ```ts function getSequenceManager(): SequenceManager; ``` diff --git a/docs/reference/functions/hasNonModifierKey.md b/docs/reference/functions/hasNonModifierKey.md index 208f6d67..064c711b 100644 --- a/docs/reference/functions/hasNonModifierKey.md +++ b/docs/reference/functions/hasNonModifierKey.md @@ -3,6 +3,8 @@ id: hasNonModifierKey title: hasNonModifierKey --- +# Function: hasNonModifierKey() + ```ts function hasNonModifierKey(hotkey, platform): boolean; ``` diff --git a/docs/reference/functions/isModifierKey.md b/docs/reference/functions/isModifierKey.md index c71001f5..092649ae 100644 --- a/docs/reference/functions/isModifierKey.md +++ b/docs/reference/functions/isModifierKey.md @@ -3,6 +3,8 @@ id: isModifierKey title: isModifierKey --- +# Function: isModifierKey() + ```ts function isModifierKey(key): key is string; ``` diff --git a/docs/reference/functions/isSingleLetterKey.md b/docs/reference/functions/isSingleLetterKey.md index 278fcb3a..1ea427a2 100644 --- a/docs/reference/functions/isSingleLetterKey.md +++ b/docs/reference/functions/isSingleLetterKey.md @@ -3,6 +3,8 @@ id: isSingleLetterKey title: isSingleLetterKey --- +# Function: isSingleLetterKey() + ```ts function isSingleLetterKey(key): boolean; ``` diff --git a/docs/reference/functions/matchesKeyboardEvent.md b/docs/reference/functions/matchesKeyboardEvent.md index eaa950c5..f42c110e 100644 --- a/docs/reference/functions/matchesKeyboardEvent.md +++ b/docs/reference/functions/matchesKeyboardEvent.md @@ -3,6 +3,8 @@ id: matchesKeyboardEvent title: matchesKeyboardEvent --- +# Function: matchesKeyboardEvent() + ```ts function matchesKeyboardEvent( event, diff --git a/docs/reference/functions/normalizeHotkey.md b/docs/reference/functions/normalizeHotkey.md index d99ef9dd..dd0517c0 100644 --- a/docs/reference/functions/normalizeHotkey.md +++ b/docs/reference/functions/normalizeHotkey.md @@ -3,6 +3,8 @@ id: normalizeHotkey title: normalizeHotkey --- +# Function: normalizeHotkey() + ```ts function normalizeHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromEvent.md b/docs/reference/functions/normalizeHotkeyFromEvent.md index a1ecc4e8..08e50a4a 100644 --- a/docs/reference/functions/normalizeHotkeyFromEvent.md +++ b/docs/reference/functions/normalizeHotkeyFromEvent.md @@ -3,6 +3,8 @@ id: normalizeHotkeyFromEvent title: normalizeHotkeyFromEvent --- +# Function: normalizeHotkeyFromEvent() + ```ts function normalizeHotkeyFromEvent(event, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromParsed.md b/docs/reference/functions/normalizeHotkeyFromParsed.md index 68be83c3..a758a693 100644 --- a/docs/reference/functions/normalizeHotkeyFromParsed.md +++ b/docs/reference/functions/normalizeHotkeyFromParsed.md @@ -3,6 +3,8 @@ id: normalizeHotkeyFromParsed title: normalizeHotkeyFromParsed --- +# Function: normalizeHotkeyFromParsed() + ```ts function normalizeHotkeyFromParsed(parsed, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeKeyName.md b/docs/reference/functions/normalizeKeyName.md index d8c17cc2..cb9e252d 100644 --- a/docs/reference/functions/normalizeKeyName.md +++ b/docs/reference/functions/normalizeKeyName.md @@ -3,6 +3,8 @@ id: normalizeKeyName title: normalizeKeyName --- +# Function: normalizeKeyName() + ```ts function normalizeKeyName(key): string; ``` diff --git a/docs/reference/functions/normalizeRegisterableHotkey.md b/docs/reference/functions/normalizeRegisterableHotkey.md index e52f60dc..4ef427a2 100644 --- a/docs/reference/functions/normalizeRegisterableHotkey.md +++ b/docs/reference/functions/normalizeRegisterableHotkey.md @@ -3,6 +3,8 @@ id: normalizeRegisterableHotkey title: normalizeRegisterableHotkey --- +# Function: normalizeRegisterableHotkey() + ```ts function normalizeRegisterableHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/parseHotkey.md b/docs/reference/functions/parseHotkey.md index 31e38958..5dd538e5 100644 --- a/docs/reference/functions/parseHotkey.md +++ b/docs/reference/functions/parseHotkey.md @@ -3,6 +3,8 @@ id: parseHotkey title: parseHotkey --- +# Function: parseHotkey() + ```ts function parseHotkey(hotkey, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/parseKeyboardEvent.md b/docs/reference/functions/parseKeyboardEvent.md index bd38db36..10f41a76 100644 --- a/docs/reference/functions/parseKeyboardEvent.md +++ b/docs/reference/functions/parseKeyboardEvent.md @@ -3,6 +3,8 @@ id: parseKeyboardEvent title: parseKeyboardEvent --- +# Function: parseKeyboardEvent() + ```ts function parseKeyboardEvent(event): ParsedHotkey; ``` diff --git a/docs/reference/functions/rawHotkeyToParsedHotkey.md b/docs/reference/functions/rawHotkeyToParsedHotkey.md index c32bd52b..94583c4e 100644 --- a/docs/reference/functions/rawHotkeyToParsedHotkey.md +++ b/docs/reference/functions/rawHotkeyToParsedHotkey.md @@ -3,6 +3,8 @@ id: rawHotkeyToParsedHotkey title: rawHotkeyToParsedHotkey --- +# Function: rawHotkeyToParsedHotkey() + ```ts function rawHotkeyToParsedHotkey(raw, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/resolveModifier.md b/docs/reference/functions/resolveModifier.md index 473d6a65..81b4fb95 100644 --- a/docs/reference/functions/resolveModifier.md +++ b/docs/reference/functions/resolveModifier.md @@ -3,6 +3,8 @@ id: resolveModifier title: resolveModifier --- +# Function: resolveModifier() + ```ts function resolveModifier(modifier, platform): CanonicalModifier; ``` diff --git a/docs/reference/functions/toHotkeyRegistrationView.md b/docs/reference/functions/toHotkeyRegistrationView.md index df1a5f75..cea0babe 100644 --- a/docs/reference/functions/toHotkeyRegistrationView.md +++ b/docs/reference/functions/toHotkeyRegistrationView.md @@ -3,6 +3,8 @@ id: toHotkeyRegistrationView title: toHotkeyRegistrationView --- +# Function: toHotkeyRegistrationView() + ```ts function toHotkeyRegistrationView(reg): HotkeyRegistrationView; ``` diff --git a/docs/reference/functions/validateHotkey.md b/docs/reference/functions/validateHotkey.md index 176cd973..d75bd402 100644 --- a/docs/reference/functions/validateHotkey.md +++ b/docs/reference/functions/validateHotkey.md @@ -3,6 +3,8 @@ id: validateHotkey title: validateHotkey --- +# Function: validateHotkey() + ```ts function validateHotkey(hotkey): ValidationResult; ``` diff --git a/docs/reference/index.md b/docs/reference/index.md index b4307222..fd8f77db 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/hotkeys" title: "@tanstack/hotkeys" --- +# @tanstack/hotkeys + ## Classes - [HotkeyManager](classes/HotkeyManager.md) diff --git a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md index d0a7d280..7ff01012 100644 --- a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md +++ b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md @@ -3,6 +3,8 @@ id: CreateHotkeyHandlerOptions title: CreateHotkeyHandlerOptions --- +# Interface: CreateHotkeyHandlerOptions + Defined in: [match.ts:132](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/match.ts#L132) Options for creating a hotkey handler. diff --git a/docs/reference/interfaces/FormatDisplayOptions.md b/docs/reference/interfaces/FormatDisplayOptions.md index ba92ff51..724e2044 100644 --- a/docs/reference/interfaces/FormatDisplayOptions.md +++ b/docs/reference/interfaces/FormatDisplayOptions.md @@ -3,6 +3,8 @@ id: FormatDisplayOptions title: FormatDisplayOptions --- +# Interface: FormatDisplayOptions + Defined in: [hotkey.ts:367](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L367) Options for formatting hotkeys for display. diff --git a/docs/reference/interfaces/HotkeyCallbackContext.md b/docs/reference/interfaces/HotkeyCallbackContext.md index c323fb71..edacfce8 100644 --- a/docs/reference/interfaces/HotkeyCallbackContext.md +++ b/docs/reference/interfaces/HotkeyCallbackContext.md @@ -3,6 +3,8 @@ id: HotkeyCallbackContext title: HotkeyCallbackContext --- +# Interface: HotkeyCallbackContext + Defined in: [hotkey.ts:391](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L391) Context passed to hotkey callbacks along with the keyboard event. diff --git a/docs/reference/interfaces/HotkeyMeta.md b/docs/reference/interfaces/HotkeyMeta.md index 46b379be..f0d5fe6f 100644 --- a/docs/reference/interfaces/HotkeyMeta.md +++ b/docs/reference/interfaces/HotkeyMeta.md @@ -3,6 +3,8 @@ id: HotkeyMeta title: HotkeyMeta --- +# Interface: HotkeyMeta + Defined in: [hotkey.ts:431](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L431) Metadata for hotkey and sequence registrations. diff --git a/docs/reference/interfaces/HotkeyOptions.md b/docs/reference/interfaces/HotkeyOptions.md index c172d129..0e637c02 100644 --- a/docs/reference/interfaces/HotkeyOptions.md +++ b/docs/reference/interfaces/HotkeyOptions.md @@ -3,6 +3,8 @@ id: HotkeyOptions title: HotkeyOptions --- +# Interface: HotkeyOptions + Defined in: [hotkey-manager.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L28) Options for registering a hotkey. diff --git a/docs/reference/interfaces/HotkeyRecorderOptions.md b/docs/reference/interfaces/HotkeyRecorderOptions.md index e1e108bf..20b6fb57 100644 --- a/docs/reference/interfaces/HotkeyRecorderOptions.md +++ b/docs/reference/interfaces/HotkeyRecorderOptions.md @@ -3,6 +3,8 @@ id: HotkeyRecorderOptions title: HotkeyRecorderOptions --- +# Interface: HotkeyRecorderOptions + Defined in: [hotkey-recorder.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L20) Options for configuring a HotkeyRecorder instance. diff --git a/docs/reference/interfaces/HotkeyRecorderState.md b/docs/reference/interfaces/HotkeyRecorderState.md index 0ed52a47..cda4de56 100644 --- a/docs/reference/interfaces/HotkeyRecorderState.md +++ b/docs/reference/interfaces/HotkeyRecorderState.md @@ -3,6 +3,8 @@ id: HotkeyRecorderState title: HotkeyRecorderState --- +# Interface: HotkeyRecorderState + Defined in: [hotkey-recorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L10) State interface for the HotkeyRecorder. diff --git a/docs/reference/interfaces/HotkeyRegistration.md b/docs/reference/interfaces/HotkeyRegistration.md index 083e9c79..775f7d88 100644 --- a/docs/reference/interfaces/HotkeyRegistration.md +++ b/docs/reference/interfaces/HotkeyRegistration.md @@ -3,6 +3,8 @@ id: HotkeyRegistration title: HotkeyRegistration --- +# Interface: HotkeyRegistration + Defined in: [hotkey-manager.ts:58](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L58) A registered hotkey handler in the HotkeyManager. diff --git a/docs/reference/interfaces/HotkeyRegistrationHandle.md b/docs/reference/interfaces/HotkeyRegistrationHandle.md index 608fb6d5..981883db 100644 --- a/docs/reference/interfaces/HotkeyRegistrationHandle.md +++ b/docs/reference/interfaces/HotkeyRegistrationHandle.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationHandle title: HotkeyRegistrationHandle --- +# Interface: HotkeyRegistrationHandle + Defined in: [hotkey-manager.ts:139](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L139) A handle returned from HotkeyManager.register() that allows updating diff --git a/docs/reference/interfaces/HotkeyRegistrationView.md b/docs/reference/interfaces/HotkeyRegistrationView.md index c93f2101..b7c4d8d3 100644 --- a/docs/reference/interfaces/HotkeyRegistrationView.md +++ b/docs/reference/interfaces/HotkeyRegistrationView.md @@ -3,6 +3,8 @@ id: HotkeyRegistrationView title: HotkeyRegistrationView --- +# Interface: HotkeyRegistrationView + Defined in: [hotkey-manager.ts:81](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L81) Public view of a hotkey registration for display and introspection. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md index 7984ab20..a330eb36 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md @@ -3,6 +3,8 @@ id: HotkeySequenceRecorderOptions title: HotkeySequenceRecorderOptions --- +# Interface: HotkeySequenceRecorderOptions + Defined in: [hotkey-sequence-recorder.ts:29](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L29) Options for configuring a HotkeySequenceRecorder instance. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderState.md b/docs/reference/interfaces/HotkeySequenceRecorderState.md index c66a6be1..10330799 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderState.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderState.md @@ -3,6 +3,8 @@ id: HotkeySequenceRecorderState title: HotkeySequenceRecorderState --- +# Interface: HotkeySequenceRecorderState + Defined in: [hotkey-sequence-recorder.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L17) State interface for the HotkeySequenceRecorder. diff --git a/docs/reference/interfaces/KeyStateTrackerState.md b/docs/reference/interfaces/KeyStateTrackerState.md index e0c4cbc7..d256a258 100644 --- a/docs/reference/interfaces/KeyStateTrackerState.md +++ b/docs/reference/interfaces/KeyStateTrackerState.md @@ -3,6 +3,8 @@ id: KeyStateTrackerState title: KeyStateTrackerState --- +# Interface: KeyStateTrackerState + Defined in: [key-state-tracker.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/key-state-tracker.ts#L7) State interface for the KeyStateTracker. diff --git a/docs/reference/interfaces/ParsedHotkey.md b/docs/reference/interfaces/ParsedHotkey.md index 7facd5ad..a142d43c 100644 --- a/docs/reference/interfaces/ParsedHotkey.md +++ b/docs/reference/interfaces/ParsedHotkey.md @@ -3,6 +3,8 @@ id: ParsedHotkey title: ParsedHotkey --- +# Interface: ParsedHotkey + Defined in: [hotkey.ts:308](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L308) A parsed representation of a hotkey string. diff --git a/docs/reference/interfaces/RawHotkey.md b/docs/reference/interfaces/RawHotkey.md index 36646b3e..a0255a8f 100644 --- a/docs/reference/interfaces/RawHotkey.md +++ b/docs/reference/interfaces/RawHotkey.md @@ -3,6 +3,8 @@ id: RawHotkey title: RawHotkey --- +# Interface: RawHotkey + Defined in: [hotkey.ts:343](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L343) A raw hotkey object for programmatic registration. diff --git a/docs/reference/interfaces/SequenceOptions.md b/docs/reference/interfaces/SequenceOptions.md index 0bbdad42..b021d339 100644 --- a/docs/reference/interfaces/SequenceOptions.md +++ b/docs/reference/interfaces/SequenceOptions.md @@ -3,6 +3,8 @@ id: SequenceOptions title: SequenceOptions --- +# Interface: SequenceOptions + Defined in: [sequence-manager.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L27) Options for hotkey sequence matching. diff --git a/docs/reference/interfaces/SequenceRegistrationHandle.md b/docs/reference/interfaces/SequenceRegistrationHandle.md index 291816d7..c659add7 100644 --- a/docs/reference/interfaces/SequenceRegistrationHandle.md +++ b/docs/reference/interfaces/SequenceRegistrationHandle.md @@ -3,6 +3,8 @@ id: SequenceRegistrationHandle title: SequenceRegistrationHandle --- +# Interface: SequenceRegistrationHandle + Defined in: [sequence-manager.ts:119](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L119) A handle returned from SequenceManager.register() that allows updating diff --git a/docs/reference/interfaces/SequenceRegistrationView.md b/docs/reference/interfaces/SequenceRegistrationView.md index 0272083e..55df6d72 100644 --- a/docs/reference/interfaces/SequenceRegistrationView.md +++ b/docs/reference/interfaces/SequenceRegistrationView.md @@ -3,6 +3,8 @@ id: SequenceRegistrationView title: SequenceRegistrationView --- +# Interface: SequenceRegistrationView + Defined in: [sequence-manager.ts:76](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L76) View of a sequence registration for devtools display. diff --git a/docs/reference/interfaces/ValidationResult.md b/docs/reference/interfaces/ValidationResult.md index 240718fa..fc7e9c1e 100644 --- a/docs/reference/interfaces/ValidationResult.md +++ b/docs/reference/interfaces/ValidationResult.md @@ -3,6 +3,8 @@ id: ValidationResult title: ValidationResult --- +# Interface: ValidationResult + Defined in: [hotkey.ts:379](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L379) Result of validating a hotkey string. diff --git a/docs/reference/type-aliases/CanonicalModifier.md b/docs/reference/type-aliases/CanonicalModifier.md index 53756874..02292671 100644 --- a/docs/reference/type-aliases/CanonicalModifier.md +++ b/docs/reference/type-aliases/CanonicalModifier.md @@ -3,6 +3,8 @@ id: CanonicalModifier title: CanonicalModifier --- +# Type Alias: CanonicalModifier + ```ts type CanonicalModifier = "Control" | "Shift" | "Alt" | "Meta"; ``` diff --git a/docs/reference/type-aliases/ConflictBehavior.md b/docs/reference/type-aliases/ConflictBehavior.md index 3d6eac28..50f06ca9 100644 --- a/docs/reference/type-aliases/ConflictBehavior.md +++ b/docs/reference/type-aliases/ConflictBehavior.md @@ -3,6 +3,8 @@ id: ConflictBehavior title: ConflictBehavior --- +# Type Alias: ConflictBehavior + ```ts type ConflictBehavior = "warn" | "error" | "replace" | "allow"; ``` diff --git a/docs/reference/type-aliases/EditingKey.md b/docs/reference/type-aliases/EditingKey.md index b2c6d964..7c1bb264 100644 --- a/docs/reference/type-aliases/EditingKey.md +++ b/docs/reference/type-aliases/EditingKey.md @@ -3,6 +3,8 @@ id: EditingKey title: EditingKey --- +# Type Alias: EditingKey + ```ts type EditingKey = "Enter" | "Escape" | "Space" | "Tab" | "Backspace" | "Delete"; ``` diff --git a/docs/reference/type-aliases/FunctionKey.md b/docs/reference/type-aliases/FunctionKey.md index 7474b4c2..d2b42f26 100644 --- a/docs/reference/type-aliases/FunctionKey.md +++ b/docs/reference/type-aliases/FunctionKey.md @@ -3,6 +3,8 @@ id: FunctionKey title: FunctionKey --- +# Type Alias: FunctionKey + ```ts type FunctionKey = | "F1" diff --git a/docs/reference/type-aliases/Hotkey.md b/docs/reference/type-aliases/Hotkey.md index d1fbd3e3..6a8c5ad0 100644 --- a/docs/reference/type-aliases/Hotkey.md +++ b/docs/reference/type-aliases/Hotkey.md @@ -3,6 +3,8 @@ id: Hotkey title: Hotkey --- +# Type Alias: Hotkey + ```ts type Hotkey = | Key diff --git a/docs/reference/type-aliases/HotkeyCallback.md b/docs/reference/type-aliases/HotkeyCallback.md index cdabb517..9189e693 100644 --- a/docs/reference/type-aliases/HotkeyCallback.md +++ b/docs/reference/type-aliases/HotkeyCallback.md @@ -3,6 +3,8 @@ id: HotkeyCallback title: HotkeyCallback --- +# Type Alias: HotkeyCallback() + ```ts type HotkeyCallback = (event, context) => void; ``` diff --git a/docs/reference/type-aliases/HotkeySequence.md b/docs/reference/type-aliases/HotkeySequence.md index fd66c317..9fc95653 100644 --- a/docs/reference/type-aliases/HotkeySequence.md +++ b/docs/reference/type-aliases/HotkeySequence.md @@ -3,6 +3,8 @@ id: HotkeySequence title: HotkeySequence --- +# Type Alias: HotkeySequence + ```ts type HotkeySequence = Hotkey[]; ``` diff --git a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md index 0dcdb13b..8a84b6ca 100644 --- a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md +++ b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md @@ -3,6 +3,8 @@ id: HotkeySequenceRecorderCommitKeys title: HotkeySequenceRecorderCommitKeys --- +# Type Alias: HotkeySequenceRecorderCommitKeys + ```ts type HotkeySequenceRecorderCommitKeys = "enter" | "none"; ``` diff --git a/docs/reference/type-aliases/IndividualKey.md b/docs/reference/type-aliases/IndividualKey.md index 0a207795..84f2e4ca 100644 --- a/docs/reference/type-aliases/IndividualKey.md +++ b/docs/reference/type-aliases/IndividualKey.md @@ -3,6 +3,8 @@ id: IndividualKey title: IndividualKey --- +# Type Alias: IndividualKey + ```ts type IndividualKey = CanonicalModifier | Key; ``` diff --git a/docs/reference/type-aliases/Key.md b/docs/reference/type-aliases/Key.md index 6b86598b..01baa032 100644 --- a/docs/reference/type-aliases/Key.md +++ b/docs/reference/type-aliases/Key.md @@ -3,6 +3,8 @@ id: Key title: Key --- +# Type Alias: Key + ```ts type Key = NonPunctuationKey | PunctuationKey; ``` diff --git a/docs/reference/type-aliases/LetterKey.md b/docs/reference/type-aliases/LetterKey.md index d26b41ef..916c7fbc 100644 --- a/docs/reference/type-aliases/LetterKey.md +++ b/docs/reference/type-aliases/LetterKey.md @@ -3,6 +3,8 @@ id: LetterKey title: LetterKey --- +# Type Alias: LetterKey + ```ts type LetterKey = | "A" diff --git a/docs/reference/type-aliases/Modifier.md b/docs/reference/type-aliases/Modifier.md index b7b70cf6..854d8b14 100644 --- a/docs/reference/type-aliases/Modifier.md +++ b/docs/reference/type-aliases/Modifier.md @@ -3,6 +3,8 @@ id: Modifier title: Modifier --- +# Type Alias: Modifier + ```ts type Modifier = | "Control" diff --git a/docs/reference/type-aliases/NavigationKey.md b/docs/reference/type-aliases/NavigationKey.md index 4322f82f..a1f940b2 100644 --- a/docs/reference/type-aliases/NavigationKey.md +++ b/docs/reference/type-aliases/NavigationKey.md @@ -3,6 +3,8 @@ id: NavigationKey title: NavigationKey --- +# Type Alias: NavigationKey + ```ts type NavigationKey = | "ArrowUp" diff --git a/docs/reference/type-aliases/NumberKey.md b/docs/reference/type-aliases/NumberKey.md index 3a2cf3c1..639b3664 100644 --- a/docs/reference/type-aliases/NumberKey.md +++ b/docs/reference/type-aliases/NumberKey.md @@ -3,6 +3,8 @@ id: NumberKey title: NumberKey --- +# Type Alias: NumberKey + ```ts type NumberKey = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"; ``` diff --git a/docs/reference/type-aliases/PunctuationKey.md b/docs/reference/type-aliases/PunctuationKey.md index 086300a6..9dda1dbe 100644 --- a/docs/reference/type-aliases/PunctuationKey.md +++ b/docs/reference/type-aliases/PunctuationKey.md @@ -3,6 +3,8 @@ id: PunctuationKey title: PunctuationKey --- +# Type Alias: PunctuationKey + ```ts type PunctuationKey = "/" | "[" | "]" | "\" | "=" | "-" | "," | "." | ";" | "`"; ``` diff --git a/docs/reference/type-aliases/RegisterableHotkey.md b/docs/reference/type-aliases/RegisterableHotkey.md index ff361eca..ca996bbf 100644 --- a/docs/reference/type-aliases/RegisterableHotkey.md +++ b/docs/reference/type-aliases/RegisterableHotkey.md @@ -3,6 +3,8 @@ id: RegisterableHotkey title: RegisterableHotkey --- +# Type Alias: RegisterableHotkey + ```ts type RegisterableHotkey = Hotkey | RawHotkey; ``` diff --git a/docs/reference/variables/ALL_KEYS.md b/docs/reference/variables/ALL_KEYS.md index eea26a0b..fa471104 100644 --- a/docs/reference/variables/ALL_KEYS.md +++ b/docs/reference/variables/ALL_KEYS.md @@ -3,6 +3,8 @@ id: ALL_KEYS title: ALL_KEYS --- +# Variable: ALL\_KEYS + ```ts const ALL_KEYS: Set< | LetterKey diff --git a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md index 21b43843..44098858 100644 --- a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md +++ b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md @@ -3,6 +3,8 @@ id: DEFAULT_SEQUENCE_TIMEOUT title: DEFAULT_SEQUENCE_TIMEOUT --- +# Variable: DEFAULT\_SEQUENCE\_TIMEOUT + ```ts const DEFAULT_SEQUENCE_TIMEOUT: 1000 = 1000; ``` diff --git a/docs/reference/variables/EDITING_KEYS.md b/docs/reference/variables/EDITING_KEYS.md index 8ab1867d..9d7d717b 100644 --- a/docs/reference/variables/EDITING_KEYS.md +++ b/docs/reference/variables/EDITING_KEYS.md @@ -3,6 +3,8 @@ id: EDITING_KEYS title: EDITING_KEYS --- +# Variable: EDITING\_KEYS + ```ts const EDITING_KEYS: Set; ``` diff --git a/docs/reference/variables/FUNCTION_KEYS.md b/docs/reference/variables/FUNCTION_KEYS.md index a080334b..7dc7311c 100644 --- a/docs/reference/variables/FUNCTION_KEYS.md +++ b/docs/reference/variables/FUNCTION_KEYS.md @@ -3,6 +3,8 @@ id: FUNCTION_KEYS title: FUNCTION_KEYS --- +# Variable: FUNCTION\_KEYS + ```ts const FUNCTION_KEYS: Set; ``` diff --git a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md index ab3ae732..3e7a1715 100644 --- a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md +++ b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md @@ -3,6 +3,8 @@ id: KEY_DISPLAY_SYMBOLS title: KEY_DISPLAY_SYMBOLS --- +# Variable: KEY\_DISPLAY\_SYMBOLS + ```ts const KEY_DISPLAY_SYMBOLS: object; ``` diff --git a/docs/reference/variables/LETTER_KEYS.md b/docs/reference/variables/LETTER_KEYS.md index ff488ad5..029e2998 100644 --- a/docs/reference/variables/LETTER_KEYS.md +++ b/docs/reference/variables/LETTER_KEYS.md @@ -3,6 +3,8 @@ id: LETTER_KEYS title: LETTER_KEYS --- +# Variable: LETTER\_KEYS + ```ts const LETTER_KEYS: Set; ``` diff --git a/docs/reference/variables/LINUX_MODIFIER_LABELS.md b/docs/reference/variables/LINUX_MODIFIER_LABELS.md index b6b0bbbd..ccd7bb39 100644 --- a/docs/reference/variables/LINUX_MODIFIER_LABELS.md +++ b/docs/reference/variables/LINUX_MODIFIER_LABELS.md @@ -3,6 +3,8 @@ id: LINUX_MODIFIER_LABELS title: LINUX_MODIFIER_LABELS --- +# Variable: LINUX\_MODIFIER\_LABELS + ```ts const LINUX_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_LABELS.md b/docs/reference/variables/MAC_MODIFIER_LABELS.md index 3a67ab96..4d2dd13b 100644 --- a/docs/reference/variables/MAC_MODIFIER_LABELS.md +++ b/docs/reference/variables/MAC_MODIFIER_LABELS.md @@ -3,6 +3,8 @@ id: MAC_MODIFIER_LABELS title: MAC_MODIFIER_LABELS --- +# Variable: MAC\_MODIFIER\_LABELS + ```ts const MAC_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md index 2a5fb855..66f0949f 100644 --- a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md +++ b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md @@ -3,6 +3,8 @@ id: MAC_MODIFIER_SYMBOLS title: MAC_MODIFIER_SYMBOLS --- +# Variable: MAC\_MODIFIER\_SYMBOLS + ```ts const MAC_MODIFIER_SYMBOLS: Record; ``` diff --git a/docs/reference/variables/MODIFIER_ALIASES.md b/docs/reference/variables/MODIFIER_ALIASES.md index bf1c705f..d9f2e146 100644 --- a/docs/reference/variables/MODIFIER_ALIASES.md +++ b/docs/reference/variables/MODIFIER_ALIASES.md @@ -3,6 +3,8 @@ id: MODIFIER_ALIASES title: MODIFIER_ALIASES --- +# Variable: MODIFIER\_ALIASES + ```ts const MODIFIER_ALIASES: Record; ``` diff --git a/docs/reference/variables/MODIFIER_KEYS.md b/docs/reference/variables/MODIFIER_KEYS.md index d106ab14..b289d5ae 100644 --- a/docs/reference/variables/MODIFIER_KEYS.md +++ b/docs/reference/variables/MODIFIER_KEYS.md @@ -3,6 +3,8 @@ id: MODIFIER_KEYS title: MODIFIER_KEYS --- +# Variable: MODIFIER\_KEYS + ```ts const MODIFIER_KEYS: Set; ``` diff --git a/docs/reference/variables/MODIFIER_ORDER.md b/docs/reference/variables/MODIFIER_ORDER.md index 397794eb..df05181b 100644 --- a/docs/reference/variables/MODIFIER_ORDER.md +++ b/docs/reference/variables/MODIFIER_ORDER.md @@ -3,6 +3,8 @@ id: MODIFIER_ORDER title: MODIFIER_ORDER --- +# Variable: MODIFIER\_ORDER + ```ts const MODIFIER_ORDER: CanonicalModifier[]; ``` diff --git a/docs/reference/variables/NAVIGATION_KEYS.md b/docs/reference/variables/NAVIGATION_KEYS.md index 917c62ba..176feb07 100644 --- a/docs/reference/variables/NAVIGATION_KEYS.md +++ b/docs/reference/variables/NAVIGATION_KEYS.md @@ -3,6 +3,8 @@ id: NAVIGATION_KEYS title: NAVIGATION_KEYS --- +# Variable: NAVIGATION\_KEYS + ```ts const NAVIGATION_KEYS: Set; ``` diff --git a/docs/reference/variables/NUMBER_KEYS.md b/docs/reference/variables/NUMBER_KEYS.md index 6da27051..d1258c24 100644 --- a/docs/reference/variables/NUMBER_KEYS.md +++ b/docs/reference/variables/NUMBER_KEYS.md @@ -3,6 +3,8 @@ id: NUMBER_KEYS title: NUMBER_KEYS --- +# Variable: NUMBER\_KEYS + ```ts const NUMBER_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_CODE_MAP.md b/docs/reference/variables/PUNCTUATION_CODE_MAP.md index 6d8bf6ae..69f58b48 100644 --- a/docs/reference/variables/PUNCTUATION_CODE_MAP.md +++ b/docs/reference/variables/PUNCTUATION_CODE_MAP.md @@ -3,6 +3,8 @@ id: PUNCTUATION_CODE_MAP title: PUNCTUATION_CODE_MAP --- +# Variable: PUNCTUATION\_CODE\_MAP + ```ts const PUNCTUATION_CODE_MAP: Record; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEYS.md b/docs/reference/variables/PUNCTUATION_KEYS.md index 90f76148..4824f594 100644 --- a/docs/reference/variables/PUNCTUATION_KEYS.md +++ b/docs/reference/variables/PUNCTUATION_KEYS.md @@ -3,6 +3,8 @@ id: PUNCTUATION_KEYS title: PUNCTUATION_KEYS --- +# Variable: PUNCTUATION\_KEYS + ```ts const PUNCTUATION_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md index 3cac002c..5891854c 100644 --- a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md +++ b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md @@ -3,6 +3,8 @@ id: PUNCTUATION_KEY_DISPLAY_LABELS title: PUNCTUATION_KEY_DISPLAY_LABELS --- +# Variable: PUNCTUATION\_KEY\_DISPLAY\_LABELS + ```ts const PUNCTUATION_KEY_DISPLAY_LABELS: object; ``` diff --git a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md index 4b1f6829..fb85e6c1 100644 --- a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md +++ b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md @@ -3,6 +3,8 @@ id: WINDOWS_MODIFIER_LABELS title: WINDOWS_MODIFIER_LABELS --- +# Variable: WINDOWS\_MODIFIER\_LABELS + ```ts const WINDOWS_MODIFIER_LABELS: Record; ``` From 6daa989f41180269b1d316e49510c2af28a5e9ee Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Thu, 10 Sep 2026 12:56:10 +0200 Subject: [PATCH 3/4] docs: leave API reference output to the generator --- typedoc.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 typedoc.json diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..3bd16c29 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,3 @@ +{ + "hidePageTitle": true +} From 1850ec2897c65ff461a9f815a4f8008b8002b6ce Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 10:57:35 +0000 Subject: [PATCH 4/4] ci: apply automated fixes --- .../angular/reference/functions/injectDefaultHotkeysOptions.md | 2 -- .../framework/angular/reference/functions/injectHeldKeyCodes.md | 2 -- docs/framework/angular/reference/functions/injectHeldKeys.md | 2 -- docs/framework/angular/reference/functions/injectHotkey.md | 2 -- .../angular/reference/functions/injectHotkeyRecorder.md | 2 -- .../angular/reference/functions/injectHotkeyRegistrations.md | 2 -- .../angular/reference/functions/injectHotkeySequence.md | 2 -- .../angular/reference/functions/injectHotkeySequenceRecorder.md | 2 -- .../angular/reference/functions/injectHotkeySequences.md | 2 -- docs/framework/angular/reference/functions/injectHotkeys.md | 2 -- .../angular/reference/functions/injectHotkeysContext.md | 2 -- docs/framework/angular/reference/functions/injectKeyHold.md | 2 -- docs/framework/angular/reference/functions/provideHotkeys.md | 2 -- docs/framework/angular/reference/index.md | 2 -- .../angular/reference/interfaces/AngularHotkeyRecorder.md | 2 -- .../reference/interfaces/AngularHotkeySequenceRecorder.md | 2 -- .../angular/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../angular/reference/interfaces/HotkeysContextValue.md | 2 -- .../angular/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../angular/reference/interfaces/InjectHotkeyDefinition.md | 2 -- .../angular/reference/interfaces/InjectHotkeyOptions.md | 2 -- .../reference/interfaces/InjectHotkeySequenceDefinition.md | 2 -- .../angular/reference/interfaces/InjectHotkeySequenceOptions.md | 2 -- .../angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md | 2 -- docs/framework/lit/reference/classes/HeldKeyCodesController.md | 2 -- docs/framework/lit/reference/classes/HeldKeysController.md | 2 -- docs/framework/lit/reference/classes/HotkeyController.md | 2 -- .../framework/lit/reference/classes/HotkeyRecorderController.md | 2 -- .../lit/reference/classes/HotkeyRegistrationsController.md | 2 -- .../framework/lit/reference/classes/HotkeySequenceController.md | 2 -- .../lit/reference/classes/HotkeySequenceRecorderController.md | 2 -- docs/framework/lit/reference/classes/KeyHoldController.md | 2 -- docs/framework/lit/reference/functions/hotkey.md | 2 -- docs/framework/lit/reference/functions/hotkeySequence.md | 2 -- docs/framework/lit/reference/index.md | 2 -- docs/framework/preact/reference/functions/HotkeysProvider.md | 2 -- .../preact/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/preact/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/preact/reference/functions/useHeldKeys.md | 2 -- docs/framework/preact/reference/functions/useHotkey.md | 2 -- docs/framework/preact/reference/functions/useHotkeyRecorder.md | 2 -- .../preact/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/preact/reference/functions/useHotkeySequence.md | 2 -- .../preact/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/preact/reference/functions/useHotkeySequences.md | 2 -- docs/framework/preact/reference/functions/useHotkeys.md | 2 -- docs/framework/preact/reference/functions/useHotkeysContext.md | 2 -- docs/framework/preact/reference/functions/useKeyHold.md | 2 -- docs/framework/preact/reference/index.md | 2 -- .../preact/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../preact/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../preact/reference/interfaces/HotkeysProviderProps.md | 2 -- .../preact/reference/interfaces/PreactHotkeyRecorder.md | 2 -- .../preact/reference/interfaces/PreactHotkeySequenceRecorder.md | 2 -- .../preact/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/preact/reference/interfaces/UseHotkeyOptions.md | 2 -- .../preact/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../preact/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/react/reference/functions/HotkeysProvider.md | 2 -- .../react/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/react/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/react/reference/functions/useHeldKeys.md | 2 -- docs/framework/react/reference/functions/useHotkey.md | 2 -- docs/framework/react/reference/functions/useHotkeyRecorder.md | 2 -- .../react/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/react/reference/functions/useHotkeySequence.md | 2 -- .../react/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/react/reference/functions/useHotkeySequences.md | 2 -- docs/framework/react/reference/functions/useHotkeys.md | 2 -- docs/framework/react/reference/functions/useHotkeysContext.md | 2 -- docs/framework/react/reference/functions/useKeyHold.md | 2 -- docs/framework/react/reference/index.md | 2 -- .../react/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../react/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../react/reference/interfaces/HotkeysProviderProps.md | 2 -- .../framework/react/reference/interfaces/ReactHotkeyRecorder.md | 2 -- .../react/reference/interfaces/ReactHotkeySequenceRecorder.md | 2 -- .../framework/react/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/react/reference/interfaces/UseHotkeyOptions.md | 2 -- .../react/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../react/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/solid/reference/functions/createHeldKeyCodes.md | 2 -- docs/framework/solid/reference/functions/createHeldKeys.md | 2 -- docs/framework/solid/reference/functions/createHotkey.md | 2 -- .../framework/solid/reference/functions/createHotkeyRecorder.md | 2 -- .../solid/reference/functions/createHotkeyRegistrations.md | 2 -- .../framework/solid/reference/functions/createHotkeySequence.md | 2 -- .../solid/reference/functions/createHotkeySequenceRecorder.md | 2 -- .../solid/reference/functions/createHotkeySequences.md | 2 -- docs/framework/solid/reference/functions/createHotkeys.md | 2 -- docs/framework/solid/reference/functions/createKeyHold.md | 2 -- .../solid/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/solid/reference/functions/useHotkeysContext.md | 2 -- docs/framework/solid/reference/index.md | 2 -- .../solid/reference/interfaces/CreateHotkeyDefinition.md | 2 -- .../framework/solid/reference/interfaces/CreateHotkeyOptions.md | 2 -- .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 -- .../solid/reference/interfaces/CreateHotkeySequenceOptions.md | 2 -- .../solid/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../solid/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../solid/reference/interfaces/HotkeysProviderProps.md | 2 -- .../framework/solid/reference/interfaces/SolidHotkeyRecorder.md | 2 -- .../solid/reference/interfaces/SolidHotkeySequenceRecorder.md | 2 -- docs/framework/solid/reference/variables/HotkeysProvider.md | 2 -- docs/framework/svelte/reference/functions/createHotkey.md | 2 -- .../svelte/reference/functions/createHotkeyAttachment.md | 2 -- .../svelte/reference/functions/createHotkeyRecorder.md | 2 -- .../svelte/reference/functions/createHotkeySequence.md | 2 -- .../reference/functions/createHotkeySequenceAttachment.md | 2 -- .../svelte/reference/functions/createHotkeySequenceRecorder.md | 2 -- .../svelte/reference/functions/createHotkeySequences.md | 2 -- .../reference/functions/createHotkeySequencesAttachment.md | 2 -- docs/framework/svelte/reference/functions/createHotkeys.md | 2 -- .../svelte/reference/functions/createHotkeysAttachment.md | 2 -- .../svelte/reference/functions/getDefaultHotkeysOptions.md | 2 -- docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md | 2 -- docs/framework/svelte/reference/functions/getHeldKeys.md | 2 -- .../svelte/reference/functions/getHotkeyRegistrations.md | 2 -- docs/framework/svelte/reference/functions/getHotkeysContext.md | 2 -- docs/framework/svelte/reference/functions/getIsKeyHeld.md | 2 -- docs/framework/svelte/reference/functions/setHotkeysContext.md | 2 -- docs/framework/svelte/reference/index.md | 2 -- .../svelte/reference/interfaces/CreateHotkeyDefinition.md | 2 -- .../svelte/reference/interfaces/CreateHotkeyOptions.md | 2 -- .../reference/interfaces/CreateHotkeySequenceDefinition.md | 2 -- .../svelte/reference/interfaces/CreateHotkeySequenceOptions.md | 2 -- .../svelte/reference/interfaces/HotkeysProviderOptions.md | 2 -- .../svelte/reference/interfaces/HotkeysProviderProps.md | 2 -- .../svelte/reference/interfaces/SvelteHeldKeyCodesMap.md | 2 -- .../framework/svelte/reference/interfaces/SvelteHeldKeyState.md | 2 -- docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeyRecorder.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeyRegistrations.md | 2 -- .../svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md | 2 -- docs/framework/svelte/reference/type-aliases/HotkeysProvider.md | 2 -- docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md | 2 -- docs/framework/svelte/reference/variables/HotkeysProvider.md | 2 -- docs/framework/vue/reference/functions/provideHotkeysContext.md | 2 -- .../vue/reference/functions/useDefaultHotkeysOptions.md | 2 -- docs/framework/vue/reference/functions/useHeldKeyCodes.md | 2 -- docs/framework/vue/reference/functions/useHeldKeys.md | 2 -- docs/framework/vue/reference/functions/useHotkey.md | 2 -- docs/framework/vue/reference/functions/useHotkeyRecorder.md | 2 -- .../framework/vue/reference/functions/useHotkeyRegistrations.md | 2 -- docs/framework/vue/reference/functions/useHotkeySequence.md | 2 -- .../vue/reference/functions/useHotkeySequenceRecorder.md | 2 -- docs/framework/vue/reference/functions/useHotkeySequences.md | 2 -- docs/framework/vue/reference/functions/useHotkeys.md | 2 -- docs/framework/vue/reference/functions/useHotkeysContext.md | 2 -- docs/framework/vue/reference/functions/useKeyHold.md | 2 -- docs/framework/vue/reference/index.md | 2 -- .../vue/reference/interfaces/HotkeyRegistrationsResult.md | 2 -- .../vue/reference/interfaces/HotkeysProviderOptions.md | 2 -- docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md | 2 -- docs/framework/vue/reference/interfaces/UseHotkeyOptions.md | 2 -- .../vue/reference/interfaces/UseHotkeySequenceDefinition.md | 2 -- .../vue/reference/interfaces/UseHotkeySequenceOptions.md | 2 -- docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md | 2 -- .../vue/reference/interfaces/VueHotkeySequenceRecorder.md | 2 -- docs/framework/vue/reference/variables/HotkeysProvider.md | 2 -- docs/reference/classes/HotkeyManager.md | 2 -- docs/reference/classes/HotkeyRecorder.md | 2 -- docs/reference/classes/HotkeySequenceRecorder.md | 2 -- docs/reference/classes/KeyStateTracker.md | 2 -- docs/reference/classes/SequenceManager.md | 2 -- docs/reference/functions/assertValidHotkey.md | 2 -- docs/reference/functions/checkHotkey.md | 2 -- docs/reference/functions/createHotkeyHandler.md | 2 -- docs/reference/functions/createMultiHotkeyHandler.md | 2 -- docs/reference/functions/createSequenceMatcher.md | 2 -- docs/reference/functions/detectPlatform.md | 2 -- docs/reference/functions/formatForDisplay.md | 2 -- docs/reference/functions/formatHotkey.md | 2 -- docs/reference/functions/formatHotkeySequence.md | 2 -- docs/reference/functions/formatWithLabels.md | 2 -- docs/reference/functions/getHotkeyManager.md | 2 -- docs/reference/functions/getKeyStateTracker.md | 2 -- docs/reference/functions/getSequenceManager.md | 2 -- docs/reference/functions/hasNonModifierKey.md | 2 -- docs/reference/functions/isModifierKey.md | 2 -- docs/reference/functions/isSingleLetterKey.md | 2 -- docs/reference/functions/matchesKeyboardEvent.md | 2 -- docs/reference/functions/normalizeHotkey.md | 2 -- docs/reference/functions/normalizeHotkeyFromEvent.md | 2 -- docs/reference/functions/normalizeHotkeyFromParsed.md | 2 -- docs/reference/functions/normalizeKeyName.md | 2 -- docs/reference/functions/normalizeRegisterableHotkey.md | 2 -- docs/reference/functions/parseHotkey.md | 2 -- docs/reference/functions/parseKeyboardEvent.md | 2 -- docs/reference/functions/rawHotkeyToParsedHotkey.md | 2 -- docs/reference/functions/resolveModifier.md | 2 -- docs/reference/functions/toHotkeyRegistrationView.md | 2 -- docs/reference/functions/validateHotkey.md | 2 -- docs/reference/index.md | 2 -- docs/reference/interfaces/CreateHotkeyHandlerOptions.md | 2 -- docs/reference/interfaces/FormatDisplayOptions.md | 2 -- docs/reference/interfaces/HotkeyCallbackContext.md | 2 -- docs/reference/interfaces/HotkeyMeta.md | 2 -- docs/reference/interfaces/HotkeyOptions.md | 2 -- docs/reference/interfaces/HotkeyRecorderOptions.md | 2 -- docs/reference/interfaces/HotkeyRecorderState.md | 2 -- docs/reference/interfaces/HotkeyRegistration.md | 2 -- docs/reference/interfaces/HotkeyRegistrationHandle.md | 2 -- docs/reference/interfaces/HotkeyRegistrationView.md | 2 -- docs/reference/interfaces/HotkeySequenceRecorderOptions.md | 2 -- docs/reference/interfaces/HotkeySequenceRecorderState.md | 2 -- docs/reference/interfaces/KeyStateTrackerState.md | 2 -- docs/reference/interfaces/ParsedHotkey.md | 2 -- docs/reference/interfaces/RawHotkey.md | 2 -- docs/reference/interfaces/SequenceOptions.md | 2 -- docs/reference/interfaces/SequenceRegistrationHandle.md | 2 -- docs/reference/interfaces/SequenceRegistrationView.md | 2 -- docs/reference/interfaces/ValidationResult.md | 2 -- docs/reference/type-aliases/CanonicalModifier.md | 2 -- docs/reference/type-aliases/ConflictBehavior.md | 2 -- docs/reference/type-aliases/EditingKey.md | 2 -- docs/reference/type-aliases/FunctionKey.md | 2 -- docs/reference/type-aliases/Hotkey.md | 2 -- docs/reference/type-aliases/HotkeyCallback.md | 2 -- docs/reference/type-aliases/HotkeySequence.md | 2 -- docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md | 2 -- docs/reference/type-aliases/IndividualKey.md | 2 -- docs/reference/type-aliases/Key.md | 2 -- docs/reference/type-aliases/LetterKey.md | 2 -- docs/reference/type-aliases/Modifier.md | 2 -- docs/reference/type-aliases/NavigationKey.md | 2 -- docs/reference/type-aliases/NumberKey.md | 2 -- docs/reference/type-aliases/PunctuationKey.md | 2 -- docs/reference/type-aliases/RegisterableHotkey.md | 2 -- docs/reference/variables/ALL_KEYS.md | 2 -- docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md | 2 -- docs/reference/variables/EDITING_KEYS.md | 2 -- docs/reference/variables/FUNCTION_KEYS.md | 2 -- docs/reference/variables/KEY_DISPLAY_SYMBOLS.md | 2 -- docs/reference/variables/LETTER_KEYS.md | 2 -- docs/reference/variables/LINUX_MODIFIER_LABELS.md | 2 -- docs/reference/variables/MAC_MODIFIER_LABELS.md | 2 -- docs/reference/variables/MAC_MODIFIER_SYMBOLS.md | 2 -- docs/reference/variables/MODIFIER_ALIASES.md | 2 -- docs/reference/variables/MODIFIER_KEYS.md | 2 -- docs/reference/variables/MODIFIER_ORDER.md | 2 -- docs/reference/variables/NAVIGATION_KEYS.md | 2 -- docs/reference/variables/NUMBER_KEYS.md | 2 -- docs/reference/variables/PUNCTUATION_CODE_MAP.md | 2 -- docs/reference/variables/PUNCTUATION_KEYS.md | 2 -- docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md | 2 -- docs/reference/variables/WINDOWS_MODIFIER_LABELS.md | 2 -- 247 files changed, 494 deletions(-) diff --git a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md index 71a523f4..0ac393f9 100644 --- a/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md +++ b/docs/framework/angular/reference/functions/injectDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: injectDefaultHotkeysOptions title: injectDefaultHotkeysOptions --- -# Function: injectDefaultHotkeysOptions() - ```ts function injectDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md index d36f56e7..bab1a867 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeyCodes.md +++ b/docs/framework/angular/reference/functions/injectHeldKeyCodes.md @@ -3,8 +3,6 @@ id: injectHeldKeyCodes title: injectHeldKeyCodes --- -# Function: injectHeldKeyCodes() - ```ts function injectHeldKeyCodes(): Signal>; ``` diff --git a/docs/framework/angular/reference/functions/injectHeldKeys.md b/docs/framework/angular/reference/functions/injectHeldKeys.md index cf812db9..991a2a01 100644 --- a/docs/framework/angular/reference/functions/injectHeldKeys.md +++ b/docs/framework/angular/reference/functions/injectHeldKeys.md @@ -3,8 +3,6 @@ id: injectHeldKeys title: injectHeldKeys --- -# Function: injectHeldKeys() - ```ts function injectHeldKeys(): Signal; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkey.md b/docs/framework/angular/reference/functions/injectHotkey.md index ad4ba5ac..5a58c5ab 100644 --- a/docs/framework/angular/reference/functions/injectHotkey.md +++ b/docs/framework/angular/reference/functions/injectHotkey.md @@ -3,8 +3,6 @@ id: injectHotkey title: injectHotkey --- -# Function: injectHotkey() - ```ts function injectHotkey( hotkey, diff --git a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md index cd79601a..cedfe147 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRecorder.md @@ -3,8 +3,6 @@ id: injectHotkeyRecorder title: injectHotkeyRecorder --- -# Function: injectHotkeyRecorder() - ```ts function injectHotkeyRecorder(options): AngularHotkeyRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md index 4412da71..c34f975a 100644 --- a/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md +++ b/docs/framework/angular/reference/functions/injectHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: injectHotkeyRegistrations title: injectHotkeyRegistrations --- -# Function: injectHotkeyRegistrations() - ```ts function injectHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequence.md b/docs/framework/angular/reference/functions/injectHotkeySequence.md index 9e6dc675..fc37a367 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequence.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequence.md @@ -3,8 +3,6 @@ id: injectHotkeySequence title: injectHotkeySequence --- -# Function: injectHotkeySequence() - ```ts function injectHotkeySequence( sequence, diff --git a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md index 324886b4..5aabe108 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: injectHotkeySequenceRecorder title: injectHotkeySequenceRecorder --- -# Function: injectHotkeySequenceRecorder() - ```ts function injectHotkeySequenceRecorder(options): AngularHotkeySequenceRecorder; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeySequences.md b/docs/framework/angular/reference/functions/injectHotkeySequences.md index c4f43988..1c2559d8 100644 --- a/docs/framework/angular/reference/functions/injectHotkeySequences.md +++ b/docs/framework/angular/reference/functions/injectHotkeySequences.md @@ -3,8 +3,6 @@ id: injectHotkeySequences title: injectHotkeySequences --- -# Function: injectHotkeySequences() - ```ts function injectHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeys.md b/docs/framework/angular/reference/functions/injectHotkeys.md index b18292c9..1498f7ff 100644 --- a/docs/framework/angular/reference/functions/injectHotkeys.md +++ b/docs/framework/angular/reference/functions/injectHotkeys.md @@ -3,8 +3,6 @@ id: injectHotkeys title: injectHotkeys --- -# Function: injectHotkeys() - ```ts function injectHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/angular/reference/functions/injectHotkeysContext.md b/docs/framework/angular/reference/functions/injectHotkeysContext.md index 39a91965..a92e51c7 100644 --- a/docs/framework/angular/reference/functions/injectHotkeysContext.md +++ b/docs/framework/angular/reference/functions/injectHotkeysContext.md @@ -3,8 +3,6 @@ id: injectHotkeysContext title: injectHotkeysContext --- -# Function: injectHotkeysContext() - ```ts function injectHotkeysContext(): HotkeysContextValue; ``` diff --git a/docs/framework/angular/reference/functions/injectKeyHold.md b/docs/framework/angular/reference/functions/injectKeyHold.md index 28bc5712..d5a2c2b7 100644 --- a/docs/framework/angular/reference/functions/injectKeyHold.md +++ b/docs/framework/angular/reference/functions/injectKeyHold.md @@ -3,8 +3,6 @@ id: injectKeyHold title: injectKeyHold --- -# Function: injectKeyHold() - ```ts function injectKeyHold(key): Signal; ``` diff --git a/docs/framework/angular/reference/functions/provideHotkeys.md b/docs/framework/angular/reference/functions/provideHotkeys.md index 9a88d0a5..37d6a97c 100644 --- a/docs/framework/angular/reference/functions/provideHotkeys.md +++ b/docs/framework/angular/reference/functions/provideHotkeys.md @@ -3,8 +3,6 @@ id: provideHotkeys title: provideHotkeys --- -# Function: provideHotkeys() - ```ts function provideHotkeys(defaultOptions): StaticProvider; ``` diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 2058e458..5eadd207 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/angular-hotkeys" title: "@tanstack/angular-hotkeys" --- -# @tanstack/angular-hotkeys - ## Interfaces - [AngularHotkeyRecorder](interfaces/AngularHotkeyRecorder.md) diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md index 8b85b288..f5692a63 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeyRecorder.md @@ -3,8 +3,6 @@ id: AngularHotkeyRecorder title: AngularHotkeyRecorder --- -# Interface: AngularHotkeyRecorder - Defined in: [injectHotkeyRecorder.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRecorder.ts#L15) ## Properties diff --git a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md index 042d0ee8..55ad4ea3 100644 --- a/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md +++ b/docs/framework/angular/reference/interfaces/AngularHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: AngularHotkeySequenceRecorder title: AngularHotkeySequenceRecorder --- -# Interface: AngularHotkeySequenceRecorder - Defined in: [injectHotkeySequenceRecorder.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequenceRecorder.ts#L18) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md index 09bdf8d0..28ef11f4 100644 --- a/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/angular/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [injectHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeyRegistrations.ts#L16) Return type for injectHotkeyRegistrations. diff --git a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md index 953af39e..28d84013 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysContextValue.md +++ b/docs/framework/angular/reference/interfaces/HotkeysContextValue.md @@ -3,8 +3,6 @@ id: HotkeysContextValue title: HotkeysContextValue --- -# Interface: HotkeysContextValue - Defined in: [hotkeys-provider.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L17) ## Properties diff --git a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md index d9639cbb..6784299b 100644 --- a/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/angular/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [hotkeys-provider.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/hotkeys-provider.ts#L10) ## Properties diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md index fc42bb6b..9343a3f1 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyDefinition.md @@ -3,8 +3,6 @@ id: InjectHotkeyDefinition title: InjectHotkeyDefinition --- -# Interface: InjectHotkeyDefinition - Defined in: [injectHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeys.ts#L19) A single hotkey definition for use with `injectHotkeys`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md index 548a7d43..1eb59425 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeyOptions.md @@ -3,8 +3,6 @@ id: InjectHotkeyOptions title: InjectHotkeyOptions --- -# Interface: InjectHotkeyOptions - Defined in: [injectHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkey.ts#L16) ## Extends diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md index 77e35da7..b436b9fb 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: InjectHotkeySequenceDefinition title: InjectHotkeySequenceDefinition --- -# Interface: InjectHotkeySequenceDefinition - Defined in: [injectHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequences.ts#L14) A single sequence definition for use with `injectHotkeySequences`. diff --git a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md index e5663ee2..2ac683eb 100644 --- a/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: InjectHotkeySequenceOptions title: InjectHotkeySequenceOptions --- -# Interface: InjectHotkeySequenceOptions - Defined in: [injectHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/angular-hotkeys/src/injectHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md index 23e3fafe..e7c6d03c 100644 --- a/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md +++ b/docs/framework/angular/reference/variables/HOTKEYS_INJECTION_TOKEN.md @@ -3,8 +3,6 @@ id: HOTKEYS_INJECTION_TOKEN title: HOTKEYS_INJECTION_TOKEN --- -# Variable: HOTKEYS\_INJECTION\_TOKEN - ```ts const HOTKEYS_INJECTION_TOKEN: InjectionToken; ``` diff --git a/docs/framework/lit/reference/classes/HeldKeyCodesController.md b/docs/framework/lit/reference/classes/HeldKeyCodesController.md index 1a0581aa..2ee3eb8d 100644 --- a/docs/framework/lit/reference/classes/HeldKeyCodesController.md +++ b/docs/framework/lit/reference/classes/HeldKeyCodesController.md @@ -3,8 +3,6 @@ id: HeldKeyCodesController title: HeldKeyCodesController --- -# Class: HeldKeyCodesController - Defined in: [controllers/held-key-codes.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-key-codes.ts#L27) A Lit ReactiveController that tracks all currently held key names to their physical `event.code` values. diff --git a/docs/framework/lit/reference/classes/HeldKeysController.md b/docs/framework/lit/reference/classes/HeldKeysController.md index 687c5d92..1a4f5d78 100644 --- a/docs/framework/lit/reference/classes/HeldKeysController.md +++ b/docs/framework/lit/reference/classes/HeldKeysController.md @@ -3,8 +3,6 @@ id: HeldKeysController title: HeldKeysController --- -# Class: HeldKeysController - Defined in: [controllers/held-keys.ts:26](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/held-keys.ts#L26) A Lit ReactiveController that tracks all currently held keyboard keys. diff --git a/docs/framework/lit/reference/classes/HotkeyController.md b/docs/framework/lit/reference/classes/HotkeyController.md index bb323a90..0d12622c 100644 --- a/docs/framework/lit/reference/classes/HotkeyController.md +++ b/docs/framework/lit/reference/classes/HotkeyController.md @@ -3,8 +3,6 @@ id: HotkeyController title: HotkeyController --- -# Class: HotkeyController - Defined in: [controllers/hotkey.ts:34](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey.ts#L34) A Lit ReactiveController that registers a keyboard hotkey when the host diff --git a/docs/framework/lit/reference/classes/HotkeyRecorderController.md b/docs/framework/lit/reference/classes/HotkeyRecorderController.md index 20f077ff..09b7d31b 100644 --- a/docs/framework/lit/reference/classes/HotkeyRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeyRecorderController.md @@ -3,8 +3,6 @@ id: HotkeyRecorderController title: HotkeyRecorderController --- -# Class: HotkeyRecorderController - Defined in: [controllers/hotkey-recorder.ts:40](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-recorder.ts#L40) A Lit ReactiveController that records keyboard shortcuts. diff --git a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md index 0aa6fb24..703fd76b 100644 --- a/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md +++ b/docs/framework/lit/reference/classes/HotkeyRegistrationsController.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsController title: HotkeyRegistrationsController --- -# Class: HotkeyRegistrationsController - Defined in: [controllers/hotkey-registrations.ts:35](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-registrations.ts#L35) A Lit ReactiveController that tracks all hotkey and sequence registrations. diff --git a/docs/framework/lit/reference/classes/HotkeySequenceController.md b/docs/framework/lit/reference/classes/HotkeySequenceController.md index 96f10ab0..50a18e17 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceController.md @@ -3,8 +3,6 @@ id: HotkeySequenceController title: HotkeySequenceController --- -# Class: HotkeySequenceController - Defined in: [controllers/hotkey-sequence.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence.ts#L28) A Lit ReactiveController that registers a keyboard sequence (e.g. Vim-style) diff --git a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md index 8a228404..58dde745 100644 --- a/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md +++ b/docs/framework/lit/reference/classes/HotkeySequenceRecorderController.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderController title: HotkeySequenceRecorderController --- -# Class: HotkeySequenceRecorderController - Defined in: [controllers/hotkey-sequence-recorder.ts:45](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/hotkey-sequence-recorder.ts#L45) A Lit ReactiveController that records multi-chord sequences (Vim-style shortcuts). diff --git a/docs/framework/lit/reference/classes/KeyHoldController.md b/docs/framework/lit/reference/classes/KeyHoldController.md index 2aa575cf..27ffe6d5 100644 --- a/docs/framework/lit/reference/classes/KeyHoldController.md +++ b/docs/framework/lit/reference/classes/KeyHoldController.md @@ -3,8 +3,6 @@ id: KeyHoldController title: KeyHoldController --- -# Class: KeyHoldController - Defined in: [controllers/key-hold.ts:43](https://github.com/TanStack/hotkeys/blob/main/packages/lit-hotkeys/src/controllers/key-hold.ts#L43) A Lit ReactiveController that tracks whether a specific key is currently held. diff --git a/docs/framework/lit/reference/functions/hotkey.md b/docs/framework/lit/reference/functions/hotkey.md index a9e3c908..dbe41638 100644 --- a/docs/framework/lit/reference/functions/hotkey.md +++ b/docs/framework/lit/reference/functions/hotkey.md @@ -3,8 +3,6 @@ id: hotkey title: hotkey --- -# Function: hotkey() - ```ts function hotkey(hotkey, options): (proto, propertyKey, descriptor?) => void; ``` diff --git a/docs/framework/lit/reference/functions/hotkeySequence.md b/docs/framework/lit/reference/functions/hotkeySequence.md index 175fae9e..8fd40ef6 100644 --- a/docs/framework/lit/reference/functions/hotkeySequence.md +++ b/docs/framework/lit/reference/functions/hotkeySequence.md @@ -3,8 +3,6 @@ id: hotkeySequence title: hotkeySequence --- -# Function: hotkeySequence() - ```ts function hotkeySequence(sequence, options): (proto, methodName, descriptor) => void; ``` diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md index 2dfc191d..c4c882c7 100644 --- a/docs/framework/lit/reference/index.md +++ b/docs/framework/lit/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/lit-hotkeys" title: "@tanstack/lit-hotkeys" --- -# @tanstack/lit-hotkeys - ## Classes - [HeldKeyCodesController](classes/HeldKeyCodesController.md) diff --git a/docs/framework/preact/reference/functions/HotkeysProvider.md b/docs/framework/preact/reference/functions/HotkeysProvider.md index 439bf749..2fe89161 100644 --- a/docs/framework/preact/reference/functions/HotkeysProvider.md +++ b/docs/framework/preact/reference/functions/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Function: HotkeysProvider() - ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md index 449602a2..a0f351bb 100644 --- a/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/preact/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeyCodes.md b/docs/framework/preact/reference/functions/useHeldKeyCodes.md index 586b59cf..897748e2 100644 --- a/docs/framework/preact/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/preact/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/preact/reference/functions/useHeldKeys.md b/docs/framework/preact/reference/functions/useHeldKeys.md index 6508c07c..04a8cef0 100644 --- a/docs/framework/preact/reference/functions/useHeldKeys.md +++ b/docs/framework/preact/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/preact/reference/functions/useHotkey.md b/docs/framework/preact/reference/functions/useHotkey.md index 5e1ccd43..c05188d4 100644 --- a/docs/framework/preact/reference/functions/useHotkey.md +++ b/docs/framework/preact/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/preact/reference/functions/useHotkeyRecorder.md b/docs/framework/preact/reference/functions/useHotkeyRecorder.md index 7d5ff107..55773770 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): PreactHotkeyRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md index c47313f6..e3460584 100644 --- a/docs/framework/preact/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/preact/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequence.md b/docs/framework/preact/reference/functions/useHotkeySequence.md index 348b9f5b..72bf74dc 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequence.md +++ b/docs/framework/preact/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md index ae5efd38..650713a5 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): PreactHotkeySequenceRecorder; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeySequences.md b/docs/framework/preact/reference/functions/useHotkeySequences.md index 0820ffd9..eb432ebc 100644 --- a/docs/framework/preact/reference/functions/useHotkeySequences.md +++ b/docs/framework/preact/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeys.md b/docs/framework/preact/reference/functions/useHotkeys.md index f2fdb9de..b026304b 100644 --- a/docs/framework/preact/reference/functions/useHotkeys.md +++ b/docs/framework/preact/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/preact/reference/functions/useHotkeysContext.md b/docs/framework/preact/reference/functions/useHotkeysContext.md index 70ab7367..8a084f1f 100644 --- a/docs/framework/preact/reference/functions/useHotkeysContext.md +++ b/docs/framework/preact/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/preact/reference/functions/useKeyHold.md b/docs/framework/preact/reference/functions/useKeyHold.md index 5d67feb0..0c14980d 100644 --- a/docs/framework/preact/reference/functions/useKeyHold.md +++ b/docs/framework/preact/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index ab63eb09..3cefc3b1 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/preact-hotkeys" title: "@tanstack/preact-hotkeys" --- -# @tanstack/preact-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md index cea192a6..7a498ba3 100644 --- a/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/preact/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md index 2455d300..17b11151 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:11](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L11) ## Properties diff --git a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md index 674f2e03..913ad85d 100644 --- a/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/preact/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:24](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/HotkeysProvider.tsx#L24) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md index d4d369de..af9f4e8e 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeyRecorder.md @@ -3,8 +3,6 @@ id: PreactHotkeyRecorder title: PreactHotkeyRecorder --- -# Interface: PreactHotkeyRecorder - Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md index 1c2c6c8e..77bb65e2 100644 --- a/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md +++ b/docs/framework/preact/reference/interfaces/PreactHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: PreactHotkeySequenceRecorder title: PreactHotkeySequenceRecorder --- -# Interface: PreactHotkeySequenceRecorder - Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md index 978c5543..001375a6 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md index 3f541626..77b1d253 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md index 9534c315..aac46d36 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md index f5f6ba85..092b908b 100644 --- a/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/preact/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [useHotkeySequence.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/preact-hotkeys/src/useHotkeySequence.ts#L14) ## Extends diff --git a/docs/framework/react/reference/functions/HotkeysProvider.md b/docs/framework/react/reference/functions/HotkeysProvider.md index 3144e8d2..e0b17212 100644 --- a/docs/framework/react/reference/functions/HotkeysProvider.md +++ b/docs/framework/react/reference/functions/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Function: HotkeysProvider() - ```ts function HotkeysProvider(__namedParameters): Element; ``` diff --git a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md index b3a13795..2ccb7409 100644 --- a/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/react/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeyCodes.md b/docs/framework/react/reference/functions/useHeldKeyCodes.md index 285c78c8..ea8806f9 100644 --- a/docs/framework/react/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/react/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Record; ``` diff --git a/docs/framework/react/reference/functions/useHeldKeys.md b/docs/framework/react/reference/functions/useHeldKeys.md index 4dd17e1b..dd6f6609 100644 --- a/docs/framework/react/reference/functions/useHeldKeys.md +++ b/docs/framework/react/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): string[]; ``` diff --git a/docs/framework/react/reference/functions/useHotkey.md b/docs/framework/react/reference/functions/useHotkey.md index baf595da..4c912c26 100644 --- a/docs/framework/react/reference/functions/useHotkey.md +++ b/docs/framework/react/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/react/reference/functions/useHotkeyRecorder.md b/docs/framework/react/reference/functions/useHotkeyRecorder.md index 57c513ae..25cadc6a 100644 --- a/docs/framework/react/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): ReactHotkeyRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeyRegistrations.md b/docs/framework/react/reference/functions/useHotkeyRegistrations.md index 583b2aba..943bced8 100644 --- a/docs/framework/react/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/react/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequence.md b/docs/framework/react/reference/functions/useHotkeySequence.md index de36b75c..1c55990c 100644 --- a/docs/framework/react/reference/functions/useHotkeySequence.md +++ b/docs/framework/react/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md index ab311cc1..35380c35 100644 --- a/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): ReactHotkeySequenceRecorder; ``` diff --git a/docs/framework/react/reference/functions/useHotkeySequences.md b/docs/framework/react/reference/functions/useHotkeySequences.md index 057d7015..7653d7e4 100644 --- a/docs/framework/react/reference/functions/useHotkeySequences.md +++ b/docs/framework/react/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeys.md b/docs/framework/react/reference/functions/useHotkeys.md index 5986e28c..2fe4865a 100644 --- a/docs/framework/react/reference/functions/useHotkeys.md +++ b/docs/framework/react/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/react/reference/functions/useHotkeysContext.md b/docs/framework/react/reference/functions/useHotkeysContext.md index 8141e0d7..f84f7aa2 100644 --- a/docs/framework/react/reference/functions/useHotkeysContext.md +++ b/docs/framework/react/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/react/reference/functions/useKeyHold.md b/docs/framework/react/reference/functions/useKeyHold.md index 29cd205f..bc823728 100644 --- a/docs/framework/react/reference/functions/useKeyHold.md +++ b/docs/framework/react/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): boolean; ``` diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 20bb1082..c9fc0843 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/react-hotkeys" title: "@tanstack/react-hotkeys" --- -# @tanstack/react-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md index 25352781..05b0e482 100644 --- a/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/react/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [useHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRegistrations.ts#L15) Return type for useHotkeyRegistrations. diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md index e50aae7e..7e8d0dd2 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md index 4f92bf13..14dc70f0 100644 --- a/docs/framework/react/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/react/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md index 146ab032..e61f8c0a 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeyRecorder.md @@ -3,8 +3,6 @@ id: ReactHotkeyRecorder title: ReactHotkeyRecorder --- -# Interface: ReactHotkeyRecorder - Defined in: [useHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md index 8b4cdb26..a307b321 100644 --- a/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md +++ b/docs/framework/react/reference/interfaces/ReactHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: ReactHotkeySequenceRecorder title: ReactHotkeySequenceRecorder --- -# Interface: ReactHotkeySequenceRecorder - Defined in: [useHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md index 1a7bfca1..6f1ade22 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [useHotkeys.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeys.ts#L20) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md index e21ddac8..6ca9653c 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [useHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkey.ts#L16) ## Extends diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md index 7965ef8d..e7c3daf4 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md index 6797d6e4..ca20e65a 100644 --- a/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/react/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [useHotkeySequence.ts:13](https://github.com/TanStack/hotkeys/blob/main/packages/react-hotkeys/src/useHotkeySequence.ts#L13) ## Extends diff --git a/docs/framework/solid/reference/functions/createHeldKeyCodes.md b/docs/framework/solid/reference/functions/createHeldKeyCodes.md index 4ca31b41..29a166c5 100644 --- a/docs/framework/solid/reference/functions/createHeldKeyCodes.md +++ b/docs/framework/solid/reference/functions/createHeldKeyCodes.md @@ -3,8 +3,6 @@ id: createHeldKeyCodes title: createHeldKeyCodes --- -# Function: createHeldKeyCodes() - ```ts function createHeldKeyCodes(): () => Record; ``` diff --git a/docs/framework/solid/reference/functions/createHeldKeys.md b/docs/framework/solid/reference/functions/createHeldKeys.md index bd4bcfd8..0cf87e1b 100644 --- a/docs/framework/solid/reference/functions/createHeldKeys.md +++ b/docs/framework/solid/reference/functions/createHeldKeys.md @@ -3,8 +3,6 @@ id: createHeldKeys title: createHeldKeys --- -# Function: createHeldKeys() - ```ts function createHeldKeys(): () => string[]; ``` diff --git a/docs/framework/solid/reference/functions/createHotkey.md b/docs/framework/solid/reference/functions/createHotkey.md index e665b974..c7d55b7b 100644 --- a/docs/framework/solid/reference/functions/createHotkey.md +++ b/docs/framework/solid/reference/functions/createHotkey.md @@ -3,8 +3,6 @@ id: createHotkey title: createHotkey --- -# Function: createHotkey() - ```ts function createHotkey( hotkey, diff --git a/docs/framework/solid/reference/functions/createHotkeyRecorder.md b/docs/framework/solid/reference/functions/createHotkeyRecorder.md index f5b9d62e..fe04fa8e 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeyRecorder.md @@ -3,8 +3,6 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- -# Function: createHotkeyRecorder() - ```ts function createHotkeyRecorder(options): SolidHotkeyRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md index fcbc1b16..3e6a9b7f 100644 --- a/docs/framework/solid/reference/functions/createHotkeyRegistrations.md +++ b/docs/framework/solid/reference/functions/createHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: createHotkeyRegistrations title: createHotkeyRegistrations --- -# Function: createHotkeyRegistrations() - ```ts function createHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequence.md b/docs/framework/solid/reference/functions/createHotkeySequence.md index f2efeafa..1389508b 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequence.md +++ b/docs/framework/solid/reference/functions/createHotkeySequence.md @@ -3,8 +3,6 @@ id: createHotkeySequence title: createHotkeySequence --- -# Function: createHotkeySequence() - ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md index 15bed5fc..61648e77 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/functions/createHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- -# Function: createHotkeySequenceRecorder() - ```ts function createHotkeySequenceRecorder(options): SolidHotkeySequenceRecorder; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeySequences.md b/docs/framework/solid/reference/functions/createHotkeySequences.md index e92fd09a..4c57c469 100644 --- a/docs/framework/solid/reference/functions/createHotkeySequences.md +++ b/docs/framework/solid/reference/functions/createHotkeySequences.md @@ -3,8 +3,6 @@ id: createHotkeySequences title: createHotkeySequences --- -# Function: createHotkeySequences() - ```ts function createHotkeySequences(sequences, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createHotkeys.md b/docs/framework/solid/reference/functions/createHotkeys.md index d8d86810..b0c5c862 100644 --- a/docs/framework/solid/reference/functions/createHotkeys.md +++ b/docs/framework/solid/reference/functions/createHotkeys.md @@ -3,8 +3,6 @@ id: createHotkeys title: createHotkeys --- -# Function: createHotkeys() - ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/solid/reference/functions/createKeyHold.md b/docs/framework/solid/reference/functions/createKeyHold.md index 380ed74f..4f8cf0fe 100644 --- a/docs/framework/solid/reference/functions/createKeyHold.md +++ b/docs/framework/solid/reference/functions/createKeyHold.md @@ -3,8 +3,6 @@ id: createKeyHold title: createKeyHold --- -# Function: createKeyHold() - ```ts function createKeyHold(key): () => boolean; ``` diff --git a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md index d1513375..a83e38f1 100644 --- a/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/solid/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/solid/reference/functions/useHotkeysContext.md b/docs/framework/solid/reference/functions/useHotkeysContext.md index 87c57f48..4baa22ff 100644 --- a/docs/framework/solid/reference/functions/useHotkeysContext.md +++ b/docs/framework/solid/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index f8b75907..14f58470 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/solid-hotkeys" title: "@tanstack/solid-hotkeys" --- -# @tanstack/solid-hotkeys - ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md index d3bcbaa5..726050f9 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- -# Interface: CreateHotkeyDefinition - Defined in: [createHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeys.ts#L19) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md index a8f721a1..c03c61ba 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeyOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- -# Interface: CreateHotkeyOptions - Defined in: [createHotkey.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkey.ts#L16) ## Extends diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md index d5d4ab66..a4d54a4d 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- -# Interface: CreateHotkeySequenceDefinition - Defined in: [createHotkeySequences.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequences.ts#L14) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md index d3a3913c..4a226508 100644 --- a/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/solid/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- -# Interface: CreateHotkeySequenceOptions - Defined in: [createHotkeySequence.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequence.ts#L11) ## Extends diff --git a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md index 48d89a61..1c9adf93 100644 --- a/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/solid/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [createHotkeyRegistrations.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRegistrations.ts#L15) Return type for createHotkeyRegistrations. diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md index c4d77c58..259ead17 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [HotkeysProvider.tsx:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L10) ## Properties diff --git a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md index d963098e..26c3eed9 100644 --- a/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/solid/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [HotkeysProvider.tsx:23](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/HotkeysProvider.tsx#L23) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md index f1640633..42d5c61b 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeyRecorder.md @@ -3,8 +3,6 @@ id: SolidHotkeyRecorder title: SolidHotkeyRecorder --- -# Interface: SolidHotkeyRecorder - Defined in: [createHotkeyRecorder.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeyRecorder.ts#L7) ## Properties diff --git a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md index 7fcd1594..b72f9995 100644 --- a/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md +++ b/docs/framework/solid/reference/interfaces/SolidHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: SolidHotkeySequenceRecorder title: SolidHotkeySequenceRecorder --- -# Interface: SolidHotkeySequenceRecorder - Defined in: [createHotkeySequenceRecorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/solid-hotkeys/src/createHotkeySequenceRecorder.ts#L10) ## Properties diff --git a/docs/framework/solid/reference/variables/HotkeysProvider.md b/docs/framework/solid/reference/variables/HotkeysProvider.md index 6a622bb8..4804d333 100644 --- a/docs/framework/solid/reference/variables/HotkeysProvider.md +++ b/docs/framework/solid/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: ParentComponent; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkey.md b/docs/framework/svelte/reference/functions/createHotkey.md index d21dcd05..a87fbbb2 100644 --- a/docs/framework/svelte/reference/functions/createHotkey.md +++ b/docs/framework/svelte/reference/functions/createHotkey.md @@ -3,8 +3,6 @@ id: createHotkey title: createHotkey --- -# Function: createHotkey() - ```ts function createHotkey( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md index 1172ba9b..ce2df77d 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeyAttachment.md @@ -3,8 +3,6 @@ id: createHotkeyAttachment title: createHotkeyAttachment --- -# Function: createHotkeyAttachment() - ```ts function createHotkeyAttachment( hotkey, diff --git a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md index 41e3db29..feb27572 100644 --- a/docs/framework/svelte/reference/functions/createHotkeyRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeyRecorder.md @@ -3,8 +3,6 @@ id: createHotkeyRecorder title: createHotkeyRecorder --- -# Function: createHotkeyRecorder() - ```ts function createHotkeyRecorder(options): SvelteHotkeyRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequence.md b/docs/framework/svelte/reference/functions/createHotkeySequence.md index 46ccede2..47a69976 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequence.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequence.md @@ -3,8 +3,6 @@ id: createHotkeySequence title: createHotkeySequence --- -# Function: createHotkeySequence() - ```ts function createHotkeySequence( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md index 5a01feaa..8e3c1112 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceAttachment.md @@ -3,8 +3,6 @@ id: createHotkeySequenceAttachment title: createHotkeySequenceAttachment --- -# Function: createHotkeySequenceAttachment() - ```ts function createHotkeySequenceAttachment( sequence, diff --git a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md index 7a16ea72..aae69ff4 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: createHotkeySequenceRecorder title: createHotkeySequenceRecorder --- -# Function: createHotkeySequenceRecorder() - ```ts function createHotkeySequenceRecorder(options): SvelteHotkeySequenceRecorder; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequences.md b/docs/framework/svelte/reference/functions/createHotkeySequences.md index 503f12c8..9b697647 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequences.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequences.md @@ -3,8 +3,6 @@ id: createHotkeySequences title: createHotkeySequences --- -# Function: createHotkeySequences() - ```ts function createHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md index d843bb45..7d7a2f28 100644 --- a/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeySequencesAttachment.md @@ -3,8 +3,6 @@ id: createHotkeySequencesAttachment title: createHotkeySequencesAttachment --- -# Function: createHotkeySequencesAttachment() - ```ts function createHotkeySequencesAttachment(definitions, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeys.md b/docs/framework/svelte/reference/functions/createHotkeys.md index 3686160a..a39f22af 100644 --- a/docs/framework/svelte/reference/functions/createHotkeys.md +++ b/docs/framework/svelte/reference/functions/createHotkeys.md @@ -3,8 +3,6 @@ id: createHotkeys title: createHotkeys --- -# Function: createHotkeys() - ```ts function createHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md index 331db686..1990e14a 100644 --- a/docs/framework/svelte/reference/functions/createHotkeysAttachment.md +++ b/docs/framework/svelte/reference/functions/createHotkeysAttachment.md @@ -3,8 +3,6 @@ id: createHotkeysAttachment title: createHotkeysAttachment --- -# Function: createHotkeysAttachment() - ```ts function createHotkeysAttachment(hotkeys, commonOptions): Attachment; ``` diff --git a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md index 2828e8de..6faf5355 100644 --- a/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md +++ b/docs/framework/svelte/reference/functions/getDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: getDefaultHotkeysOptions title: getDefaultHotkeysOptions --- -# Function: getDefaultHotkeysOptions() - ```ts function getDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md index 11767fc4..9d3d20b5 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/functions/getHeldKeyCodesMap.md @@ -3,8 +3,6 @@ id: getHeldKeyCodesMap title: getHeldKeyCodesMap --- -# Function: getHeldKeyCodesMap() - ```ts function getHeldKeyCodesMap(): SvelteHeldKeyCodesMap; ``` diff --git a/docs/framework/svelte/reference/functions/getHeldKeys.md b/docs/framework/svelte/reference/functions/getHeldKeys.md index a50cd94b..746b00a2 100644 --- a/docs/framework/svelte/reference/functions/getHeldKeys.md +++ b/docs/framework/svelte/reference/functions/getHeldKeys.md @@ -3,8 +3,6 @@ id: getHeldKeys title: getHeldKeys --- -# Function: getHeldKeys() - ```ts function getHeldKeys(): SvelteHeldKeys; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md index ee988c1c..892d2a43 100644 --- a/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/functions/getHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: getHotkeyRegistrations title: getHotkeyRegistrations --- -# Function: getHotkeyRegistrations() - ```ts function getHotkeyRegistrations(): SvelteHotkeyRegistrations; ``` diff --git a/docs/framework/svelte/reference/functions/getHotkeysContext.md b/docs/framework/svelte/reference/functions/getHotkeysContext.md index 82b71f0a..9ded3519 100644 --- a/docs/framework/svelte/reference/functions/getHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/getHotkeysContext.md @@ -3,8 +3,6 @@ id: getHotkeysContext title: getHotkeysContext --- -# Function: getHotkeysContext() - ```ts function getHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/svelte/reference/functions/getIsKeyHeld.md b/docs/framework/svelte/reference/functions/getIsKeyHeld.md index d0f9cbb5..e72b4281 100644 --- a/docs/framework/svelte/reference/functions/getIsKeyHeld.md +++ b/docs/framework/svelte/reference/functions/getIsKeyHeld.md @@ -3,8 +3,6 @@ id: getIsKeyHeld title: getIsKeyHeld --- -# Function: getIsKeyHeld() - ```ts function getIsKeyHeld(key): SvelteHeldKeyState; ``` diff --git a/docs/framework/svelte/reference/functions/setHotkeysContext.md b/docs/framework/svelte/reference/functions/setHotkeysContext.md index ad085eed..70b94e38 100644 --- a/docs/framework/svelte/reference/functions/setHotkeysContext.md +++ b/docs/framework/svelte/reference/functions/setHotkeysContext.md @@ -3,8 +3,6 @@ id: setHotkeysContext title: setHotkeysContext --- -# Function: setHotkeysContext() - ```ts function setHotkeysContext(defaultOptions): HotkeysContextValue; ``` diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 5acb3b0b..603a9da0 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/svelte-hotkeys" title: "@tanstack/svelte-hotkeys" --- -# @tanstack/svelte-hotkeys - ## Interfaces - [CreateHotkeyDefinition](interfaces/CreateHotkeyDefinition.md) diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md index 7287ad44..77f588a2 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeyDefinition title: CreateHotkeyDefinition --- -# Interface: CreateHotkeyDefinition - Defined in: [packages/svelte-hotkeys/src/createHotkeys.svelte.ts:23](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeys.svelte.ts#L23) A single hotkey definition for use with `createHotkeys`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md index 0a5ee817..a6e25cfd 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeyOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyOptions title: CreateHotkeyOptions --- -# Interface: CreateHotkeyOptions - Defined in: [packages/svelte-hotkeys/src/createHotkey.svelte.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkey.svelte.ts#L19) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md index 7347a8b9..933a29be 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceDefinition title: CreateHotkeySequenceDefinition --- -# Interface: CreateHotkeySequenceDefinition - Defined in: [packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts:18](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequences.svelte.ts#L18) A single sequence definition for use with `createHotkeySequences`. diff --git a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md index a2e34667..01dd97d2 100644 --- a/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md +++ b/docs/framework/svelte/reference/interfaces/CreateHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeySequenceOptions title: CreateHotkeySequenceOptions --- -# Interface: CreateHotkeySequenceOptions - Defined in: [packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts:14](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequence.svelte.ts#L14) ## Extends diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md index cce1c297..3b527405 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L10) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md index 15ca21a8..309ad4f9 100644 --- a/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md +++ b/docs/framework/svelte/reference/interfaces/HotkeysProviderProps.md @@ -3,8 +3,6 @@ id: HotkeysProviderProps title: HotkeysProviderProps --- -# Interface: HotkeysProviderProps - Defined in: [packages/svelte-hotkeys/src/HotkeysCtx.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/HotkeysCtx.ts#L17) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md index dfa75646..9a57484b 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyCodesMap.md @@ -3,8 +3,6 @@ id: SvelteHeldKeyCodesMap title: SvelteHeldKeyCodesMap --- -# Interface: SvelteHeldKeyCodesMap - Defined in: [packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeyCodesMap.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md index 31ecd19e..5f4a29a5 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeyState.md @@ -3,8 +3,6 @@ id: SvelteHeldKeyState title: SvelteHeldKeyState --- -# Interface: SvelteHeldKeyState - Defined in: [packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts:5](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getIsKeyHeld.svelte.ts#L5) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md index 259e1305..8ed747f9 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHeldKeys.md @@ -3,8 +3,6 @@ id: SvelteHeldKeys title: SvelteHeldKeys --- -# Interface: SvelteHeldKeys - Defined in: [packages/svelte-hotkeys/src/getHeldKeys.svelte.ts:4](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHeldKeys.svelte.ts#L4) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md index a2e7f442..071d5d9c 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRecorder.md @@ -3,8 +3,6 @@ id: SvelteHotkeyRecorder title: SvelteHotkeyRecorder --- -# Interface: SvelteHotkeyRecorder - Defined in: [packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeyRecorder.svelte.ts#L8) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md index ae2d29d3..a1485bb6 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: SvelteHotkeyRegistrations title: SvelteHotkeyRegistrations --- -# Interface: SvelteHotkeyRegistrations - Defined in: [packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/getHotkeyRegistrations.svelte.ts#L12) ## Properties diff --git a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md index 3b11bb07..e21e3d71 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md +++ b/docs/framework/svelte/reference/interfaces/SvelteHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: SvelteHotkeySequenceRecorder title: SvelteHotkeySequenceRecorder --- -# Interface: SvelteHotkeySequenceRecorder - Defined in: [packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/svelte-hotkeys/src/createHotkeySequenceRecorder.svelte.ts#L11) ## Properties diff --git a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md index fba4fb47..62b66d67 100644 --- a/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md +++ b/docs/framework/svelte/reference/type-aliases/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Type Alias: HotkeysProvider - ```ts type HotkeysProvider = SvelteComponent; ``` diff --git a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md index a5263772..55ea1d73 100644 --- a/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md +++ b/docs/framework/svelte/reference/variables/DEFAULT_OPTIONS.md @@ -3,8 +3,6 @@ id: DEFAULT_OPTIONS title: DEFAULT_OPTIONS --- -# Variable: DEFAULT\_OPTIONS - ```ts const DEFAULT_OPTIONS: HotkeysProviderOptions = {}; ``` diff --git a/docs/framework/svelte/reference/variables/HotkeysProvider.md b/docs/framework/svelte/reference/variables/HotkeysProvider.md index bee07fb6..dfa5884b 100644 --- a/docs/framework/svelte/reference/variables/HotkeysProvider.md +++ b/docs/framework/svelte/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: LegacyComponentType; ``` diff --git a/docs/framework/vue/reference/functions/provideHotkeysContext.md b/docs/framework/vue/reference/functions/provideHotkeysContext.md index fce843db..3b1b6276 100644 --- a/docs/framework/vue/reference/functions/provideHotkeysContext.md +++ b/docs/framework/vue/reference/functions/provideHotkeysContext.md @@ -3,8 +3,6 @@ id: provideHotkeysContext title: provideHotkeysContext --- -# Function: provideHotkeysContext() - ```ts function provideHotkeysContext(defaultOptions?): void; ``` diff --git a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md index 0f2a1618..1a24f5b6 100644 --- a/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md +++ b/docs/framework/vue/reference/functions/useDefaultHotkeysOptions.md @@ -3,8 +3,6 @@ id: useDefaultHotkeysOptions title: useDefaultHotkeysOptions --- -# Function: useDefaultHotkeysOptions() - ```ts function useDefaultHotkeysOptions(): HotkeysProviderOptions; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeyCodes.md b/docs/framework/vue/reference/functions/useHeldKeyCodes.md index 0c966e33..b842e8ec 100644 --- a/docs/framework/vue/reference/functions/useHeldKeyCodes.md +++ b/docs/framework/vue/reference/functions/useHeldKeyCodes.md @@ -3,8 +3,6 @@ id: useHeldKeyCodes title: useHeldKeyCodes --- -# Function: useHeldKeyCodes() - ```ts function useHeldKeyCodes(): Ref>; ``` diff --git a/docs/framework/vue/reference/functions/useHeldKeys.md b/docs/framework/vue/reference/functions/useHeldKeys.md index a542a24e..01c56135 100644 --- a/docs/framework/vue/reference/functions/useHeldKeys.md +++ b/docs/framework/vue/reference/functions/useHeldKeys.md @@ -3,8 +3,6 @@ id: useHeldKeys title: useHeldKeys --- -# Function: useHeldKeys() - ```ts function useHeldKeys(): Ref; ``` diff --git a/docs/framework/vue/reference/functions/useHotkey.md b/docs/framework/vue/reference/functions/useHotkey.md index ada21331..7beac482 100644 --- a/docs/framework/vue/reference/functions/useHotkey.md +++ b/docs/framework/vue/reference/functions/useHotkey.md @@ -3,8 +3,6 @@ id: useHotkey title: useHotkey --- -# Function: useHotkey() - ```ts function useHotkey( hotkey, diff --git a/docs/framework/vue/reference/functions/useHotkeyRecorder.md b/docs/framework/vue/reference/functions/useHotkeyRecorder.md index ec662e10..b1bc2cd9 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeyRecorder.md @@ -3,8 +3,6 @@ id: useHotkeyRecorder title: useHotkeyRecorder --- -# Function: useHotkeyRecorder() - ```ts function useHotkeyRecorder(options): VueHotkeyRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md index ca2ac234..c560858a 100644 --- a/docs/framework/vue/reference/functions/useHotkeyRegistrations.md +++ b/docs/framework/vue/reference/functions/useHotkeyRegistrations.md @@ -3,8 +3,6 @@ id: useHotkeyRegistrations title: useHotkeyRegistrations --- -# Function: useHotkeyRegistrations() - ```ts function useHotkeyRegistrations(): HotkeyRegistrationsResult; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequence.md b/docs/framework/vue/reference/functions/useHotkeySequence.md index ab7449aa..649007a5 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequence.md +++ b/docs/framework/vue/reference/functions/useHotkeySequence.md @@ -3,8 +3,6 @@ id: useHotkeySequence title: useHotkeySequence --- -# Function: useHotkeySequence() - ```ts function useHotkeySequence( sequence, diff --git a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md index 39cab190..2575b6c5 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/functions/useHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: useHotkeySequenceRecorder title: useHotkeySequenceRecorder --- -# Function: useHotkeySequenceRecorder() - ```ts function useHotkeySequenceRecorder(options): VueHotkeySequenceRecorder; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeySequences.md b/docs/framework/vue/reference/functions/useHotkeySequences.md index 81d75a4f..4474e240 100644 --- a/docs/framework/vue/reference/functions/useHotkeySequences.md +++ b/docs/framework/vue/reference/functions/useHotkeySequences.md @@ -3,8 +3,6 @@ id: useHotkeySequences title: useHotkeySequences --- -# Function: useHotkeySequences() - ```ts function useHotkeySequences(definitions, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeys.md b/docs/framework/vue/reference/functions/useHotkeys.md index 46c0a2fc..18d39f39 100644 --- a/docs/framework/vue/reference/functions/useHotkeys.md +++ b/docs/framework/vue/reference/functions/useHotkeys.md @@ -3,8 +3,6 @@ id: useHotkeys title: useHotkeys --- -# Function: useHotkeys() - ```ts function useHotkeys(hotkeys, commonOptions): void; ``` diff --git a/docs/framework/vue/reference/functions/useHotkeysContext.md b/docs/framework/vue/reference/functions/useHotkeysContext.md index eb046dcd..4cab43e7 100644 --- a/docs/framework/vue/reference/functions/useHotkeysContext.md +++ b/docs/framework/vue/reference/functions/useHotkeysContext.md @@ -3,8 +3,6 @@ id: useHotkeysContext title: useHotkeysContext --- -# Function: useHotkeysContext() - ```ts function useHotkeysContext(): HotkeysContextValue | null; ``` diff --git a/docs/framework/vue/reference/functions/useKeyHold.md b/docs/framework/vue/reference/functions/useKeyHold.md index 0a9aab55..99307045 100644 --- a/docs/framework/vue/reference/functions/useKeyHold.md +++ b/docs/framework/vue/reference/functions/useKeyHold.md @@ -3,8 +3,6 @@ id: useKeyHold title: useKeyHold --- -# Function: useKeyHold() - ```ts function useKeyHold(key): Ref; ``` diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 9152bc1c..aa5a3f02 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/vue-hotkeys" title: "@tanstack/vue-hotkeys" --- -# @tanstack/vue-hotkeys - ## Interfaces - [HotkeyRegistrationsResult](interfaces/HotkeyRegistrationsResult.md) diff --git a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md index 3efc2c54..ef325fd8 100644 --- a/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md +++ b/docs/framework/vue/reference/interfaces/HotkeyRegistrationsResult.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationsResult title: HotkeyRegistrationsResult --- -# Interface: HotkeyRegistrationsResult - Defined in: [packages/vue-hotkeys/src/useHotkeyRegistrations.ts:16](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRegistrations.ts#L16) Return type for useHotkeyRegistrations. diff --git a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md index 3f0337e9..9f3f89ce 100644 --- a/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md +++ b/docs/framework/vue/reference/interfaces/HotkeysProviderOptions.md @@ -3,8 +3,6 @@ id: HotkeysProviderOptions title: HotkeysProviderOptions --- -# Interface: HotkeysProviderOptions - Defined in: [packages/vue-hotkeys/src/HotkeysProviderContext.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/HotkeysProviderContext.ts#L10) ## Properties diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md index 5ddaf0f5..aa9d40d1 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeyDefinition title: UseHotkeyDefinition --- -# Interface: UseHotkeyDefinition - Defined in: [packages/vue-hotkeys/src/useHotkeys.ts:19](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeys.ts#L19) A single hotkey definition for use with `useHotkeys`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md index 345c018e..5706100b 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeyOptions.md @@ -3,8 +3,6 @@ id: UseHotkeyOptions title: UseHotkeyOptions --- -# Interface: UseHotkeyOptions - Defined in: [packages/vue-hotkeys/src/useHotkey.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkey.ts#L17) ## Extends diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md index 669d1ead..c8f4dacc 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceDefinition.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceDefinition title: UseHotkeySequenceDefinition --- -# Interface: UseHotkeySequenceDefinition - Defined in: [packages/vue-hotkeys/src/useHotkeySequences.ts:15](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequences.ts#L15) A single sequence definition for use with `useHotkeySequences`. diff --git a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md index 1f743bb7..ffb39d89 100644 --- a/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md +++ b/docs/framework/vue/reference/interfaces/UseHotkeySequenceOptions.md @@ -3,8 +3,6 @@ id: UseHotkeySequenceOptions title: UseHotkeySequenceOptions --- -# Interface: UseHotkeySequenceOptions - Defined in: [packages/vue-hotkeys/src/useHotkeySequence.ts:12](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequence.ts#L12) ## Extends diff --git a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md index 27c3783c..359eed7c 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeyRecorder.md @@ -3,8 +3,6 @@ id: VueHotkeyRecorder title: VueHotkeyRecorder --- -# Interface: VueHotkeyRecorder - Defined in: [packages/vue-hotkeys/src/useHotkeyRecorder.ts:8](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeyRecorder.ts#L8) ## Properties diff --git a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md index 4a8ed2ba..6626466b 100644 --- a/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md +++ b/docs/framework/vue/reference/interfaces/VueHotkeySequenceRecorder.md @@ -3,8 +3,6 @@ id: VueHotkeySequenceRecorder title: VueHotkeySequenceRecorder --- -# Interface: VueHotkeySequenceRecorder - Defined in: [packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts:11](https://github.com/TanStack/hotkeys/blob/main/packages/vue-hotkeys/src/useHotkeySequenceRecorder.ts#L11) ## Properties diff --git a/docs/framework/vue/reference/variables/HotkeysProvider.md b/docs/framework/vue/reference/variables/HotkeysProvider.md index eaef0d1d..9915de95 100644 --- a/docs/framework/vue/reference/variables/HotkeysProvider.md +++ b/docs/framework/vue/reference/variables/HotkeysProvider.md @@ -3,8 +3,6 @@ id: HotkeysProvider title: HotkeysProvider --- -# Variable: HotkeysProvider - ```ts const HotkeysProvider: DefineComponent void; ``` diff --git a/docs/reference/functions/createSequenceMatcher.md b/docs/reference/functions/createSequenceMatcher.md index dd9e94a8..2f010229 100644 --- a/docs/reference/functions/createSequenceMatcher.md +++ b/docs/reference/functions/createSequenceMatcher.md @@ -3,8 +3,6 @@ id: createSequenceMatcher title: createSequenceMatcher --- -# Function: createSequenceMatcher() - ```ts function createSequenceMatcher(sequence, options): object; ``` diff --git a/docs/reference/functions/detectPlatform.md b/docs/reference/functions/detectPlatform.md index 398b396f..602a755e 100644 --- a/docs/reference/functions/detectPlatform.md +++ b/docs/reference/functions/detectPlatform.md @@ -3,8 +3,6 @@ id: detectPlatform title: detectPlatform --- -# Function: detectPlatform() - ```ts function detectPlatform(): "mac" | "windows" | "linux"; ``` diff --git a/docs/reference/functions/formatForDisplay.md b/docs/reference/functions/formatForDisplay.md index 2f6ed013..592d8c09 100644 --- a/docs/reference/functions/formatForDisplay.md +++ b/docs/reference/functions/formatForDisplay.md @@ -3,8 +3,6 @@ id: formatForDisplay title: formatForDisplay --- -# Function: formatForDisplay() - ```ts function formatForDisplay(hotkey, options): string; ``` diff --git a/docs/reference/functions/formatHotkey.md b/docs/reference/functions/formatHotkey.md index 205c3db7..3ec71059 100644 --- a/docs/reference/functions/formatHotkey.md +++ b/docs/reference/functions/formatHotkey.md @@ -3,8 +3,6 @@ id: formatHotkey title: formatHotkey --- -# Function: formatHotkey() - ```ts function formatHotkey(parsed): string; ``` diff --git a/docs/reference/functions/formatHotkeySequence.md b/docs/reference/functions/formatHotkeySequence.md index 78ba16d6..8dc91096 100644 --- a/docs/reference/functions/formatHotkeySequence.md +++ b/docs/reference/functions/formatHotkeySequence.md @@ -3,8 +3,6 @@ id: formatHotkeySequence title: formatHotkeySequence --- -# Function: formatHotkeySequence() - ```ts function formatHotkeySequence(sequence): string; ``` diff --git a/docs/reference/functions/formatWithLabels.md b/docs/reference/functions/formatWithLabels.md index 5bb4540f..67bc9641 100644 --- a/docs/reference/functions/formatWithLabels.md +++ b/docs/reference/functions/formatWithLabels.md @@ -3,8 +3,6 @@ id: formatWithLabels title: formatWithLabels --- -# ~~Function: formatWithLabels()~~ - ```ts function formatWithLabels(hotkey, options): string; ``` diff --git a/docs/reference/functions/getHotkeyManager.md b/docs/reference/functions/getHotkeyManager.md index a207e54e..7b5e6a46 100644 --- a/docs/reference/functions/getHotkeyManager.md +++ b/docs/reference/functions/getHotkeyManager.md @@ -3,8 +3,6 @@ id: getHotkeyManager title: getHotkeyManager --- -# Function: getHotkeyManager() - ```ts function getHotkeyManager(): HotkeyManager; ``` diff --git a/docs/reference/functions/getKeyStateTracker.md b/docs/reference/functions/getKeyStateTracker.md index c49f8c30..7253ae59 100644 --- a/docs/reference/functions/getKeyStateTracker.md +++ b/docs/reference/functions/getKeyStateTracker.md @@ -3,8 +3,6 @@ id: getKeyStateTracker title: getKeyStateTracker --- -# Function: getKeyStateTracker() - ```ts function getKeyStateTracker(): KeyStateTracker; ``` diff --git a/docs/reference/functions/getSequenceManager.md b/docs/reference/functions/getSequenceManager.md index 227147b6..990e21af 100644 --- a/docs/reference/functions/getSequenceManager.md +++ b/docs/reference/functions/getSequenceManager.md @@ -3,8 +3,6 @@ id: getSequenceManager title: getSequenceManager --- -# Function: getSequenceManager() - ```ts function getSequenceManager(): SequenceManager; ``` diff --git a/docs/reference/functions/hasNonModifierKey.md b/docs/reference/functions/hasNonModifierKey.md index 064c711b..208f6d67 100644 --- a/docs/reference/functions/hasNonModifierKey.md +++ b/docs/reference/functions/hasNonModifierKey.md @@ -3,8 +3,6 @@ id: hasNonModifierKey title: hasNonModifierKey --- -# Function: hasNonModifierKey() - ```ts function hasNonModifierKey(hotkey, platform): boolean; ``` diff --git a/docs/reference/functions/isModifierKey.md b/docs/reference/functions/isModifierKey.md index 092649ae..c71001f5 100644 --- a/docs/reference/functions/isModifierKey.md +++ b/docs/reference/functions/isModifierKey.md @@ -3,8 +3,6 @@ id: isModifierKey title: isModifierKey --- -# Function: isModifierKey() - ```ts function isModifierKey(key): key is string; ``` diff --git a/docs/reference/functions/isSingleLetterKey.md b/docs/reference/functions/isSingleLetterKey.md index 1ea427a2..278fcb3a 100644 --- a/docs/reference/functions/isSingleLetterKey.md +++ b/docs/reference/functions/isSingleLetterKey.md @@ -3,8 +3,6 @@ id: isSingleLetterKey title: isSingleLetterKey --- -# Function: isSingleLetterKey() - ```ts function isSingleLetterKey(key): boolean; ``` diff --git a/docs/reference/functions/matchesKeyboardEvent.md b/docs/reference/functions/matchesKeyboardEvent.md index f42c110e..eaa950c5 100644 --- a/docs/reference/functions/matchesKeyboardEvent.md +++ b/docs/reference/functions/matchesKeyboardEvent.md @@ -3,8 +3,6 @@ id: matchesKeyboardEvent title: matchesKeyboardEvent --- -# Function: matchesKeyboardEvent() - ```ts function matchesKeyboardEvent( event, diff --git a/docs/reference/functions/normalizeHotkey.md b/docs/reference/functions/normalizeHotkey.md index dd0517c0..d99ef9dd 100644 --- a/docs/reference/functions/normalizeHotkey.md +++ b/docs/reference/functions/normalizeHotkey.md @@ -3,8 +3,6 @@ id: normalizeHotkey title: normalizeHotkey --- -# Function: normalizeHotkey() - ```ts function normalizeHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromEvent.md b/docs/reference/functions/normalizeHotkeyFromEvent.md index 08e50a4a..a1ecc4e8 100644 --- a/docs/reference/functions/normalizeHotkeyFromEvent.md +++ b/docs/reference/functions/normalizeHotkeyFromEvent.md @@ -3,8 +3,6 @@ id: normalizeHotkeyFromEvent title: normalizeHotkeyFromEvent --- -# Function: normalizeHotkeyFromEvent() - ```ts function normalizeHotkeyFromEvent(event, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeHotkeyFromParsed.md b/docs/reference/functions/normalizeHotkeyFromParsed.md index a758a693..68be83c3 100644 --- a/docs/reference/functions/normalizeHotkeyFromParsed.md +++ b/docs/reference/functions/normalizeHotkeyFromParsed.md @@ -3,8 +3,6 @@ id: normalizeHotkeyFromParsed title: normalizeHotkeyFromParsed --- -# Function: normalizeHotkeyFromParsed() - ```ts function normalizeHotkeyFromParsed(parsed, platform): Hotkey; ``` diff --git a/docs/reference/functions/normalizeKeyName.md b/docs/reference/functions/normalizeKeyName.md index cb9e252d..d8c17cc2 100644 --- a/docs/reference/functions/normalizeKeyName.md +++ b/docs/reference/functions/normalizeKeyName.md @@ -3,8 +3,6 @@ id: normalizeKeyName title: normalizeKeyName --- -# Function: normalizeKeyName() - ```ts function normalizeKeyName(key): string; ``` diff --git a/docs/reference/functions/normalizeRegisterableHotkey.md b/docs/reference/functions/normalizeRegisterableHotkey.md index 4ef427a2..e52f60dc 100644 --- a/docs/reference/functions/normalizeRegisterableHotkey.md +++ b/docs/reference/functions/normalizeRegisterableHotkey.md @@ -3,8 +3,6 @@ id: normalizeRegisterableHotkey title: normalizeRegisterableHotkey --- -# Function: normalizeRegisterableHotkey() - ```ts function normalizeRegisterableHotkey(hotkey, platform): Hotkey; ``` diff --git a/docs/reference/functions/parseHotkey.md b/docs/reference/functions/parseHotkey.md index 5dd538e5..31e38958 100644 --- a/docs/reference/functions/parseHotkey.md +++ b/docs/reference/functions/parseHotkey.md @@ -3,8 +3,6 @@ id: parseHotkey title: parseHotkey --- -# Function: parseHotkey() - ```ts function parseHotkey(hotkey, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/parseKeyboardEvent.md b/docs/reference/functions/parseKeyboardEvent.md index 10f41a76..bd38db36 100644 --- a/docs/reference/functions/parseKeyboardEvent.md +++ b/docs/reference/functions/parseKeyboardEvent.md @@ -3,8 +3,6 @@ id: parseKeyboardEvent title: parseKeyboardEvent --- -# Function: parseKeyboardEvent() - ```ts function parseKeyboardEvent(event): ParsedHotkey; ``` diff --git a/docs/reference/functions/rawHotkeyToParsedHotkey.md b/docs/reference/functions/rawHotkeyToParsedHotkey.md index 94583c4e..c32bd52b 100644 --- a/docs/reference/functions/rawHotkeyToParsedHotkey.md +++ b/docs/reference/functions/rawHotkeyToParsedHotkey.md @@ -3,8 +3,6 @@ id: rawHotkeyToParsedHotkey title: rawHotkeyToParsedHotkey --- -# Function: rawHotkeyToParsedHotkey() - ```ts function rawHotkeyToParsedHotkey(raw, platform): ParsedHotkey; ``` diff --git a/docs/reference/functions/resolveModifier.md b/docs/reference/functions/resolveModifier.md index 81b4fb95..473d6a65 100644 --- a/docs/reference/functions/resolveModifier.md +++ b/docs/reference/functions/resolveModifier.md @@ -3,8 +3,6 @@ id: resolveModifier title: resolveModifier --- -# Function: resolveModifier() - ```ts function resolveModifier(modifier, platform): CanonicalModifier; ``` diff --git a/docs/reference/functions/toHotkeyRegistrationView.md b/docs/reference/functions/toHotkeyRegistrationView.md index cea0babe..df1a5f75 100644 --- a/docs/reference/functions/toHotkeyRegistrationView.md +++ b/docs/reference/functions/toHotkeyRegistrationView.md @@ -3,8 +3,6 @@ id: toHotkeyRegistrationView title: toHotkeyRegistrationView --- -# Function: toHotkeyRegistrationView() - ```ts function toHotkeyRegistrationView(reg): HotkeyRegistrationView; ``` diff --git a/docs/reference/functions/validateHotkey.md b/docs/reference/functions/validateHotkey.md index d75bd402..176cd973 100644 --- a/docs/reference/functions/validateHotkey.md +++ b/docs/reference/functions/validateHotkey.md @@ -3,8 +3,6 @@ id: validateHotkey title: validateHotkey --- -# Function: validateHotkey() - ```ts function validateHotkey(hotkey): ValidationResult; ``` diff --git a/docs/reference/index.md b/docs/reference/index.md index fd8f77db..b4307222 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/hotkeys" title: "@tanstack/hotkeys" --- -# @tanstack/hotkeys - ## Classes - [HotkeyManager](classes/HotkeyManager.md) diff --git a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md index 7ff01012..d0a7d280 100644 --- a/docs/reference/interfaces/CreateHotkeyHandlerOptions.md +++ b/docs/reference/interfaces/CreateHotkeyHandlerOptions.md @@ -3,8 +3,6 @@ id: CreateHotkeyHandlerOptions title: CreateHotkeyHandlerOptions --- -# Interface: CreateHotkeyHandlerOptions - Defined in: [match.ts:132](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/match.ts#L132) Options for creating a hotkey handler. diff --git a/docs/reference/interfaces/FormatDisplayOptions.md b/docs/reference/interfaces/FormatDisplayOptions.md index 724e2044..ba92ff51 100644 --- a/docs/reference/interfaces/FormatDisplayOptions.md +++ b/docs/reference/interfaces/FormatDisplayOptions.md @@ -3,8 +3,6 @@ id: FormatDisplayOptions title: FormatDisplayOptions --- -# Interface: FormatDisplayOptions - Defined in: [hotkey.ts:367](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L367) Options for formatting hotkeys for display. diff --git a/docs/reference/interfaces/HotkeyCallbackContext.md b/docs/reference/interfaces/HotkeyCallbackContext.md index edacfce8..c323fb71 100644 --- a/docs/reference/interfaces/HotkeyCallbackContext.md +++ b/docs/reference/interfaces/HotkeyCallbackContext.md @@ -3,8 +3,6 @@ id: HotkeyCallbackContext title: HotkeyCallbackContext --- -# Interface: HotkeyCallbackContext - Defined in: [hotkey.ts:391](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L391) Context passed to hotkey callbacks along with the keyboard event. diff --git a/docs/reference/interfaces/HotkeyMeta.md b/docs/reference/interfaces/HotkeyMeta.md index f0d5fe6f..46b379be 100644 --- a/docs/reference/interfaces/HotkeyMeta.md +++ b/docs/reference/interfaces/HotkeyMeta.md @@ -3,8 +3,6 @@ id: HotkeyMeta title: HotkeyMeta --- -# Interface: HotkeyMeta - Defined in: [hotkey.ts:431](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L431) Metadata for hotkey and sequence registrations. diff --git a/docs/reference/interfaces/HotkeyOptions.md b/docs/reference/interfaces/HotkeyOptions.md index 0e637c02..c172d129 100644 --- a/docs/reference/interfaces/HotkeyOptions.md +++ b/docs/reference/interfaces/HotkeyOptions.md @@ -3,8 +3,6 @@ id: HotkeyOptions title: HotkeyOptions --- -# Interface: HotkeyOptions - Defined in: [hotkey-manager.ts:28](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L28) Options for registering a hotkey. diff --git a/docs/reference/interfaces/HotkeyRecorderOptions.md b/docs/reference/interfaces/HotkeyRecorderOptions.md index 20b6fb57..e1e108bf 100644 --- a/docs/reference/interfaces/HotkeyRecorderOptions.md +++ b/docs/reference/interfaces/HotkeyRecorderOptions.md @@ -3,8 +3,6 @@ id: HotkeyRecorderOptions title: HotkeyRecorderOptions --- -# Interface: HotkeyRecorderOptions - Defined in: [hotkey-recorder.ts:20](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L20) Options for configuring a HotkeyRecorder instance. diff --git a/docs/reference/interfaces/HotkeyRecorderState.md b/docs/reference/interfaces/HotkeyRecorderState.md index cda4de56..0ed52a47 100644 --- a/docs/reference/interfaces/HotkeyRecorderState.md +++ b/docs/reference/interfaces/HotkeyRecorderState.md @@ -3,8 +3,6 @@ id: HotkeyRecorderState title: HotkeyRecorderState --- -# Interface: HotkeyRecorderState - Defined in: [hotkey-recorder.ts:10](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-recorder.ts#L10) State interface for the HotkeyRecorder. diff --git a/docs/reference/interfaces/HotkeyRegistration.md b/docs/reference/interfaces/HotkeyRegistration.md index 775f7d88..083e9c79 100644 --- a/docs/reference/interfaces/HotkeyRegistration.md +++ b/docs/reference/interfaces/HotkeyRegistration.md @@ -3,8 +3,6 @@ id: HotkeyRegistration title: HotkeyRegistration --- -# Interface: HotkeyRegistration - Defined in: [hotkey-manager.ts:58](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L58) A registered hotkey handler in the HotkeyManager. diff --git a/docs/reference/interfaces/HotkeyRegistrationHandle.md b/docs/reference/interfaces/HotkeyRegistrationHandle.md index 981883db..608fb6d5 100644 --- a/docs/reference/interfaces/HotkeyRegistrationHandle.md +++ b/docs/reference/interfaces/HotkeyRegistrationHandle.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationHandle title: HotkeyRegistrationHandle --- -# Interface: HotkeyRegistrationHandle - Defined in: [hotkey-manager.ts:139](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L139) A handle returned from HotkeyManager.register() that allows updating diff --git a/docs/reference/interfaces/HotkeyRegistrationView.md b/docs/reference/interfaces/HotkeyRegistrationView.md index b7c4d8d3..c93f2101 100644 --- a/docs/reference/interfaces/HotkeyRegistrationView.md +++ b/docs/reference/interfaces/HotkeyRegistrationView.md @@ -3,8 +3,6 @@ id: HotkeyRegistrationView title: HotkeyRegistrationView --- -# Interface: HotkeyRegistrationView - Defined in: [hotkey-manager.ts:81](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-manager.ts#L81) Public view of a hotkey registration for display and introspection. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md index a330eb36..7984ab20 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderOptions.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderOptions.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderOptions title: HotkeySequenceRecorderOptions --- -# Interface: HotkeySequenceRecorderOptions - Defined in: [hotkey-sequence-recorder.ts:29](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L29) Options for configuring a HotkeySequenceRecorder instance. diff --git a/docs/reference/interfaces/HotkeySequenceRecorderState.md b/docs/reference/interfaces/HotkeySequenceRecorderState.md index 10330799..c66a6be1 100644 --- a/docs/reference/interfaces/HotkeySequenceRecorderState.md +++ b/docs/reference/interfaces/HotkeySequenceRecorderState.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderState title: HotkeySequenceRecorderState --- -# Interface: HotkeySequenceRecorderState - Defined in: [hotkey-sequence-recorder.ts:17](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey-sequence-recorder.ts#L17) State interface for the HotkeySequenceRecorder. diff --git a/docs/reference/interfaces/KeyStateTrackerState.md b/docs/reference/interfaces/KeyStateTrackerState.md index d256a258..e0c4cbc7 100644 --- a/docs/reference/interfaces/KeyStateTrackerState.md +++ b/docs/reference/interfaces/KeyStateTrackerState.md @@ -3,8 +3,6 @@ id: KeyStateTrackerState title: KeyStateTrackerState --- -# Interface: KeyStateTrackerState - Defined in: [key-state-tracker.ts:7](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/key-state-tracker.ts#L7) State interface for the KeyStateTracker. diff --git a/docs/reference/interfaces/ParsedHotkey.md b/docs/reference/interfaces/ParsedHotkey.md index a142d43c..7facd5ad 100644 --- a/docs/reference/interfaces/ParsedHotkey.md +++ b/docs/reference/interfaces/ParsedHotkey.md @@ -3,8 +3,6 @@ id: ParsedHotkey title: ParsedHotkey --- -# Interface: ParsedHotkey - Defined in: [hotkey.ts:308](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L308) A parsed representation of a hotkey string. diff --git a/docs/reference/interfaces/RawHotkey.md b/docs/reference/interfaces/RawHotkey.md index a0255a8f..36646b3e 100644 --- a/docs/reference/interfaces/RawHotkey.md +++ b/docs/reference/interfaces/RawHotkey.md @@ -3,8 +3,6 @@ id: RawHotkey title: RawHotkey --- -# Interface: RawHotkey - Defined in: [hotkey.ts:343](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L343) A raw hotkey object for programmatic registration. diff --git a/docs/reference/interfaces/SequenceOptions.md b/docs/reference/interfaces/SequenceOptions.md index b021d339..0bbdad42 100644 --- a/docs/reference/interfaces/SequenceOptions.md +++ b/docs/reference/interfaces/SequenceOptions.md @@ -3,8 +3,6 @@ id: SequenceOptions title: SequenceOptions --- -# Interface: SequenceOptions - Defined in: [sequence-manager.ts:27](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L27) Options for hotkey sequence matching. diff --git a/docs/reference/interfaces/SequenceRegistrationHandle.md b/docs/reference/interfaces/SequenceRegistrationHandle.md index c659add7..291816d7 100644 --- a/docs/reference/interfaces/SequenceRegistrationHandle.md +++ b/docs/reference/interfaces/SequenceRegistrationHandle.md @@ -3,8 +3,6 @@ id: SequenceRegistrationHandle title: SequenceRegistrationHandle --- -# Interface: SequenceRegistrationHandle - Defined in: [sequence-manager.ts:119](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L119) A handle returned from SequenceManager.register() that allows updating diff --git a/docs/reference/interfaces/SequenceRegistrationView.md b/docs/reference/interfaces/SequenceRegistrationView.md index 55df6d72..0272083e 100644 --- a/docs/reference/interfaces/SequenceRegistrationView.md +++ b/docs/reference/interfaces/SequenceRegistrationView.md @@ -3,8 +3,6 @@ id: SequenceRegistrationView title: SequenceRegistrationView --- -# Interface: SequenceRegistrationView - Defined in: [sequence-manager.ts:76](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/sequence-manager.ts#L76) View of a sequence registration for devtools display. diff --git a/docs/reference/interfaces/ValidationResult.md b/docs/reference/interfaces/ValidationResult.md index fc7e9c1e..240718fa 100644 --- a/docs/reference/interfaces/ValidationResult.md +++ b/docs/reference/interfaces/ValidationResult.md @@ -3,8 +3,6 @@ id: ValidationResult title: ValidationResult --- -# Interface: ValidationResult - Defined in: [hotkey.ts:379](https://github.com/TanStack/hotkeys/blob/main/packages/hotkeys/src/hotkey.ts#L379) Result of validating a hotkey string. diff --git a/docs/reference/type-aliases/CanonicalModifier.md b/docs/reference/type-aliases/CanonicalModifier.md index 02292671..53756874 100644 --- a/docs/reference/type-aliases/CanonicalModifier.md +++ b/docs/reference/type-aliases/CanonicalModifier.md @@ -3,8 +3,6 @@ id: CanonicalModifier title: CanonicalModifier --- -# Type Alias: CanonicalModifier - ```ts type CanonicalModifier = "Control" | "Shift" | "Alt" | "Meta"; ``` diff --git a/docs/reference/type-aliases/ConflictBehavior.md b/docs/reference/type-aliases/ConflictBehavior.md index 50f06ca9..3d6eac28 100644 --- a/docs/reference/type-aliases/ConflictBehavior.md +++ b/docs/reference/type-aliases/ConflictBehavior.md @@ -3,8 +3,6 @@ id: ConflictBehavior title: ConflictBehavior --- -# Type Alias: ConflictBehavior - ```ts type ConflictBehavior = "warn" | "error" | "replace" | "allow"; ``` diff --git a/docs/reference/type-aliases/EditingKey.md b/docs/reference/type-aliases/EditingKey.md index 7c1bb264..b2c6d964 100644 --- a/docs/reference/type-aliases/EditingKey.md +++ b/docs/reference/type-aliases/EditingKey.md @@ -3,8 +3,6 @@ id: EditingKey title: EditingKey --- -# Type Alias: EditingKey - ```ts type EditingKey = "Enter" | "Escape" | "Space" | "Tab" | "Backspace" | "Delete"; ``` diff --git a/docs/reference/type-aliases/FunctionKey.md b/docs/reference/type-aliases/FunctionKey.md index d2b42f26..7474b4c2 100644 --- a/docs/reference/type-aliases/FunctionKey.md +++ b/docs/reference/type-aliases/FunctionKey.md @@ -3,8 +3,6 @@ id: FunctionKey title: FunctionKey --- -# Type Alias: FunctionKey - ```ts type FunctionKey = | "F1" diff --git a/docs/reference/type-aliases/Hotkey.md b/docs/reference/type-aliases/Hotkey.md index 6a8c5ad0..d1fbd3e3 100644 --- a/docs/reference/type-aliases/Hotkey.md +++ b/docs/reference/type-aliases/Hotkey.md @@ -3,8 +3,6 @@ id: Hotkey title: Hotkey --- -# Type Alias: Hotkey - ```ts type Hotkey = | Key diff --git a/docs/reference/type-aliases/HotkeyCallback.md b/docs/reference/type-aliases/HotkeyCallback.md index 9189e693..cdabb517 100644 --- a/docs/reference/type-aliases/HotkeyCallback.md +++ b/docs/reference/type-aliases/HotkeyCallback.md @@ -3,8 +3,6 @@ id: HotkeyCallback title: HotkeyCallback --- -# Type Alias: HotkeyCallback() - ```ts type HotkeyCallback = (event, context) => void; ``` diff --git a/docs/reference/type-aliases/HotkeySequence.md b/docs/reference/type-aliases/HotkeySequence.md index 9fc95653..fd66c317 100644 --- a/docs/reference/type-aliases/HotkeySequence.md +++ b/docs/reference/type-aliases/HotkeySequence.md @@ -3,8 +3,6 @@ id: HotkeySequence title: HotkeySequence --- -# Type Alias: HotkeySequence - ```ts type HotkeySequence = Hotkey[]; ``` diff --git a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md index 8a84b6ca..0dcdb13b 100644 --- a/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md +++ b/docs/reference/type-aliases/HotkeySequenceRecorderCommitKeys.md @@ -3,8 +3,6 @@ id: HotkeySequenceRecorderCommitKeys title: HotkeySequenceRecorderCommitKeys --- -# Type Alias: HotkeySequenceRecorderCommitKeys - ```ts type HotkeySequenceRecorderCommitKeys = "enter" | "none"; ``` diff --git a/docs/reference/type-aliases/IndividualKey.md b/docs/reference/type-aliases/IndividualKey.md index 84f2e4ca..0a207795 100644 --- a/docs/reference/type-aliases/IndividualKey.md +++ b/docs/reference/type-aliases/IndividualKey.md @@ -3,8 +3,6 @@ id: IndividualKey title: IndividualKey --- -# Type Alias: IndividualKey - ```ts type IndividualKey = CanonicalModifier | Key; ``` diff --git a/docs/reference/type-aliases/Key.md b/docs/reference/type-aliases/Key.md index 01baa032..6b86598b 100644 --- a/docs/reference/type-aliases/Key.md +++ b/docs/reference/type-aliases/Key.md @@ -3,8 +3,6 @@ id: Key title: Key --- -# Type Alias: Key - ```ts type Key = NonPunctuationKey | PunctuationKey; ``` diff --git a/docs/reference/type-aliases/LetterKey.md b/docs/reference/type-aliases/LetterKey.md index 916c7fbc..d26b41ef 100644 --- a/docs/reference/type-aliases/LetterKey.md +++ b/docs/reference/type-aliases/LetterKey.md @@ -3,8 +3,6 @@ id: LetterKey title: LetterKey --- -# Type Alias: LetterKey - ```ts type LetterKey = | "A" diff --git a/docs/reference/type-aliases/Modifier.md b/docs/reference/type-aliases/Modifier.md index 854d8b14..b7b70cf6 100644 --- a/docs/reference/type-aliases/Modifier.md +++ b/docs/reference/type-aliases/Modifier.md @@ -3,8 +3,6 @@ id: Modifier title: Modifier --- -# Type Alias: Modifier - ```ts type Modifier = | "Control" diff --git a/docs/reference/type-aliases/NavigationKey.md b/docs/reference/type-aliases/NavigationKey.md index a1f940b2..4322f82f 100644 --- a/docs/reference/type-aliases/NavigationKey.md +++ b/docs/reference/type-aliases/NavigationKey.md @@ -3,8 +3,6 @@ id: NavigationKey title: NavigationKey --- -# Type Alias: NavigationKey - ```ts type NavigationKey = | "ArrowUp" diff --git a/docs/reference/type-aliases/NumberKey.md b/docs/reference/type-aliases/NumberKey.md index 639b3664..3a2cf3c1 100644 --- a/docs/reference/type-aliases/NumberKey.md +++ b/docs/reference/type-aliases/NumberKey.md @@ -3,8 +3,6 @@ id: NumberKey title: NumberKey --- -# Type Alias: NumberKey - ```ts type NumberKey = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"; ``` diff --git a/docs/reference/type-aliases/PunctuationKey.md b/docs/reference/type-aliases/PunctuationKey.md index 9dda1dbe..086300a6 100644 --- a/docs/reference/type-aliases/PunctuationKey.md +++ b/docs/reference/type-aliases/PunctuationKey.md @@ -3,8 +3,6 @@ id: PunctuationKey title: PunctuationKey --- -# Type Alias: PunctuationKey - ```ts type PunctuationKey = "/" | "[" | "]" | "\" | "=" | "-" | "," | "." | ";" | "`"; ``` diff --git a/docs/reference/type-aliases/RegisterableHotkey.md b/docs/reference/type-aliases/RegisterableHotkey.md index ca996bbf..ff361eca 100644 --- a/docs/reference/type-aliases/RegisterableHotkey.md +++ b/docs/reference/type-aliases/RegisterableHotkey.md @@ -3,8 +3,6 @@ id: RegisterableHotkey title: RegisterableHotkey --- -# Type Alias: RegisterableHotkey - ```ts type RegisterableHotkey = Hotkey | RawHotkey; ``` diff --git a/docs/reference/variables/ALL_KEYS.md b/docs/reference/variables/ALL_KEYS.md index fa471104..eea26a0b 100644 --- a/docs/reference/variables/ALL_KEYS.md +++ b/docs/reference/variables/ALL_KEYS.md @@ -3,8 +3,6 @@ id: ALL_KEYS title: ALL_KEYS --- -# Variable: ALL\_KEYS - ```ts const ALL_KEYS: Set< | LetterKey diff --git a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md index 44098858..21b43843 100644 --- a/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md +++ b/docs/reference/variables/DEFAULT_SEQUENCE_TIMEOUT.md @@ -3,8 +3,6 @@ id: DEFAULT_SEQUENCE_TIMEOUT title: DEFAULT_SEQUENCE_TIMEOUT --- -# Variable: DEFAULT\_SEQUENCE\_TIMEOUT - ```ts const DEFAULT_SEQUENCE_TIMEOUT: 1000 = 1000; ``` diff --git a/docs/reference/variables/EDITING_KEYS.md b/docs/reference/variables/EDITING_KEYS.md index 9d7d717b..8ab1867d 100644 --- a/docs/reference/variables/EDITING_KEYS.md +++ b/docs/reference/variables/EDITING_KEYS.md @@ -3,8 +3,6 @@ id: EDITING_KEYS title: EDITING_KEYS --- -# Variable: EDITING\_KEYS - ```ts const EDITING_KEYS: Set; ``` diff --git a/docs/reference/variables/FUNCTION_KEYS.md b/docs/reference/variables/FUNCTION_KEYS.md index 7dc7311c..a080334b 100644 --- a/docs/reference/variables/FUNCTION_KEYS.md +++ b/docs/reference/variables/FUNCTION_KEYS.md @@ -3,8 +3,6 @@ id: FUNCTION_KEYS title: FUNCTION_KEYS --- -# Variable: FUNCTION\_KEYS - ```ts const FUNCTION_KEYS: Set; ``` diff --git a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md index 3e7a1715..ab3ae732 100644 --- a/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md +++ b/docs/reference/variables/KEY_DISPLAY_SYMBOLS.md @@ -3,8 +3,6 @@ id: KEY_DISPLAY_SYMBOLS title: KEY_DISPLAY_SYMBOLS --- -# Variable: KEY\_DISPLAY\_SYMBOLS - ```ts const KEY_DISPLAY_SYMBOLS: object; ``` diff --git a/docs/reference/variables/LETTER_KEYS.md b/docs/reference/variables/LETTER_KEYS.md index 029e2998..ff488ad5 100644 --- a/docs/reference/variables/LETTER_KEYS.md +++ b/docs/reference/variables/LETTER_KEYS.md @@ -3,8 +3,6 @@ id: LETTER_KEYS title: LETTER_KEYS --- -# Variable: LETTER\_KEYS - ```ts const LETTER_KEYS: Set; ``` diff --git a/docs/reference/variables/LINUX_MODIFIER_LABELS.md b/docs/reference/variables/LINUX_MODIFIER_LABELS.md index ccd7bb39..b6b0bbbd 100644 --- a/docs/reference/variables/LINUX_MODIFIER_LABELS.md +++ b/docs/reference/variables/LINUX_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: LINUX_MODIFIER_LABELS title: LINUX_MODIFIER_LABELS --- -# Variable: LINUX\_MODIFIER\_LABELS - ```ts const LINUX_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_LABELS.md b/docs/reference/variables/MAC_MODIFIER_LABELS.md index 4d2dd13b..3a67ab96 100644 --- a/docs/reference/variables/MAC_MODIFIER_LABELS.md +++ b/docs/reference/variables/MAC_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: MAC_MODIFIER_LABELS title: MAC_MODIFIER_LABELS --- -# Variable: MAC\_MODIFIER\_LABELS - ```ts const MAC_MODIFIER_LABELS: Record; ``` diff --git a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md index 66f0949f..2a5fb855 100644 --- a/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md +++ b/docs/reference/variables/MAC_MODIFIER_SYMBOLS.md @@ -3,8 +3,6 @@ id: MAC_MODIFIER_SYMBOLS title: MAC_MODIFIER_SYMBOLS --- -# Variable: MAC\_MODIFIER\_SYMBOLS - ```ts const MAC_MODIFIER_SYMBOLS: Record; ``` diff --git a/docs/reference/variables/MODIFIER_ALIASES.md b/docs/reference/variables/MODIFIER_ALIASES.md index d9f2e146..bf1c705f 100644 --- a/docs/reference/variables/MODIFIER_ALIASES.md +++ b/docs/reference/variables/MODIFIER_ALIASES.md @@ -3,8 +3,6 @@ id: MODIFIER_ALIASES title: MODIFIER_ALIASES --- -# Variable: MODIFIER\_ALIASES - ```ts const MODIFIER_ALIASES: Record; ``` diff --git a/docs/reference/variables/MODIFIER_KEYS.md b/docs/reference/variables/MODIFIER_KEYS.md index b289d5ae..d106ab14 100644 --- a/docs/reference/variables/MODIFIER_KEYS.md +++ b/docs/reference/variables/MODIFIER_KEYS.md @@ -3,8 +3,6 @@ id: MODIFIER_KEYS title: MODIFIER_KEYS --- -# Variable: MODIFIER\_KEYS - ```ts const MODIFIER_KEYS: Set; ``` diff --git a/docs/reference/variables/MODIFIER_ORDER.md b/docs/reference/variables/MODIFIER_ORDER.md index df05181b..397794eb 100644 --- a/docs/reference/variables/MODIFIER_ORDER.md +++ b/docs/reference/variables/MODIFIER_ORDER.md @@ -3,8 +3,6 @@ id: MODIFIER_ORDER title: MODIFIER_ORDER --- -# Variable: MODIFIER\_ORDER - ```ts const MODIFIER_ORDER: CanonicalModifier[]; ``` diff --git a/docs/reference/variables/NAVIGATION_KEYS.md b/docs/reference/variables/NAVIGATION_KEYS.md index 176feb07..917c62ba 100644 --- a/docs/reference/variables/NAVIGATION_KEYS.md +++ b/docs/reference/variables/NAVIGATION_KEYS.md @@ -3,8 +3,6 @@ id: NAVIGATION_KEYS title: NAVIGATION_KEYS --- -# Variable: NAVIGATION\_KEYS - ```ts const NAVIGATION_KEYS: Set; ``` diff --git a/docs/reference/variables/NUMBER_KEYS.md b/docs/reference/variables/NUMBER_KEYS.md index d1258c24..6da27051 100644 --- a/docs/reference/variables/NUMBER_KEYS.md +++ b/docs/reference/variables/NUMBER_KEYS.md @@ -3,8 +3,6 @@ id: NUMBER_KEYS title: NUMBER_KEYS --- -# Variable: NUMBER\_KEYS - ```ts const NUMBER_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_CODE_MAP.md b/docs/reference/variables/PUNCTUATION_CODE_MAP.md index 69f58b48..6d8bf6ae 100644 --- a/docs/reference/variables/PUNCTUATION_CODE_MAP.md +++ b/docs/reference/variables/PUNCTUATION_CODE_MAP.md @@ -3,8 +3,6 @@ id: PUNCTUATION_CODE_MAP title: PUNCTUATION_CODE_MAP --- -# Variable: PUNCTUATION\_CODE\_MAP - ```ts const PUNCTUATION_CODE_MAP: Record; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEYS.md b/docs/reference/variables/PUNCTUATION_KEYS.md index 4824f594..90f76148 100644 --- a/docs/reference/variables/PUNCTUATION_KEYS.md +++ b/docs/reference/variables/PUNCTUATION_KEYS.md @@ -3,8 +3,6 @@ id: PUNCTUATION_KEYS title: PUNCTUATION_KEYS --- -# Variable: PUNCTUATION\_KEYS - ```ts const PUNCTUATION_KEYS: Set; ``` diff --git a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md index 5891854c..3cac002c 100644 --- a/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md +++ b/docs/reference/variables/PUNCTUATION_KEY_DISPLAY_LABELS.md @@ -3,8 +3,6 @@ id: PUNCTUATION_KEY_DISPLAY_LABELS title: PUNCTUATION_KEY_DISPLAY_LABELS --- -# Variable: PUNCTUATION\_KEY\_DISPLAY\_LABELS - ```ts const PUNCTUATION_KEY_DISPLAY_LABELS: object; ``` diff --git a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md index fb85e6c1..4b1f6829 100644 --- a/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md +++ b/docs/reference/variables/WINDOWS_MODIFIER_LABELS.md @@ -3,8 +3,6 @@ id: WINDOWS_MODIFIER_LABELS title: WINDOWS_MODIFIER_LABELS --- -# Variable: WINDOWS\_MODIFIER\_LABELS - ```ts const WINDOWS_MODIFIER_LABELS: Record; ```