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

    Interface AccordionData

    Stateful data accepted by the Blessed accordion adapter.

    interface AccordionData {
        allowMultiple?: boolean;
        characters?: CollapsibleCharacters;
        defaultExpandedIds?: readonly string[];
        expandedIds?: readonly string[];
        gap?: number;
        onExpandedIdsChange?: (expandedIds: string[]) => void;
        sectionGap?: number;
        sections: readonly AccordionDataSection[];
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowMultiple? characters? defaultExpandedIds? expandedIds? gap? onExpandedIdsChange? sectionGap? sections capabilities? backgroundTone? borderTone? foregroundTone? theme?

    Properties

    allowMultiple?: boolean

    Whether more than one section may be expanded.

    false

    characters?: CollapsibleCharacters

    Character tokens used by each section header.

    defaultExpandedIds?: readonly string[]

    Initial expanded section identifiers for uncontrolled usage.

    expandedIds?: readonly string[]

    Controlled expanded section identifiers.

    gap?: number

    Empty rows between each header and body while expanded.

    0

    onExpandedIdsChange?: (expandedIds: string[]) => void

    Called after keyboard, mouse, or imperative toggling requests expansion changes.

    sectionGap?: number

    Empty rows between adjacent sections.

    0

    sections: readonly AccordionDataSection[]

    Ordered Accordion sections.

    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