blessed-components - v1.20.0
    Preparing search index...

    Interface TerminalPaneData

    Stateful data accepted by the Blessed terminalPane adapter.

    interface TerminalPaneData {
        follow?: boolean;
        onLinesChange?: (lines: readonly TerminalPaneLine[]) => void;
        onOffsetChange?: (offset: number) => void;
        pageOverlap?: number;
        command?: TerminalPaneCommand;
        emptyText?: string;
        exitCode?: number;
        height?: number;
        lines?: readonly TerminalPaneLine[];
        offset?: number;
        showHeader?: boolean;
        status?: TerminalPaneStatus;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    follow? onLinesChange? onOffsetChange? pageOverlap? command? emptyText? exitCode? height? lines? offset? showHeader? status? width?

    Properties

    follow?: boolean

    Whether to follow appended output.

    true

    onLinesChange?: (lines: readonly TerminalPaneLine[]) => void

    Called when output lines change.

    onOffsetChange?: (offset: number) => void

    Called when visual offset changes.

    pageOverlap?: number

    Rows retained between page operations.

    1

    command?: TerminalPaneCommand

    Command metadata displayed in the header.

    emptyText?: string

    Text displayed when no output exists.

    exitCode?: number

    Exit code when the session completed.

    height?: number

    Maximum rendered height.

    lines?: readonly TerminalPaneLine[]

    Output lines.

    offset?: number

    First output row to render after the header.

    showHeader?: boolean

    Whether to render the command/status header.

    true

    status?: TerminalPaneStatus

    Current lifecycle status.

    width?: number

    Maximum terminal-cell width of each line.

    Settings

    Member Visibility

    On This Page

    Properties