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

    Interface RenderAlertOptions

    Options accepted by renderAlert.

    interface RenderAlertOptions {
        description?: string;
        marker?: string;
        markers?: AlertMarkers;
        showMarker?: boolean;
        title?: string;
        tone?: AlertTone;
        width?: number;
    }
    Index

    Properties

    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.

    markers?: AlertMarkers

    Semantic marker mapping.

    Every marker must be exactly one terminal cell wide.

    ALERT_UNICODE_MARKERS

    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.