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

    Interface ToastData

    Stateful data accepted by the Blessed toast adapter.

    interface ToastData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        foregroundTone?: keyof ThemeColors;
        gap?: number;
        markers?: ToastMarkers;
        showMarker?: boolean;
        width?: number;
        maxToasts?: number;
        toasts?: readonly ToastItem[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? foregroundTone? gap? markers? showMarker? width? maxToasts? toasts?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    gap?: number

    Empty lines inserted between toasts.

    1

    markers?: ToastMarkers

    Semantic marker mapping forwarded to each toast.

    showMarker?: boolean

    Whether semantic markers are rendered.

    true

    width?: number

    Maximum rendered width measured in terminal cells.

    maxToasts?: number

    Maximum retained toasts.

    5

    toasts?: readonly ToastItem[]

    Initial toast collection.

    Settings

    Member Visibility

    On This Page

    Properties