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

    Interface RenderTableOptions<TRow>

    Options accepted by renderTable.

    interface RenderTableOptions<TRow extends TableRow = TableRow> {
        activeId?: string;
        columns: readonly TableColumn<TRow>[];
        characters?: TableCharacters;
        emptyText?: string;
        height: number;
        offset?: number;
        rows: readonly TRow[];
        selectedId?: string;
        width: number;
    }

    Type Parameters

    Index

    Properties

    activeId? columns characters? emptyText? height offset? rows selectedId? width

    Properties

    activeId?: string

    Identifier receiving the visible cursor marker.

    columns: readonly TableColumn<TRow>[]

    Ordered column definitions.

    characters?: TableCharacters

    Character tokens used to communicate structure and state.

    emptyText?: string

    Text returned when rows is empty.

    'No rows'

    height: number

    Maximum number of rendered terminal rows including header and separator.

    offset?: number

    First rendered body row index.

    0

    rows: readonly TRow[]

    Ordered table rows. Caller-owned data is never mutated.

    selectedId?: string

    Identifier receiving the selected marker.

    width: number

    Maximum terminal-cell width of each rendered line.

    Settings

    Member Visibility

    On This Page

    Properties