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

    Interface LoadingOverlayData

    Stateful data accepted by the Blessed loadingOverlay adapter.

    interface LoadingOverlayData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        autoStart?: boolean;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        dismissOnEscape?: boolean;
        frames?: readonly string[];
        id: string;
        interval?: number;
        onFrame?: (context: LoadingOverlayFrameContext) => void;
        tone?: keyof ThemeColors;
        align?: EmptyStateAlign;
        description?: string;
        height?: number;
        label?: string;
        showSpinner?: boolean;
        width?: number;
        defaultOpen?: boolean;
        onOpenChange?: (open: boolean) => void;
        open?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundTone? borderTone? theme? autoStart? capabilities? dismissOnEscape? frames? id interval? onFrame? tone? align? description? height? label? showSpinner? width? defaultOpen? onOpenChange? open?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    autoStart?: boolean

    Whether animation starts while the overlay is open.

    true

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

    Explicit capabilities used for deterministic output.

    dismissOnEscape?: boolean

    Whether Escape requests closing while this overlay is topmost.

    false

    frames?: readonly string[]

    Custom ordered one-cell animation frames.

    id: string

    Stable overlay identifier.

    interval?: number

    Timer delay in milliseconds.

    80

    onFrame?: (context: LoadingOverlayFrameContext) => void

    Called after an owned timer or manual tick advances the frame.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'primary'

    align?: EmptyStateAlign

    Horizontal alignment applied when width is configured.

    'center'

    description?: string

    Optional detail text rendered under the label.

    height?: number

    Maximum rendered line count.

    label?: string

    Primary loading text.

    'Loading'

    showSpinner?: boolean

    Whether the spinner frame is rendered before the label.

    true

    width?: number

    Maximum rendered width measured in terminal cells.

    defaultOpen?: boolean

    Initial state for uncontrolled usage.

    false

    onOpenChange?: (open: boolean) => void

    Called when Overlay requests an open-state change.

    open?: boolean

    Controlled open state.

    Settings

    Member Visibility

    On This Page

    Properties