gespenst API - v0.1.0
    Preparing search index...

    Interface KeyInput

    A physical or composed keyboard input sent to Ghostty.

    interface KeyInput {
        action?: KeyAction;
        code: string;
        composing?: boolean;
        consumedModifiers?: number;
        modifiers?: number;
        text?: string;
        unshiftedCodepoint?: number;
    }
    Index
    action? code composing? consumedModifiers? modifiers? text? unshiftedCodepoint?
    action?: KeyAction

    Key lifecycle phase. Defaults to press.

    code: string

    A KeyboardEvent.code value such as KeyA, ArrowUp, or Enter.

    composing?: boolean

    Whether an input-method composition is active.

    consumedModifiers?: number

    Modifier bits already consumed by text generation.

    modifiers?: number

    Active KeyModifiers bit mask.

    Optional Readonlytext

    text?: string

    Composed text associated with the key.

    unshiftedCodepoint?: number

    Unicode code point before keyboard-layout shifting.

    Settings
    Member Visibility

    On This Page
    Properties