CreateTableHookResult

Defined in: src/createTableHook.tsx:298

Type Parameters

TFeatures

TFeatures extends TableFeatures

TTableComponents

TTableComponents extends Record<string, ComponentType<any>>

TCellComponents

TCellComponents extends Record<string, ComponentType<any>>

THeaderComponents

THeaderComponents extends Record<string, ComponentType<any>>

Properties

appFeatures

appFeatures: TFeatures;

Defined in: src/createTableHook.tsx:305

The features object that was passed to createTableHook.

createAppColumnHelper

createAppColumnHelper: <TData>() => AppColumnHelper<TFeatures, TData, TCellComponents, THeaderComponents>;

Defined in: src/createTableHook.tsx:310

A column helper pre-bound to TFeatures and the registered components, so the cell/header/footer render props expose the bound components.

Type Parameters

TData

TData extends RowData

Returns

AppColumnHelper<TFeatures, TData, TCellComponents, THeaderComponents>

useAppTable

useAppTable: <TData, TSelected>(tableOptions, selector?) => AppReactTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>;

Defined in: src/createTableHook.tsx:320

Creates a table with the App* wrapper components and registered tableComponents attached. TData is inferred from the data option.

Type Parameters

TData

TData extends RowData

TSelected

TSelected = TableState<TFeatures>

Parameters

tableOptions

Omit<TableOptions<TFeatures, TData>, "features">

selector?

(state) => TSelected

Returns

AppReactTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>

useCellContext

useCellContext: <TValue>() => Cell_Core<TFeatures, any, TValue> & ExtractFeatureMapTypes<TFeatures, Cell_FeatureMap> & TCellComponents & object;

Defined in: src/createTableHook.tsx:357

Reads the cell provided by the nearest <table.AppCell>, extended with your cellComponents and a context-bound FlexRender.

Type Parameters

TValue

TValue extends unknown = unknown

Returns

Cell_Core<TFeatures, any, TValue> & ExtractFeatureMapTypes<TFeatures, Cell_FeatureMap> & TCellComponents & object

useHeaderContext

useHeaderContext: <TValue>() => Header_Core<TFeatures, any, TValue> & ExtractFeatureMapTypes<TFeatures, Header_FeatureMap> & THeaderComponents & object;

Defined in: src/createTableHook.tsx:368

Reads the header provided by the nearest <table.AppHeader> / <table.AppFooter>, extended with your headerComponents and a context-bound FlexRender.

Type Parameters

TValue

TValue extends unknown = unknown

Returns

Header_Core<TFeatures, any, TValue> & ExtractFeatureMapTypes<TFeatures, Header_FeatureMap> & THeaderComponents & object

useTableContext

useTableContext: <TData, TSelected>() => AppReactTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>;

Defined in: src/createTableHook.tsx:342

Reads the table provided by the nearest <table.AppTable>. This is the same extended instance useAppTable returns, so the App* components and your tableComponents are available on it.

Pass TSelected to match the selector you gave useAppTable, so table.state is typed as the selected slice. It cannot be inferred automatically (React context does not carry the provider's generics), so it defaults to the full table state, which is correct for the common case of useAppTable without a selector.

Type Parameters

TData

TData extends RowData = RowData

TSelected

TSelected = TableState<TFeatures>

Returns

AppReactTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>