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

    Interface OverlayData

    Stateful data accepted by the Blessed overlay adapter.

    interface OverlayData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        dismissOnEscape?: boolean;
        id: string;
        modal?: boolean;
        defaultOpen?: boolean;
        onOpenChange?: (open: boolean) => void;
        open?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? dismissOnEscape? id modal? defaultOpen? onOpenChange? open?

    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'

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

    dismissOnEscape?: boolean

    Whether Escape requests closing while this overlay is topmost.

    true

    id: string

    Stable overlay identifier.

    modal?: boolean

    Whether this overlay blocks lower overlay layers.

    false

    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