Interface: TableOptions_Table<TFeatures, TData>#

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

Extended by#

• TableOptions_Core

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

atoms?#

readonly optional atoms: Partial<{ [K in string | number | symbol]: Atom<ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap>[K]> }>;

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

Optionally, provide your own external writable atoms for individual state slices. When an atom is provided for a given slice, it takes precedence over options.state[key] and the internal base atom for that slice. Feature state update APIs write through the corresponding atom updater, so external atoms are the preferred v9 ownership model for app-managed table state slices.

autoResetAll?#

readonly optional autoResetAll: boolean;

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

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

data#

readonly data: readonly TData[];

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

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

features#

readonly features: TFeatures & ValidateFeatureSlots<TFeatures>;

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

The feature modules registered on this table instance.

Feature registration controls which state slices, options, and prototype APIs are available. This object also carries the table's row model factories (sortedRowModel, filteredRowModel, etc.), row model function registries (sortFns, filterFns, aggregationFns), and type-only meta slots (tableMeta, columnMeta).

initialState?#

readonly optional initialState: Partial<ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap>>;

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

Optionally provide starting values for registered table state slices. Feature reset APIs use this value by default, and many reset APIs accept true to reset to that feature's blank/default state instead. Changing this object later does not reset table state, so it does not need to be stable.

key?#

readonly optional key: string;

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

Optional key used to identify this table instance.

This is used by TanStack Table Devtools to register and select tables. It is not required unless the table is passed to devtools.

mergeOptions()?#

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

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

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?#

readonly optional meta: ExtractTableMeta<TFeatures, TData>;

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

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

Declare its type per-table via the tableMeta type-only slot on the features option, or globally via declaration merging on TableMeta.

state?#

readonly optional state: Partial<ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap>>;

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

Optionally provide externally managed values for individual state slices.

Pair each slice with its matching on[State]Change callback so table state updates can be persisted outside the table. External atoms take precedence over this option when both are provided for the same slice.