Hotkeys Docs
API Reference
Hotkeys API Reference
- HotkeyManager
- getHotkeyManager
- Hotkey
- HotkeyChord
- HotkeySequence
- RegisterableHotkey
- RegisterableHotkeyChord
- RegisterableHotkeySequence
- RawHotkeyChord
- HotkeyOptions
- HotkeyChordOptions
- HotkeySequenceOptions
- HotkeyOptionsFor
- HotkeyRegistrationHandle
- HotkeyRegistrationView
- HotkeyChordRegistrationView
- HotkeySequenceRegistrationView
- toHotkeyRegistrationView
- HotkeyCallback
- HotkeyCallbackContext
- HotkeyChordCallbackContext
- HotkeySequenceCallbackContext
- HotkeyCallbackContextFor
- HotkeyMeta
- ConflictBehavior
- isHotkeySequence
- simplifyHotkey
- createSequenceMatcher
- DEFAULT_SEQUENCE_TIMEOUT
- provideHotkeysContext
- useDefaultHotkeysOptions
- useHotkey
- useHotkeyRegistrations
- useHotkeys
- useHotkeysContext
- HotkeysProviderOptions
- ProvideHotkeysContextOptions
- UseHotkeyChordOptions
- UseHotkeyCommonOptions
- UseHotkeyDefinition
- UseHotkeyOptions
- UseHotkeyOptionsFor
- UseHotkeySequenceOptions
- UseHotkeyTarget
- HotkeysProvider
App Hotkeys API Reference
- defineAppHotkeys
- AppHotkeysStore
- provideAppHotkeys
- publishAppHotkeysStore
- AppHotkey
- AppHotkeyInput
- AppHotkeyOptions
- AppHotkeyListItem
- AppHotkeyStatus
- AppHotkeysState
- AppHotkeysStoreOptions
- CustomHotkeys
- Register
- AppHotkeyId
- RegisteredAppHotkeys
- isAppHotkey
- isCustomHotkey
- resolveAppHotkey
- useAppHotkeyList
- useAppHotkeys
- useCustomHotkeys
- UseCustomHotkeysResult
- UseAppHotkeyOptions
Key hold & held keys API Reference
Hotkey Recorder API Reference
- HotkeyRecorder
- HotkeyRecorderOptions
- HotkeyChordRecorderOptions
- HotkeySequenceRecorderOptions
- HotkeyRecorderState
- HotkeyRecorderCommitKeys
- HotkeyRecorderValidationContext
- HotkeyChordRecorderValidationContext
- HotkeySequenceRecorderValidationContext
- RecorderOptions
- RecorderRejection
- RecorderKeyMode
- findHotkeyConflicts
- HotkeyConflict
- HotkeyConflictOptions
- useHotkeyRecorder
- VueHotkeyRecorder
Normalization & format API Reference
- formatForDisplay
- FormatDisplayOptions
- DisplayHotkey
- DisplayHotkeyChord
- formatHotkey
- normalizeHotkey
- parseHotkey
- parseKeyboardEvent
- ParsedHotkeyChord
- matchesKeyboardEvent
- areHotkeysEqual
- validateHotkey
- checkHotkey
- assertValidHotkey
- ValidationResult
- ValidatableHotkey
- LogicalKey
- PhysicalKey
- PhysicalKeyCode
- KEY_DISPLAY_SYMBOLS
- PUNCTUATION_KEY_DISPLAY_LABELS
- MAC_MODIFIER_SYMBOLS
- MAC_MODIFIER_LABELS
- WINDOWS_MODIFIER_LABELS
- LINUX_MODIFIER_LABELS
- MODIFIER_ALIASES
- MODIFIER_ORDER
- MODIFIER_KEYS
AI/LLM: This documentation page is available in plain markdown format at/hotkeys/latest/docs/framework/vue/reference/variables/HotkeysProvider.md
Hotkeys API Reference
HotkeysProvider
ts
const HotkeysProvider: DefineComponent<ExtractPropTypes<{
appHotkeys: {
default: undefined;
type: PropType<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>;
};
customHotkeys: {
default: undefined;
type: PropType<
| CustomHotkeys<Readonly<Record<string, AppHotkey<string, ... | ... | ...>>>>
| null>;
};
defaultOptions: {
default: undefined;
type: PropType<HotkeysProviderOptions>;
};
enabled: {
default: boolean;
type: BooleanConstructor;
};
exclusive: {
default: boolean;
type: PropType<
| boolean
| {
}
| undefined>;
};
scope: {
default: undefined;
type: StringConstructor;
};
}>, () =>
| VNode<RendererNode, RendererElement, {
[key: string]: any;
}>[]
| undefined, {
}, {
}, {
}, ComponentOptionsMixin, ComponentOptionsMixin, {
customHotkeysChange: (_customHotkeys) => true;
}, string, PublicProps, ToResolvedProps<ExtractPropTypes<{
appHotkeys: {
default: undefined;
type: PropType<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>;
};
customHotkeys: {
default: undefined;
type: PropType<
| CustomHotkeys<Readonly<Record<string, AppHotkey<..., ...>>>>
| null>;
};
defaultOptions: {
default: undefined;
type: PropType<HotkeysProviderOptions>;
};
enabled: {
default: boolean;
type: BooleanConstructor;
};
exclusive: {
default: boolean;
type: PropType<
| boolean
| {
}
| undefined>;
};
scope: {
default: undefined;
type: StringConstructor;
};
}>, {
customHotkeysChange: (_customHotkeys) => true;
}>, {
appHotkeys: Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>;
customHotkeys: | CustomHotkeys<Readonly<Record<string, AppHotkey<string, HotkeyChord | HotkeySequence | null>>>>
| null;
defaultOptions: HotkeysProviderOptions;
enabled: boolean;
exclusive: | boolean
| {
}
| undefined;
scope: string;
}, {
}, {
}, {
}, string, ComponentProvideOptions, true, {
}, any>;Defined in: HotkeysProvider.tsx:37
Vue component that provides default options, app hotkeys, and the user's custom hotkeys. customHotkeys is read once; listen to custom-hotkeys-change to save changes.
Nest providers to create hotkey scopes. A nested provider inherits app hotkeys and merges default options. With scope, its hotkeys fire only while it is mounted and enabled; with exclusive, only its hotkeys fire.
Examples#
vue
<template>
<HotkeysProvider
:app-hotkeys="appHotkeys"
:custom-hotkeys="saved"
@custom-hotkeys-change="save"
>
<App />
</HotkeysProvider>
</template>vue
<HotkeysProvider scope="edit-dialog" :exclusive="{ allow: ['global'] }">
<DialogBody />
</HotkeysProvider>