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

    Interface TableData<TRow>

    Stateful data accepted by the Blessed table adapter.

    interface TableData<TRow extends TableRow = TableRow> {
        activeId?: string;
        columns: readonly TableColumn<TRow>[];
        characters?: TableCharacters;
        defaultValue?: string;
        emptyText?: string;
        onActiveIdChange?: (activeId: string) => void;
        onValueChange?: (value: string) => void;
        rows: readonly TRow[];
        value?: string;
    }

    Type Parameters

    Index

    Properties

    activeId? columns characters? defaultValue? emptyText? onActiveIdChange? onValueChange? rows value?

    Properties

    activeId?: string

    Preferred initial cursor identifier.

    columns: readonly TableColumn<TRow>[]

    Ordered column definitions.

    characters?: TableCharacters

    Character tokens used by the pure renderer.

    defaultValue?: string

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

    emptyText?: string

    Text displayed when no rows exist.

    onActiveIdChange?: (activeId: string) => void

    Called after the cursor moves to a different enabled row.

    onValueChange?: (value: string) => void

    Called when Enter or TableHandle.selectActive requests selection.

    rows: readonly TRow[]

    Ordered rows. Disabled rows are visible but not interactive.

    value?: string

    Controlled selected identifier.

    Settings

    Member Visibility

    On This Page

    Properties