IHotkeyOptions

interface
Directives & Utilities

Configuration options for the useHotkey composable and the v-hotkey directive — controls the listened event type, whether inputs are excluded and sequence timing.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

event
MaybeRef<'keydown' | 'keyup'>
Keyboard event to listen on — 'keydown' (default) or 'keyup'.
inputs
MaybeRef<boolean>
When true, the hotkey fires even when focus is inside an input, textarea or select element. Defaults to false.
preventDefault
MaybeRef<boolean>
When true, calls event.preventDefault() before invoking the handler. Defaults to false.
sequenceTimeout
MaybeRef<number>
Milliseconds allowed between successive keys in a sequence binding before the sequence resets. Defaults to 1000.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Passing options to useHotkey

typescript