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

    Interface AppShellData

    Stateful data accepted by the Blessed appShell adapter.

    interface AppShellData {
        content?: string;
        defaultSidebarCollapsed?: boolean;
        footerContent?: string;
        footerHeight?: number;
        gap?: number;
        headerContent?: string;
        headerHeight?: number;
        minContentWidth?: number;
        onSidebarCollapsedChange?: (collapsed: boolean) => void;
        overlayContent?: string;
        overlayVisible?: boolean;
        sidebarCollapsed?: boolean;
        sidebarCollapseBelow?: number;
        sidebarContent?: string;
        sidebarWidth?: number;
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
    }

    Hierarchy (View Summary)

    Index

    Properties

    content? defaultSidebarCollapsed? footerContent? footerHeight? gap? headerContent? headerHeight? minContentWidth? onSidebarCollapsedChange? overlayContent? overlayVisible? sidebarCollapsed? sidebarCollapseBelow? sidebarContent? sidebarWidth? capabilities? backgroundTone? borderTone? foregroundTone? theme?

    Properties

    Optionalcontent

    content?: string

    Main content text managed by the adapter.

    defaultSidebarCollapsed?: boolean

    Initial sidebar collapsed state for uncontrolled usage.

    footerContent?: string

    Footer text managed by the adapter.

    footerHeight?: number

    Footer height in terminal rows.

    0 when footer is empty, otherwise 1

    gap?: number

    Empty rows or cells between adjacent regions.

    0

    headerContent?: string

    Header text managed by the adapter.

    headerHeight?: number

    Header height in terminal rows.

    1

    minContentWidth?: number

    Minimum useful content width before sidebar auto-collapse.

    1

    onSidebarCollapsedChange?: (collapsed: boolean) => void

    Called after imperative toggling requests sidebar collapsed state changes.

    overlayContent?: string

    Overlay text managed by the adapter.

    overlayVisible?: boolean

    Whether the overlay layer is visible.

    false

    sidebarCollapsed?: boolean

    Controlled sidebar collapsed state.

    sidebarCollapseBelow?: number

    Hide sidebar when total shell width is below this threshold.

    sidebarContent?: string

    Sidebar text managed by the adapter.

    sidebarWidth?: number

    Preferred sidebar width in terminal cells.

    24

    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.

    Settings

    Member Visibility

    On This Page

    Properties