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

    Interface GridData

    Stateful layout and theme data accepted by grid.

    interface GridData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        columnGap?: number;
        columns: number;
        gap?: number;
        items?: readonly GridItemPlacement[];
        rowGap?: number;
        rows?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? columnGap? columns gap? items? rowGap? rows?

    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.

    columnGap?: number

    Empty cells between adjacent columns. Overrides gap horizontally.

    columns: number

    Number of columns in the grid.

    gap?: number

    Shared empty cells/rows between adjacent tracks.

    0

    items?: readonly GridItemPlacement[]

    Per-child placements in direct child order. Missing entries auto-place.

    rowGap?: number

    Empty rows between adjacent rows. Overrides gap vertically.

    rows?: number

    Number of rows in the grid. Inferred from items when omitted.

    Settings

    Member Visibility

    On This Page

    Properties