Legacy API Reference

useLegacyTable

Function: useLegacyTable()

ts
function useLegacyTable<TData>(options): LegacyReactTable<TData>;

Defined in: useLegacyTable.ts:391

Type Parameters

TData

TData extends RowData

Parameters

options

LegacyTableOptions<TData>

Legacy v8-style table options

Returns

LegacyReactTable<TData>

A table instance with the full state subscribed and a getState() method

Deprecated

This hook is provided as a compatibility layer for migrating from TanStack Table v8.

Use the new useTable hook instead with an explicit features option:

tsx
// New v9 API
const features = tableFeatures({
  columnFilteringFeature,
  rowSortingFeature,
  rowPaginationFeature,
  filteredRowModel: createFilteredRowModel(),
  sortedRowModel: createSortedRowModel(),
  paginatedRowModel: createPaginatedRowModel(),
  filterFns,
  sortFns,
})

const table = useTable({
  features,
  columns,
  data,
})

Key differences from v8:

  • Features are tree-shakeable - only import what you use
  • Row models and fn registries are explicitly passed on the features option
  • Use table.Subscribe for fine-grained re-renders
  • State is accessed via table.state after selecting with the 2nd argument