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

    Interface SidebarLayoutData

    Stateful data accepted by the Blessed sidebarLayout adapter.

    interface SidebarLayoutData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        collapsed?: boolean;
        collapseBelow?: number;
        defaultCollapsed?: boolean;
        gap?: number;
        mainContent?: string;
        minMainWidth?: number;
        onCollapsedChange?: (collapsed: boolean) => void;
        sidebarContent?: string;
        sidebarWidth?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? collapsed? collapseBelow? defaultCollapsed? gap? mainContent? minMainWidth? onCollapsedChange? sidebarContent? sidebarWidth?

    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.

    collapsed?: boolean

    Controlled collapsed state.

    collapseBelow?: number

    Hide sidebar when total width is below this threshold.

    defaultCollapsed?: boolean

    Initial collapsed state for uncontrolled usage.

    gap?: number

    Empty cells between sidebar and main while sidebar is visible.

    0

    mainContent?: string

    Main content text managed by the adapter.

    minMainWidth?: number

    Minimum useful main width before automatic collapse.

    1

    onCollapsedChange?: (collapsed: boolean) => void

    Called after imperative toggling requests collapsed state changes.

    sidebarContent?: string

    Sidebar content text managed by the adapter.

    sidebarWidth?: number

    Preferred sidebar width in terminal cells.

    24

    Settings

    Member Visibility

    On This Page

    Properties