UseMouseInput

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:15

Everything the mouse decision depends on. See resolveUseMouse.

Properties

explicitUseMouse?

optional explicitUseMouse?: boolean

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:29

useMouse as the user actually wrote it — read from the RAW config, BEFORE DEFAULT_CONFIG is merged in. undefined means the user set nothing. After the default merge an explicit true is indistinguishable from the default true, so this must be captured pre-merge or the rung collapses (the same trap explicitUseColour documents).

---

noMouse?

optional noMouse?: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:22

Raw GTH_NO_MOUSE environment value; undefined when the variable is not set at all. Set and non-empty means mouse OFF. This rung outranks config because it is the escape hatch that works WITHOUT editing a config file — the state someone is in when their terminal mishandles tracking and the session is already unpleasant to use.

---

stdinIsTTY

stdinIsTTY: boolean

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:35

Whether stdin is a terminal — mouse REPORTS arrive on stdin, so both ends must be a TTY.

---

stdoutIsTTY

stdoutIsTTY: boolean

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:33

Whether stdout is a terminal.

---

term?

optional term?: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/config/mouse.ts:31

Raw TERM; dumb, empty or unset describes a terminal that cannot be expected to track.