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

    Interface RenderDataTableOptions<TRow>

    Options accepted by renderDataTable.

    interface RenderDataTableOptions<TRow extends TableRow = TableRow> {
        characters?: DataTableCharacters;
        columns: readonly DataTableColumn<TRow>[];
        hiddenColumnIds?: readonly string[];
        page?: number;
        pageSize?: number;
        query?: string;
        sort?: DataTableSort;
        activeId?: string;
        emptyText?: string;
        height: number;
        offset?: number;
        rows: readonly TRow[];
        selectedId?: string;
        width: number;
    }

    Type Parameters

    Hierarchy

    Index

    Properties

    characters? columns hiddenColumnIds? page? pageSize? query? sort? activeId? emptyText? height offset? rows selectedId? width

    Properties

    characters?: DataTableCharacters

    Character tokens used by the pure renderer.

    columns: readonly DataTableColumn<TRow>[]

    Ordered column definitions.

    hiddenColumnIds?: readonly string[]

    Column identifiers excluded from rendering, filtering, and sorting.

    Optionalpage

    page?: number

    Requested 1-based page index. Ignored when pageSize is omitted.

    1

    pageSize?: number

    Rows per page. Pagination is disabled when omitted.

    query?: string

    Case-insensitive search text matched against filterable columns.

    sort?: DataTableSort

    Active sort applied before pagination.

    activeId?: string

    Identifier receiving the visible cursor marker.

    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