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

    Interface RenderEmptyStateOptions

    Options accepted by renderEmptyState.

    interface RenderEmptyStateOptions {
        action?: string;
        align?: EmptyStateAlign;
        description?: string;
        height?: number;
        marker?: string;
        showMarker?: boolean;
        title: string;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action?: string

    Optional action hint rendered after the description.

    Empty sanitized actions are omitted.

    Horizontal alignment applied when width is configured.

    'center'

    description?: string

    Optional detail text rendered under the title.

    Empty sanitized descriptions are omitted.

    height?: number

    Maximum rendered line count.

    marker?: string

    Optional marker rendered before the title.

    '○'

    showMarker?: boolean

    Whether the marker is rendered.

    true

    title: string

    Non-empty primary empty-state message.

    width?: number

    Maximum rendered width measured in terminal cells.