Table API Reference
- Table
- TableOptions
- TableState
- TableMeta
- TableFeature
- TableFeatures
- StockFeatures
- CoreFeatures
- BaseAtoms
- Atoms
- ExternalAtoms
- constructTable
- tableOptions
- tableFeatures
- getInitialTableState
- OnChangeFn
- Updater
- DebugOptions
- injectTable
- createTableHook
- AngularTable
- AppAngularTable
- CreateTableHookResult
- CreateTableContextOptions
- flexRenderComponent
- FlexRender
- TanStackTable
- injectTableContext
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
injectTable
function injectTable<TFeatures, TData>(optionsFactory): AngularTable<TFeatures, TData>;Defined in: packages/angular-table/src/injectTable.ts:90
Creates and returns an Angular-reactive table instance.
The initializer is intentionally re-evaluated whenever any signal read inside it changes. This is how the adapter keeps the table in sync with Angular's reactivity model.
Because of that behavior, keep expensive/static values (for example columns, feature setup, row models) as stable references outside the initializer, and only read reactive state (data(), pagination/filter/sorting signals, etc.) inside it.
The returned table is also signal-reactive: table state and table APIs are wired for Angular signals, so you can safely consume table methods inside computed(...) and effect(...).
Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Parameters#
optionsFactory#
() => TableOptions<TFeatures, TData>
Returns#
AngularTable<TFeatures, TData>
An Angular-reactive TanStack Table instance.
Example#
- Register the table features you need
// Register only the features you need
import {tableFeatures, rowPaginationFeature} from '@tanstack/angular-table';
const features = tableFeatures({
rowPaginationFeature,
// ...all other features you need
})
// Use all table core features
import {stockFeatures} from '@tanstack/angular-table';
const features = tableFeatures(stockFeatures);- Prepare the table columns
import {ColumnDef} from '@tanstack/angular-table';
type MyData = {}
const columns: ColumnDef<typeof features, MyData>[] = [
// ...column definitions
]
// or using createColumnHelper
import {createColumnHelper} from '@tanstack/angular-table';
const columnHelper = createColumnHelper<typeof features, MyData>();
const columns = columnHelper.columns([
columnHelper.accessor(...),
// ...other columns
])- Create the table instance with injectTable
const table = injectTable(() => {
// ...table options,
features,
columns: columns,
data: myDataSignal(),
})