Interface MouseEvent

interface MouseEvent {
    alt: boolean;
    button: MouseButton;
    col: number;
    ctrl: boolean;
    pressed: boolean;
    row: number;
    sequence: string;
    shift: boolean;
    stopPropagation: () => void;
}

Properties

alt: boolean

col: number

1-based terminal column (leftmost = 1).

ctrl: boolean

pressed: boolean

true = press / wheel tick. false = button release.

row: number

1-based terminal row (topmost = 1).

sequence: string

Raw SGR escape sequence that produced this event.

shift: boolean

stopPropagation: () => void

Call to stop bubbling to ancestor boxes. No-op on raw useMouse events.