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

    Interface CollapsibleData

    Stateful data accepted by the Blessed collapsible adapter.

    interface CollapsibleData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        bodyHeight?: number;
        characters?: CollapsibleCharacters;
        content?: string;
        defaultExpanded?: boolean;
        disabled?: boolean;
        expanded?: boolean;
        gap?: number;
        headerTone?: keyof ThemeColors;
        onExpandedChange?: (expanded: boolean) => void;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? bodyHeight? characters? content? defaultExpanded? disabled? expanded? gap? headerTone? onExpandedChange? title

    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.

    bodyHeight?: number

    Body height while expanded.

    remaining root height
    characters?: CollapsibleCharacters

    Character tokens used by the header renderer.

    Optionalcontent

    content?: string

    Plain text body content managed by the adapter.

    defaultExpanded?: boolean

    Initial expanded state for uncontrolled usage.

    disabled?: boolean

    Whether focus and toggling are unavailable.

    expanded?: boolean

    Controlled expanded state.

    gap?: number

    Empty rows between header and body while expanded.

    0

    headerTone?: keyof ThemeColors

    Semantic header foreground token.

    onExpandedChange?: (expanded: boolean) => void

    Called after keyboard, mouse, or imperative toggling requests a state change.

    title: string

    Non-empty, single-line title rendered in the header.

    Settings

    Member Visibility

    On This Page

    Properties