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

Defined in: packages/lit-table/src/createTableHook.ts:358

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/lit-table/src/createTableHook.ts:365

The features object that was passed to createTableHook.

createAppColumnHelper()#

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

Defined in: packages/lit-table/src/createTableHook.ts:370

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>(host, tableOptions, selector?) => object;

Defined in: packages/lit-table/src/createTableHook.ts:381

Creates a controller-like object whose table() method returns a table with the App* wrapper functions, a bound FlexRender, and the registered tableComponents attached. TData is inferred from the data option.

Type Parameters#

TData#

TData extends RowData

TSelected#

TSelected = TableState<TFeatures>

Parameters#

host#

ReactiveControllerHost & HTMLElement

tableOptions#

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

selector?#

(state) => TSelected

Returns#

object

table()#

table: () => AppLitTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>;

Returns#

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

useCellContext()#

useCellContext: <TValue>(host) => ContextConsumer<Context<symbol, Cell<TFeatures, any, TValue>>, ReactiveControllerHost & HTMLElement>;

Defined in: packages/lit-table/src/createTableHook.ts:410

Reads the cell instance from a @lit/context ContextConsumer. lit never provides an extended cell through context, so this is a BARE Cell.

Type Parameters#

TValue#

TValue extends unknown = unknown

Parameters#

host#

ReactiveControllerHost & HTMLElement

Returns#

ContextConsumer<Context<symbol, Cell<TFeatures, any, TValue>>, ReactiveControllerHost & HTMLElement>

useHeaderContext()#

useHeaderContext: <TValue>(host) => ContextConsumer<Context<symbol, Header<TFeatures, any, TValue>>, ReactiveControllerHost & HTMLElement>;

Defined in: packages/lit-table/src/createTableHook.ts:420

Reads the header instance from a @lit/context ContextConsumer. lit never provides an extended header through context, so this is a BARE Header.

Type Parameters#

TValue#

TValue extends unknown = unknown

Parameters#

host#

ReactiveControllerHost & HTMLElement

Returns#

ContextConsumer<Context<symbol, Header<TFeatures, any, TValue>>, ReactiveControllerHost & HTMLElement>

useTableContext()#

useTableContext: <TData>(host) => ContextConsumer<Context<symbol, LitTable<TFeatures, TData, any>>, ReactiveControllerHost & HTMLElement>;

Defined in: packages/lit-table/src/createTableHook.ts:400

Reads the table provided by the nearest ancestor that called useAppTable, via a @lit/context ContextConsumer. This is the BARE LitTable written to the provider, not the extended AppLitTable.

Type Parameters#

TData#

TData extends RowData = RowData

Parameters#

host#

ReactiveControllerHost & HTMLElement

Returns#

ContextConsumer<Context<symbol, LitTable<TFeatures, TData, any>>, ReactiveControllerHost & HTMLElement>