Interface: CreateTableHookResult<TFeatures, TTableComponents, TCellComponents, THeaderComponents>

Defined in: packages/vue-table/src/createTableHook.ts:226

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: packages/vue-table/src/createTableHook.ts:233

The features object that was passed to createTableHook.

createAppColumnHelper()

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

Defined in: packages/vue-table/src/createTableHook.ts:238

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>(tableOptions) => AppVueTable<TFeatures, TData, TTableComponents, TCellComponents, THeaderComponents>;

Defined in: packages/vue-table/src/createTableHook.ts:248

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

Parameters

tableOptions

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

Returns

AppVueTable<TFeatures, TData, TTableComponents, TCellComponents, THeaderComponents>

useCellContext()

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

Defined in: packages/vue-table/src/createTableHook.ts:276

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: packages/vue-table/src/createTableHook.ts:287

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>() => AppVueTable<TFeatures, TData, TTableComponents, TCellComponents, THeaderComponents>;

Defined in: packages/vue-table/src/createTableHook.ts:265

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.