Interface: TableOptions_Table<TFeatures, TData>

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

Extended by

• TableOptions_Core

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_features

_features: TFeatures;

_features: TFeatures;

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

The features that you want to enable for the table.

_rowModels?

optional _rowModels: CreateRowModels_All<TFeatures, TData>;

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.

autoResetAll?

optional autoResetAll: boolean;

optional autoResetAll: boolean;

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

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

data

data: readonly TData[];

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.

initialState?

optional initialState: Partial<TableState<TFeatures>>;

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.

mergeOptions()?

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

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.

Parameters

defaultOptions

TableOptions<TFeatures, TData>

options

Partial<TableOptions<TFeatures, TData>>

Returns

TableOptions<TFeatures, TData>

meta?

optional meta: TableMeta<TFeatures, TData>;

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.

state?

optional state: Partial<TableState<TFeatures>>;

optional state: Partial<TableState<TFeatures>>;

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

Pass in individual self-managed state to the table.

store?

optional store: Store<TableState<TFeatures>>;

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.