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

    Interface ErrorStateData

    Stateful data accepted by the Blessed errorState adapter.

    interface ErrorStateData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        align?: EmptyStateAlign;
        cause?: string;
        height?: number;
        marker?: string;
        message: string;
        retry?: string;
        showMarker?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? align? cause? height? marker? message retry? showMarker? width?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'danger'

    align?: EmptyStateAlign

    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.

    Settings

    Member Visibility

    On This Page

    Properties