Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
- stockFeatures
- coreFeatures
- coreCellsFeature
- coreColumnsFeature
- coreHeadersFeature
- coreRowModelsFeature
- coreRowsFeature
- coreTablesFeature
- cellSpanningFeature
- columnFilteringFeature
- columnFacetingFeature
- rowAggregationFeature
- columnGroupingFeature
- columnOrderingFeature
- columnPinningFeature
- columnResizingFeature
- columnSizingFeature
- columnVisibilityFeature
- globalFilteringFeature
- rowExpandingFeature
- rowPaginationFeature
- rowPinningFeature
- rowSelectionFeature
- rowSortingFeature
- filterFns
- sortFns
- aggregationFns
- ColumnFilter
- ColumnPinningState
- ColumnSort
- PaginationState
- RowPinningState
- columnResizingState
- FilterFn
- FilterFns
- FilterMeta
- SortFn
- SortFns
- AggregationFns
- AggregationContext
- AggregationMergeContext
- AggregationFnDef
- AggregationFnDescriptor
- AggregationValueContext
- AggregationValueResult
- constructAggregationFn
- ColumnFiltersState
- ColumnOrderState
- ColumnPinningPosition
- ColumnResizeDirection
- ColumnResizeMode
- ColumnSizingState
- ColumnVisibilityState
- ExpandedState
- GroupingState
- RowPinningPosition
- RowSelectionState
- SortDirection
- SortingState
- AggregationFnOption
- AggregationResult
- FilterFnOption
- SortFnOption
- BuiltInAggregationFn
- BuiltInFilterFn
- BuiltInSortFn
Static Functions API Reference
Legacy API Reference
- Legacy API Overview
- useLegacyTable
- legacyCreateColumnHelper
- getCoreRowModel
- getFilteredRowModel
- getSortedRowModel
- getGroupedRowModel
- getExpandedRowModel
- getPaginationRowModel
- getFacetedRowModel
- getFacetedMinMaxValues
- getFacetedUniqueValues
- LegacyRowModelOptions
- LegacyTable
- LegacyTableOptions
- LegacyReactTable
- LegacyColumnDef
Table_Table
Defined in: core/table/coreTablesFeature.types.ts:250
Extends#
- Table_CoreProperties<TFeatures, TData>
Extended by#
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Properties#
_cellInstanceInitFns#
_cellInstanceInitFns: <TFeatures, TData, TValue>(cell) => void[];Defined in: core/table/coreTablesFeature.types.ts:167
Cache of the initCellInstanceData functions for features that define one.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
TValue#
TValue extends unknown = unknown
Parameters#
cell#
Cell<TFeatures, TData, TValue>
Returns#
void
Inherited from#
Table_CoreProperties._cellInstanceInitFns
_cellPrototype?#
optional _cellPrototype?: object;Defined in: core/table/coreTablesFeature.types.ts:171
Prototype cache for Cell objects - shared by all cells in this table
Inherited from#
Table_CoreProperties._cellPrototype
_columnInstanceInitFns#
_columnInstanceInitFns: <TFeatures, TData, TValue>(column) => void[];Defined in: core/table/coreTablesFeature.types.ts:175
Cache of the initColumnInstanceData functions for features that define one.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
TValue#
TValue extends unknown = unknown
Parameters#
column#
Column<TFeatures, TData, TValue>
Returns#
void
Inherited from#
Table_CoreProperties._columnInstanceInitFns
_columnPrototype?#
optional _columnPrototype?: object;Defined in: core/table/coreTablesFeature.types.ts:181
Prototype cache for Column objects - shared by all columns in this table
Inherited from#
Table_CoreProperties._columnPrototype
_features#
readonly _features: Partial<CoreFeatures> & TFeatures;Defined in: core/table/coreTablesFeature.types.ts:185
The features that are enabled for the table.
Inherited from#
Table_CoreProperties._features
_headerGroupInstanceInitFns#
_headerGroupInstanceInitFns: <TFeatures, TData>(headerGroup) => void[];Defined in: core/table/coreTablesFeature.types.ts:189
Cache of the initHeaderGroupInstanceData functions for features that define one.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Parameters#
headerGroup#
HeaderGroup<TFeatures, TData>
Returns#
void
Inherited from#
Table_CoreProperties._headerGroupInstanceInitFns
_headerInstanceInitFns#
_headerInstanceInitFns: <TFeatures, TData, TValue>(header) => void[];Defined in: core/table/coreTablesFeature.types.ts:195
Cache of the initHeaderInstanceData functions for features that define one.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
TValue#
TValue extends unknown = unknown
Parameters#
header#
Header<TFeatures, TData, TValue>
Returns#
void
Inherited from#
Table_CoreProperties._headerInstanceInitFns
_headerPrototype?#
optional _headerPrototype?: object;Defined in: core/table/coreTablesFeature.types.ts:201
Prototype cache for Header objects - shared by all headers in this table
Inherited from#
Table_CoreProperties._headerPrototype
_reactivity#
readonly _reactivity: TableReactivityBindings;Defined in: core/table/coreTablesFeature.types.ts:163
Table reactivity bindings for interacting with TanStack Store.
Inherited from#
Table_CoreProperties._reactivity
_rowInstanceInitFns#
_rowInstanceInitFns: <TFeatures, TData>(row) => void[];Defined in: core/table/coreTablesFeature.types.ts:217
Cache of the initRowInstanceData functions for features that define one.
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Parameters#
row#
Row<TFeatures, TData>
Returns#
void
Inherited from#
Table_CoreProperties._rowInstanceInitFns
_rowModelFns#
readonly _rowModelFns: RowModelFns<TFeatures, TData>;Defined in: core/table/coreTablesFeature.types.ts:205
The row model processing functions that are used to process the data by features.
Inherited from#
Table_CoreProperties._rowModelFns
_rowModels#
readonly _rowModels: CachedRowModels<TFeatures, TData>;Defined in: core/table/coreTablesFeature.types.ts:209
The row models that are enabled for the table.
Inherited from#
Table_CoreProperties._rowModels
_rowPrototype?#
optional _rowPrototype?: object;Defined in: core/table/coreTablesFeature.types.ts:213
Prototype cache for Row objects - shared by all rows in this table
Inherited from#
Table_CoreProperties._rowPrototype
atoms#
readonly atoms: Atoms<TFeatures>;Defined in: core/table/coreTablesFeature.types.ts:223
The readonly derived atoms for each TableState slice. Each derives from its corresponding baseAtom plus, optionally, a per-slice external atom or external state value (precedence: external atom > external state > base atom).
Inherited from#
baseAtoms#
readonly baseAtoms: BaseAtoms<TFeatures>;Defined in: core/table/coreTablesFeature.types.ts:228
The internal writable atoms for each TableState slice. This is the library's single write surface — all state mutations from features land here.
Inherited from#
Table_CoreProperties.baseAtoms
initialState#
readonly initialState: ExtractFeatureMapTypes<TFeatures>;Defined in: core/table/coreTablesFeature.types.ts:232
This is the resolved initial state of the table.
Inherited from#
Table_CoreProperties.initialState
options#
readonly options: TableOptions<TFeatures, TData>;Defined in: core/table/coreTablesFeature.types.ts:236
A read-only reference to the table's current options.
Inherited from#
optionsStore?#
readonly optional optionsStore?: Atom<TableOptions<TFeatures, TData>>;Defined in: core/table/coreTablesFeature.types.ts:242
Writable atom for table options. Only created when createOptionsStore is true on the active core reactivity bindings. Adapters that opt out keep options as plain resolved data instead of backing them with an atom.
Inherited from#
Table_CoreProperties.optionsStore
reset#
reset: () => void;Defined in: core/table/coreTablesFeature.types.ts:262
Resets the table's internal base atoms to table.initialState.
Prefer feature-specific reset APIs, such as resetPagination, when a state slice may be owned by an external atom or needs that feature's blank/default reset behavior. After resetting internal atoms, this also invokes feature reset hooks for mutable, transient table-instance data.
Returns#
void
setOptions#
setOptions: (newOptions) => void;Defined in: core/table/coreTablesFeature.types.ts:267
Updates the table options by applying a value or updater to the current resolved options and then merging them through options.mergeOptions.
Parameters#
newOptions#
Updater<TableOptions<TFeatures, TData>>
Returns#
void
store#
readonly store: ReadonlyStore<ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap>>;Defined in: core/table/coreTablesFeature.types.ts:247
The readonly flat store for the table state. Derives from table.atoms only; never reads external state directly.