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

    Interface BannerData

    interface BannerData {
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        markers?: AlertMarkers;
        foregroundTone?: keyof ThemeColors;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        action?: string;
        marker?: string;
        message: string;
        showMarker?: boolean;
        title?: string;
        tone?: AlertTone;
        width?: number;
    }

    Hierarchy

    Index

    Properties

    capabilities? markers? foregroundTone? backgroundTone? borderTone? theme? action? marker? message showMarker? title? tone? width?

    Properties

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">
    markers?: AlertMarkers
    foregroundTone?: keyof ThemeColors
    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    action?: string

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

    marker?: string

    Explicit one-cell marker.

    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