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

    Interface AlertData

    Stateful data accepted by the Blessed alert adapter.

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

    Hierarchy

    Index

    Properties

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

    Properties

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    markers?: AlertMarkers

    Custom semantic markers.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token. Defaults to the alert tone.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    description?: string

    Optional detail text rendered under the title.

    Empty sanitized descriptions are omitted.

    marker?: string

    Explicit one-cell marker rendered before the title or description.

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    title?: string

    Optional primary alert text.

    tone?: AlertTone

    Semantic status used to select a marker.

    'info'

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties