Defined in: types/TableOptions.ts:27

• TableOptions_Table<TFeatures, TData>.TableOptions_Cell.TableOptions_Columns<TFeatures, TData>.TableOptions_Rows<TFeatures, TData>

TFeatures extends TableFeatures

TData extends RowData

_features: TFeatures;

Defined in: core/table/coreTablesFeature.types.ts:22

The features that you want to enable for the table.

TableOptions_Table._features

optional _rowModels: CreateRowModels_All<TFeatures, TData>;

Defined in: core/table/coreTablesFeature.types.ts:26

The row model options that you want to enable for the table.

TableOptions_Table._rowModels

optional autoResetAll: boolean;

Defined in: core/table/coreTablesFeature.types.ts:30

Set this option to override any of the autoReset... feature options.

TableOptions_Table.autoResetAll

columns: readonly ColumnDef<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:68

The array of column defs to use for the table.

TableOptions_Columns.columns

data: readonly TData[];

Defined in: core/table/coreTablesFeature.types.ts:34

The data for the table to display. When the data option changes reference, the table will reprocess the data.

TableOptions_Table.data

optional defaultColumn: Partial<ColumnDef<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:72

Default column options to use for all column defs supplied to the table.

TableOptions_Columns.defaultColumn

optional getRowId: (originalRow, index, parent?) => string;

Defined in: core/rows/coreRowsFeature.types.ts:90

This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with . using their grandparents' index eg. index.index.index). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc.

TData

number

Row<TFeatures, TData>

string

getRowId: row => row.userId

TableOptions_Rows.getRowId

optional getSubRows: (originalRow, index) => readonly TData[] | undefined;

Defined in: core/rows/coreRowsFeature.types.ts:99

This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row.

TData

number

readonly TData[] | undefined

getSubRows: row => row.subRows

TableOptions_Rows.getSubRows

optional initialState: Partial<TableState<TFeatures>>;

Defined in: core/table/coreTablesFeature.types.ts:39

Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. options.autoResetPageIndex) or via functions like table.resetRowSelection(). Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state. Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable.

TableOptions_Table.initialState

optional mergeOptions: (defaultOptions, options) => TableOptions<TFeatures, TData>;

Defined in: core/table/coreTablesFeature.types.ts:43

This option is used to optionally implement the merging of table options.

TableOptions<TFeatures, TData>

Partial<TableOptions<TFeatures, TData>>

TableOptions<TFeatures, TData>

TableOptions_Table.mergeOptions

optional meta: TableMeta<TFeatures, TData>;

Defined in: core/table/coreTablesFeature.types.ts:50

You can pass any object to options.meta and access it anywhere the table is available via table.options.meta.

TableOptions_Table.meta

optional renderFallbackValue: any;

Defined in: core/cells/coreCellsFeature.types.ts:67

Value used when the desired value is not found in the data.

TableOptions_Cell.renderFallbackValue

optional state: Partial<TableState<TFeatures>>;

Defined in: core/table/coreTablesFeature.types.ts:54

Pass in individual self-managed state to the table.

TableOptions_Table.state

optional store: Store<TableState<TFeatures>>;

Defined in: core/table/coreTablesFeature.types.ts:58

Optionally, provide your own external TanStack Store instance if you want to manage the table state externally.

TableOptions_Table.store