HotkeyEvent
interface exported by @mwillbanks/tuil-hotkeys.
interface
Public interface exported by @mwillbanks/tuil-hotkeys.
export interface HotkeyEvent {
readonly keys: string;
readonly input: string;
readonly sequence: readonly string[];
readonly binding: HotkeyBinding;
defaultPrevented: boolean;
preventDefault(): void;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
keys | string | Yes | The keys member uses the string contract. | — |
input | string | Yes | The input member uses the string contract. | — |
sequence | readonly string[] | Yes | The sequence member uses the readonly string[] contract. | — |
binding | HotkeyBinding | Yes | The binding member uses the HotkeyBinding contract. | HotkeyBinding |
defaultPrevented | boolean | Yes | The defaultPrevented member uses the boolean contract. | — |
preventDefault | () => void | Yes | The preventDefault member uses the () => void contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference