TerminalKey
interface exported by @mwillbanks/tuil-hotkeys.
interface
Public interface exported by @mwillbanks/tuil-hotkeys.
export interface TerminalKey {
readonly name?: string;
readonly ctrl?: boolean;
readonly shift?: boolean;
readonly meta?: boolean;
readonly alt?: boolean;
readonly escape?: boolean;
readonly return?: boolean;
readonly tab?: boolean;
readonly backspace?: boolean;
readonly delete?: boolean;
readonly upArrow?: boolean;
readonly downArrow?: boolean;
readonly leftArrow?: boolean;
readonly rightArrow?: boolean;
readonly pageUp?: boolean;
readonly pageDown?: boolean;
readonly home?: boolean;
readonly end?: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
name | string | undefined | No | The name member uses the string | undefined contract. | — |
ctrl | boolean | undefined | No | The ctrl member uses the boolean | undefined contract. | — |
shift | boolean | undefined | No | The shift member uses the boolean | undefined contract. | — |
meta | boolean | undefined | No | The meta member uses the boolean | undefined contract. | — |
alt | boolean | undefined | No | The alt member uses the boolean | undefined contract. | — |
escape | boolean | undefined | No | The escape member uses the boolean | undefined contract. | — |
return | boolean | undefined | No | The return member uses the boolean | undefined contract. | — |
tab | boolean | undefined | No | The tab member uses the boolean | undefined contract. | — |
backspace | boolean | undefined | No | The backspace member uses the boolean | undefined contract. | — |
delete | boolean | undefined | No | The delete member uses the boolean | undefined contract. | — |
upArrow | boolean | undefined | No | The upArrow member uses the boolean | undefined contract. | — |
downArrow | boolean | undefined | No | The downArrow member uses the boolean | undefined contract. | — |
leftArrow | boolean | undefined | No | The leftArrow member uses the boolean | undefined contract. | — |
rightArrow | boolean | undefined | No | The rightArrow member uses the boolean | undefined contract. | — |
pageUp | boolean | undefined | No | The pageUp member uses the boolean | undefined contract. | — |
pageDown | boolean | undefined | No | The pageDown member uses the boolean | undefined contract. | — |
home | boolean | undefined | No | The home member uses the boolean | undefined contract. | — |
end | boolean | undefined | No | The end member uses the boolean | undefined 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
No package-local related types.
Source
View the secondary source reference