Type Alias: AppLitTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents>#

type AppLitTable<TFeatures, TData, TSelected, TTableComponents, TCellComponents, THeaderComponents> = LitTable<TFeatures, TData, TSelected> & NoInfer<TTableComponents> & object;

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

Extended table API returned by useAppTable with all App wrapper functions

Type Declaration#

AppCell()#

AppCell: <TValue>(cell, renderFn) => LitRenderable;

Wraps a cell and provides cell context with pre-bound cellComponents.

Type Parameters#

TValue#

TValue extends CellData = CellData

Parameters#

cell#

Cell<TFeatures, TData, TValue>

renderFn#

(cell) => LitRenderable

Returns#

LitRenderable

Example#

${table.AppCell(cell, (c) => html`<td>${c.FlexRender()}</td>`)}

AppFooter()#

AppFooter: <TValue>(header, renderFn) => LitRenderable;

Wraps a footer and provides header context with pre-bound headerComponents.

Type Parameters#

TValue#

TValue extends CellData = CellData

Parameters#

header#

Header<TFeatures, TData, TValue>

renderFn#

(header) => LitRenderable

Returns#

LitRenderable

Example#

${table.AppFooter(footer, (f) => html`<td>${f.FlexRender()}</td>`)}

AppHeader()#

AppHeader: <TValue>(header, renderFn) => LitRenderable;

Wraps a header and provides header context with pre-bound headerComponents.

Type Parameters#

TValue#

TValue extends CellData = CellData

Parameters#

header#

Header<TFeatures, TData, TValue>

renderFn#

(header) => LitRenderable

Returns#

LitRenderable

Example#

${table.AppHeader(header, (h) => html`<th>${h.FlexRender()}</th>`)}

FlexRender#

FlexRender: typeof FlexRender;

Convenience FlexRender function attached to the table instance. Renders cell, header, or footer content from column definitions.

Example#

${table.FlexRender({ header })}
${table.FlexRender({ cell })}
${table.FlexRender({ footer: header })}

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TSelected#

TSelected

TTableComponents#

TTableComponents extends Record<string, ComponentType<any>>

TCellComponents#

TCellComponents extends Record<string, ComponentType<any>>

THeaderComponents#

THeaderComponents extends Record<string, ComponentType<any>>