Skip to main content

Menu

Home
Frameworks
GitHub(opens in a new tab)

Getting Started

Overview
Installation
Devtools
Agent Skills (TanStack Intent)
Quick Start
Migrating to V9
useLegacyTable Guide

Core Guides

Features
Data
Client-Side vs Server-Side
Column Definitions
Table Instance
Row Models
Worker Row Models (Experimental)
Rows
Cells
Header Groups
Headers
Columns
Table and Column Meta
Type Helpers
Table State
React Compiler
Composable Tables (createTableHook)
Table Context
FlexRender
Custom Plugins

Feature Guides

Cell Selection
Cell Spanning
Column Ordering
Column Pinning
Column Sizing
Column Resizing
Column Visibility
Column Filtering
Global Filtering
Fuzzy Filtering
Faceting
Aggregation
Grouping
Expanding
Pagination
Row Pinning
Row Selection
Sorting
Virtualization

API Reference

Core API Reference
React API Reference

Table
TableOptions
TableState
TableMeta
TableFeature
TableFeatures
StockFeatures
CoreFeatures
BaseAtoms
Atoms
ExternalAtoms
constructTable
tableOptions
tableFeatures
getInitialTableState
OnChangeFn
Updater
DebugOptions
useTable
createTableHook
ReactTable
AppReactTable
CreateTableHookOptions
Subscribe
FlexRender
flexRender

Column
ColumnDef
ColumnDefBase
AccessorColumnDef
DisplayColumnDef
GroupColumnDef
ColumnDefTemplate
ColumnHelper
ColumnMeta
createColumnHelper
constructColumn
AccessorFn
DeepKeys
DeepValue
AppColumnHelper

Row
RowData
RowModel
constructRow
createCoreRowModel
createFilteredRowModel
createSortedRowModel
createGroupedRowModel
createExpandedRowModel
createPaginatedRowModel
createFacetedRowModel
createFacetedMinMaxValues
createFacetedUniqueValues
expandRows
RowModelFns
CachedRowModels

Cell
CellContext
CellData
constructCell
AppCellContext

Header
HeaderGroup
HeaderContext
constructHeader
buildHeaderGroups
AppHeaderContext

Static Functions Overview

Legacy API Overview
useLegacyTable
legacyCreateColumnHelper
getCoreRowModel
getFilteredRowModel
getSortedRowModel
getGroupedRowModel
getExpandedRowModel
getPaginationRowModel
getFacetedRowModel
getFacetedMinMaxValues
getFacetedUniqueValues
LegacyRowModelOptions
LegacyTable
LegacyTableOptions
LegacyReactTable
LegacyColumnDef

Basic Examples

Basic (useTable)
Basic (useAppTable)
Basic (useLegacyTable)
Basic (External State)
Basic (External Atoms)
Basic (Subscribe)
Basic (Dynamic Columns)
Header Groups

Feature Examples

Kitchen Sink (All Features)
Cell Selection
Cell Spanning
Column Filters
Column Filters (Faceted)
Bucketed Faceted Filters
Fuzzy Search Filters
Column Ordering
Column Ordering (DnD)
Column Pinning
Column Pinning (Split)
Sticky Column Pinning
Column Sizing
Column Resizing
Performant Column Resizing
Column Visibility
Expanding
Expanding Sub Components
Grouping
Aggregation
Grouped Aggregation
Pagination
Row DnD
Row Pinning
Row Selection
Sorting

Specialized Examples

Composable Tables (createTableHook)
Custom Plugin
Experimental Web Workers Plugin
Experimental Spreadsheet
With TanStack Virtual - Columns
With TanStack Virtual - Columns (Exp)
With TanStack Virtual - Rows
With TanStack Virtual - Rows (Exp)
With TanStack Virtual - Infinite Scrolling
With TanStack Form
With TanStack Query
With TanStack Router

Component Library Examples

Basic - Shadcn (Base UI)
Basic - Shadcn (Radix)
Basic - React Aria
Basic - Hero UI
Basic - Material UI
Basic - Mantine
Basic - Chakra UI
Kitchen Sink - Shadcn (Base UI)
Kitchen Sink - Shadcn (Radix)
Kitchen Sink - React Aria
Kitchen Sink - Hero UI
Kitchen Sink - Material UI
Kitchen Sink - Mantine
Kitchen Sink - Chakra UI
Material React Table
Mantine React Table

APIObject

type APIObject<TDeps, TDepArgs> = Record<string, API<TDeps, TDepArgs>>;

Defined in: utils.ts:513

Type Parameters

TDeps

TDeps extends ReadonlyArray<any>

TDepArgs

TDepArgs

Adapted from tanstack.com/table/v9/docs/reference/index/type-aliases/APIObject by Tanner Linsley, licensed under MIT. Changes were made: this page is re-rendered from the original's source.

Translation © 2026 fanyi.dev · Original © 2026 Tanner Linsley (MIT)

Wide content