Table Docs
API Reference
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
AI/LLM: This documentation page is available in plain markdown format at/table/latest/docs/framework/angular/reference/classes/TanStackTable.md
Table API Reference
TanStackTable
Defined in: packages/angular-table/src/helpers/table.ts:59
Provides a TanStack Table instance (AngularTable) in Angular DI.
The table can be injected by:
- any descendant of an element using [tanStackTable]="..."
- any component instantiated by *flexRender when the render props contains table
Example#
html
<div [tanStackTable]="table">
<app-pagination />
</div>ts
@Component({
selector: 'app-pagination',
template: `
<button (click)="prev()" [disabled]="!table().getCanPreviousPage()">Prev</button>
<button (click)="next()" [disabled]="!table().getCanNextPage()">Next</button>
`,
})
export class PaginationComponent {
readonly table = injectTableContext()
prev() {
this.table().previousPage()
}
next() {
this.table().nextPage()
}
}Type Parameters#
TFeatures#
TFeatures extends TableFeatures
TData#
TData extends RowData
Constructors#
Constructor#
ts
new TanStackTable<TFeatures, TData>(): TanStackTable<TFeatures, TData>;Returns#
TanStackTable<TFeatures, TData>
Properties#
table#
ts
readonly table: InputSignal<AngularTable<TFeatures, TData>>;Defined in: packages/angular-table/src/helpers/table.ts:68
The current TanStack Table instance.
Provided as a required signal input so DI consumers always read the latest value.