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

    Interface RenderToastOptions

    Options accepted by renderToast.

    interface RenderToastOptions {
        createdAt?: number;
        description?: string;
        durationMs?: number;
        id: string;
        title: string;
        tone?: ToastTone;
        marker?: string;
        markers?: ToastMarkers;
        showMarker?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt? description? durationMs? id title tone? marker? markers? showMarker? width?

    Properties

    createdAt?: number

    Creation timestamp in milliseconds.

    description?: string

    Optional detail text rendered under the title.

    durationMs?: number

    Auto-dismiss duration in milliseconds. Infinity keeps the toast.

    id: string

    Stable unique identifier.

    title: string

    Primary toast text.

    tone?: ToastTone

    Semantic status used to select a marker.

    'info'

    marker?: string

    Explicit one-cell marker rendered before the title.

    markers?: ToastMarkers

    Semantic marker mapping.

    Every marker must be exactly one terminal cell wide.

    TOAST_UNICODE_MARKERS

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties