Type Alias: PreactTable<TFeatures, TData, TSelected>#

type PreactTable<TFeatures, TData, TSelected> = Omit<Table<TFeatures, TData>, "store"> & object;

Defined in: useTable.ts:27

Type Declaration#

FlexRender()#

FlexRender: <TValue>(props) => ComponentChildren;

A Preact component that renders headers, cells, or footers with custom markup. Use this utility component instead of manually calling flexRender.

Type Parameters#

TValue#

TValue extends CellData = CellData

Parameters#

props#

FlexRenderProps<TFeatures, TData, TValue>

Returns#

ComponentChildren

state#

readonly state: Readonly<TSelected>;

The selected state of the table. This state may not match the structure of the full table state because it is selected by the selector function that you pass as the 2nd argument to useTable.

store#

readonly store: Table<TFeatures, TData>["store"];

Deprecated#

Prefer table.state for render reads, table.atoms.<slice>.get() for slice snapshots, or table.Subscribe / useSelector(table.store, selector) for explicit subscriptions. table.store.state is a current-value snapshot and is easy to misuse in render code.

Subscribe()#

Subscribe: {
<TSourceValue>  (props): ComponentChildren;
<TSourceValue, TSubSelected>  (props): ComponentChildren;
<TSubSelected>  (props): ComponentChildren;
};

Overloads (source first, then store) so JSX contextual typing works for both modes. Source without selector is separate so children infer TSourceValue (identity projection).

Call Signature#

<TSourceValue>(props): ComponentChildren;

Type Parameters#

TSourceValue#

TSourceValue

Parameters#

props#

children#

(state) => ComponentChildren | ComponentChildren

selector?#

undefined

source#

SubscribeSource<TSourceValue>

Returns#

ComponentChildren

Call Signature#

<TSourceValue, TSubSelected>(props): ComponentChildren;

Type Parameters#

TSourceValue#

TSourceValue

TSubSelected#

TSubSelected

Parameters#

props#

children#

(state) => ComponentChildren | ComponentChildren

selector#

(state) => TSubSelected

source#

SubscribeSource<TSourceValue>

Returns#

ComponentChildren

Call Signature#

<TSubSelected>(props): ComponentChildren;

Type Parameters#

TSubSelected#

TSubSelected

Parameters#

props#

Omit<SubscribePropsWithStore<TFeatures, TSubSelected>, "source">

Returns#

ComponentChildren

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TSelected#

TSelected = TableState<TFeatures>