Interface: MouseEvent

@termwright/driver/experimental

---

@termwright/driver/experimental / MouseEvent

Interface: MouseEvent

Defined in: mouse.ts:24

One mouse event in viewport cell coordinates (zero-based).

Properties

button?

readonly optional button?: MouseButton

Defined in: mouse.ts:28

---

column

readonly column: number

Defined in: mouse.ts:27

---

dragging?

readonly optional dragging?: boolean

Defined in: mouse.ts:34

True while a button is held (motion events use the drag bit).

---

kind

readonly kind: "press" | "release" | "move" | "wheel"

Defined in: mouse.ts:25

---

modifiers?

readonly optional modifiers?: readonly ("shift" | "alt" | "control")[]

Defined in: mouse.ts:29

---

row

readonly row: number

Defined in: mouse.ts:26

---

wheelAxis?

readonly optional wheelAxis?: "vertical" | "horizontal"

Defined in: mouse.ts:32

---

wheelDelta?

readonly optional wheelDelta?: number

Defined in: mouse.ts:31

Wheel direction; positive scrolls down, negative scrolls up.