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

    Interface RenderCalloutOptions

    Options accepted by renderCallout.

    interface RenderCalloutOptions {
        border?: CalloutBorderCharacters;
        content?: string;
        marker?: string;
        markers?: AlertMarkers;
        padding?: number;
        showMarker?: boolean;
        title?: string;
        tone?: AlertTone;
        width?: number;
    }
    Index

    Properties

    Border characters.

    Every border character must be exactly one terminal cell wide.

    CALLOUT_UNICODE_BORDER

    content?: string

    Explanatory body text.

    marker?: string

    Explicit one-cell marker rendered before the first title/content line.

    markers?: AlertMarkers

    Semantic marker mapping.

    Every marker must be exactly one terminal cell wide.

    ALERT_UNICODE_MARKERS

    padding?: number

    Horizontal padding inside the frame.

    1

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    title?: string

    Optional primary callout text.

    tone?: AlertTone

    Semantic status used to select a marker.

    'info'

    width?: number

    Total rendered width measured in terminal cells.