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

    Interface DataTableData<TRow>

    Stateful data accepted by the Blessed dataTable adapter.

    interface DataTableData<TRow extends TableRow = TableRow> {
        activeId?: string;
        characters?: DataTableCharacters;
        columns: readonly DataTableColumn<TRow>[];
        defaultHiddenColumnIds?: readonly string[];
        defaultPage?: number;
        defaultQuery?: string;
        defaultSort?: DataTableSort;
        defaultValue?: string;
        emptyText?: string;
        pageSize?: number;
        rows: readonly TRow[];
        onActiveIdChange?: (activeId: string) => void;
        onHiddenColumnIdsChange?: (hiddenColumnIds: readonly string[]) => void;
        onPageChange?: (page: number) => void;
        onQueryChange?: (query: string) => void;
        onSortChange?: (sort: DataTableSort | undefined) => void;
        onValueChange?: (value: string) => void;
        value?: string;
    }

    Type Parameters

    Index

    Properties

    activeId? characters? columns defaultHiddenColumnIds? defaultPage? defaultQuery? defaultSort? defaultValue? emptyText? pageSize? rows onActiveIdChange? onHiddenColumnIdsChange? onPageChange? onQueryChange? onSortChange? onValueChange? value?

    Properties

    activeId?: string

    Preferred initial cursor identifier.

    characters?: DataTableCharacters

    Character tokens used by the pure renderer.

    columns: readonly DataTableColumn<TRow>[]

    Ordered column definitions.

    defaultHiddenColumnIds?: readonly string[]

    Initial hidden column identifiers.

    []

    defaultPage?: number

    Initial 1-based page. Ignored when pageSize is omitted.

    1

    defaultQuery?: string

    Initial search text.

    defaultSort?: DataTableSort

    Initial sort.

    defaultValue?: string

    Initial selection for uncontrolled usage. Ignored when value is supplied.

    emptyText?: string

    Text displayed when no rows match.

    pageSize?: number

    Rows per page. Pagination is disabled when omitted.

    rows: readonly TRow[]

    Ordered rows. Caller-owned data is never mutated.

    onActiveIdChange?: (activeId: string) => void

    Called after the cursor moves to a different enabled row.

    onHiddenColumnIdsChange?: (hiddenColumnIds: readonly string[]) => void

    Called after hidden column identifiers change.

    onPageChange?: (page: number) => void

    Called after the current page changes.

    onQueryChange?: (query: string) => void

    Called after the search text changes.

    onSortChange?: (sort: DataTableSort | undefined) => void

    Called after the active sort changes.

    onValueChange?: (value: string) => void

    Called when Enter or DataTableHandle.selectActive requests selection.

    value?: string

    Controlled selected identifier.

    Settings

    Member Visibility

    On This Page

    Properties