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

    Interface DescriptionListData

    Stateful data accepted by the Blessed descriptionList adapter.

    interface DescriptionListData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        gap?: number;
        items: readonly DescriptionListItem[];
        layout?: DescriptionListLayout;
        rowGap?: number;
        termWidth?: number | "auto";
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? gap? items layout? rowGap? termWidth? width?

    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'

    theme?: Theme

    Semantic terminal theme.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    gap?: number

    Spaces between the term column and description in the columns layout.

    2

    items: readonly DescriptionListItem[]

    Ordered term and description entries.

    layout?: DescriptionListLayout

    Entry arrangement.

    auto uses columns when the available width can fit useful description text, and stacked rows otherwise.

    'auto'

    rowGap?: number

    Blank lines inserted between entries.

    0

    termWidth?: number | "auto"

    Width reserved for every term in terminal cells.

    auto uses the widest term. A numeric width truncates longer terms.

    'auto'

    width?: number

    Available content width in terminal cells. Enables responsive wrapping.

    Settings

    Member Visibility

    On This Page

    Properties