Skip to content

useTable.md

Latest commit

 

History

History
64 lines (42 loc) · 1.23 KB

useTable.md

File metadata and controls

64 lines (42 loc) · 1.23 KB
id useTable
title useTable

Function: useTable()

function useTable<TFeatures, TData, TSelected>(tableOptions, selector?): PreactTable<TFeatures, TData, TSelected>;

Defined in: useTable.ts:113

Creates a Preact table instance backed by TanStack Store atoms.

The optional selector projects from table.store; the selected value is exposed on table.state and compared shallowly for Preact re-renders. Omit the selector to subscribe to every registered table state slice, or pass a narrower selector and use table.Subscribe lower in the tree for targeted subscriptions.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TSelected

TSelected = TableState<TFeatures>

Parameters

tableOptions

TableOptions<TFeatures, TData>

selector?

(state) => TSelected

Returns

PreactTable<TFeatures, TData, TSelected>

Example

const table = useTable(
  {
    _features,
    _rowModels: {},
    columns,
    data,
  },
  (state) => ({ pagination: state.pagination }),
)

table.state.pagination