tui/src/input/types.ts at 42b156d740c7a7bea09bcf079a9e7ac416353bff · nberlette/tui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
import type { Range } from "../types.ts";

/** Interface defining key press issued to stdin */
export interface KeyPressEvent {
  key: Key;
  meta: boolean;
  ctrl: boolean;
  shift: boolean;
  buffer: Uint8Array;
}

/** Interface defining any mouse event issued to stdin */
export interface MouseEvent {
  key: "mouse";
  buffer: Uint8Array;
  x: number;
  y: number;
  movementX: number;
  movementY: number;
  meta: boolean;
  ctrl: boolean;
  shift: boolean;
}

/** Interface defining mouse press issued to stdin */
export interface MousePressEvent extends MouseEvent {
  drag: boolean;
  release: boolean;
  /** undefined when `release` is true */
  button: 0 | 1 | 2 | undefined;
}

export interface MouseScrollEvent extends MouseEvent {
  drag: boolean;
  /**
   *  - 1 – Scrolls downwards
   *  - 0 – Doesn't scroll
   *  - -1 – Scrolls upwards
   */
  scroll: 1 | 0 | -1;
}

export type Key =
  | Alphabet
  | Chars
  | SpecialKeys
  | `${Range<0, 10>}`
  | `f${Range<1, 12>}`;

/** Type defining letters from the latin alphabet */
export type Alphabet =
  | "a"
  | "b"
  | "c"
  | "d"
  | "e"
  | "f"
  | "g"
  | "h"
  | "i"
  | "j"
  | "k"
  | "l"
  | "m"
  | "n"
  | "o"
  | "p"
  | "q"
  | "r"
  | "s"
  | "t"
  | "u"
  | "v"
  | "w"
  | "x"
  | "y"
  | "z";

/** Type defining special keys */
export type SpecialKeys =
  | "return"
  | "tab"
  | "backspace"
  | "escape"
  | "space"
  | "up"
  | "down"
  | "left"
  | "right"
  | "clear"
  | "insert"
  | "delete"
  | "pageup"
  | "pagedown"
  | "home"
  | "end"
  | "tab";

/** Type defining interpunction characters */
export type Chars =
  | "!"
  | "@"
  | "#"
  | "$"
  | "%"
  | "^"
  | "&"
  | "*"
  | "("
  | ")"
  | "-"
  | "_"
  | "="
  | "+"
  | "["
  | "{"
  | "]"
  | "}"
  | "'"
  | '"'
  | ";"
  | ":"
  | ","
  | "<"
  | "."
  | ">"
  | "/"
  | "?"
  | "\\"
  | "|";