@cartridge-engine/keyboard-engine
    Preparing search index...

    Type Alias MouseEventBase

    Base interface for all mouse event types.

    This interface contains the common properties shared across all mouse events, regardless of the protocol used to encode them.

    type MouseEventBase = {
        action: MouseEventAction;
        alt: boolean;
        button: ButtonType;
        ctrl: boolean;
        data: string;
        raw: number;
        shift: boolean;
        x: number;
        y: number;
    }
    Index

    The type of action that occurred

    alt: boolean

    Whether the Alt key was held during the event

    button: ButtonType

    The button that triggered the event

    ctrl: boolean

    Whether the Ctrl key was held during the event

    data: string

    The raw ANSI escape sequence data received from the terminal

    raw: number

    The raw button code from the terminal protocol

    shift: boolean

    Whether the Shift key was held during the event

    x: number

    The x-coordinate (column) of the mouse position (1-indexed)

    y: number

    The y-coordinate (row) of the mouse position (1-indexed)