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

    Interface RenderErrorStateOptions

    Options accepted by renderErrorState.

    interface RenderErrorStateOptions {
        align?: EmptyStateAlign;
        cause?: string;
        height?: number;
        marker?: string;
        message: string;
        retry?: string;
        showMarker?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Horizontal alignment applied when width is configured.

    'center'

    cause?: string

    Optional underlying cause rendered under the message.

    Empty sanitized causes are omitted.

    height?: number

    Maximum rendered line count.

    marker?: string

    Optional marker rendered before the message.

    '×'

    message: string

    Non-empty primary error message.

    retry?: string

    Optional retry or recovery hint rendered after the cause.

    Empty sanitized retry hints are omitted.

    showMarker?: boolean

    Whether the marker is rendered.

    true

    width?: number

    Maximum rendered width measured in terminal cells.