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

    Interface RenderBannerOptions

    Options accepted by renderBanner.

    interface RenderBannerOptions {
        action?: string;
        marker?: string;
        markers?: AlertMarkers;
        message: string;
        showMarker?: boolean;
        title?: string;
        tone?: AlertTone;
        width?: number;
    }
    Index

    Properties

    action? marker? markers? message showMarker? title? tone? width?

    Properties

    action?: string

    Optional action hint displayed at the end of the first line.

    marker?: string

    Explicit one-cell marker.

    markers?: AlertMarkers

    Semantic marker mapping.

    message: string

    Required app-level status message.

    showMarker?: boolean

    Whether to display the semantic marker.

    true

    title?: string

    Optional short heading displayed before the message.

    tone?: AlertTone

    Semantic status.

    'info'

    width?: number

    Full rendered width in terminal cells. Lines are padded to this width.

    Settings

    Member Visibility

    On This Page

    Properties