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

    Interface CalloutData

    Stateful data accepted by the Blessed callout adapter.

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

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? border? foregroundTone? markers? content? marker? padding? showMarker? title? tone? width?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

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

    Explicit terminal capabilities used for deterministic rendering.

    border?: CalloutBorderCharacters

    Custom border characters.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token. Defaults to the callout tone.

    markers?: AlertMarkers

    Custom semantic markers.

    Optionalcontent

    content?: string

    Explanatory body text.

    marker?: string

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

    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.

    Settings

    Member Visibility

    On This Page

    Properties