TanStack
Column API Reference

AppColumnHelper

Type Alias: AppColumnHelper<TFeatures, TData, TCellComponents, THeaderComponents>

ts
type AppColumnHelper<TFeatures, TData, TCellComponents, THeaderComponents> = object;

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TCellComponents

TCellComponents extends Record<string, ComponentType<any>>

THeaderComponents

THeaderComponents extends Record<string, ComponentType<any>>

Properties

accessor()

ts
accessor: <TAccessor, TValue>(accessor, column) => TAccessor extends AccessorFn<TData> ? AccessorFnColumnDef<TFeatures, TData, TValue> : AccessorKeyColumnDef<TFeatures, TData, TValue>;

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

Type Parameters

TAccessor

TAccessor extends AccessorFn<TData> | DeepKeys<TData>

TValue

TValue extends TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never

Parameters

accessor

TAccessor

column

TAccessor extends AccessorFn<TData> ? AppColumnDefBase<TFeatures, TData, TValue, TCellComponents, THeaderComponents> & object : AppColumnDefBase<TFeatures, TData, TValue, TCellComponents, THeaderComponents>

Returns

TAccessor extends AccessorFn<TData> ? AccessorFnColumnDef<TFeatures, TData, TValue> : AccessorKeyColumnDef<TFeatures, TData, TValue>


columns()

ts
columns: <TColumns>(columns) => ColumnDef<TFeatures, TData, any>[] & [...TColumns];

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

Type Parameters

TColumns

TColumns extends ReadonlyArray<ColumnDef<TFeatures, TData, any>>

Parameters

columns

[...TColumns]

Returns

ColumnDef<TFeatures, TData, any>[] & [...TColumns]


display()

ts
display: (column) => DisplayColumnDef<TFeatures, TData, unknown>;

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

Parameters

column

AppDisplayColumnDef<TFeatures, TData, TCellComponents, THeaderComponents>

Returns

DisplayColumnDef<TFeatures, TData, unknown>


group()

ts
group: (column) => GroupColumnDef<TFeatures, TData, unknown>;

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

Parameters

column

AppGroupColumnDef<TFeatures, TData, TCellComponents, THeaderComponents>

Returns

GroupColumnDef<TFeatures, TData, unknown>