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

    Interface RenderTerminalPaneOptions

    Options accepted by renderTerminalPane.

    interface RenderTerminalPaneOptions {
        command?: TerminalPaneCommand;
        emptyText?: string;
        exitCode?: number;
        height?: number;
        lines?: readonly TerminalPaneLine[];
        offset?: number;
        showHeader?: boolean;
        status?: TerminalPaneStatus;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    command? emptyText? exitCode? height? lines? offset? showHeader? status? width?

    Properties

    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