0
Fork 0
mirror of https://github.com/TanStack/table.git synced 2026-11-18 18:55:54 +00:00
table/docs/framework/alpine/reference/functions/createTable.md
Kevin Van Cott e91608ea2f
feat: update column pinning terminology from left/right to start/end (#6398)
* feat: update column pinning terminology from left/right to start/end

* update beta number

* update variable names and clarify left to right associations
2026-07-10 08:01:09 -05:00

1.3 KiB

id title
createTable createTable

Function: createTable()

function createTable<TFeatures, TData>(tableOptions, selector?): AlpineTable<TFeatures, TData>;

Defined in: createTable.ts:46

Creates an Alpine-reactive table instance.

Reactivity is bridged through a single version counter that every proxied table read registers as a dependency, so by default ANY state change re-evaluates every Alpine binding that touches the table. Pass a selector to gate that: the counter then only bumps when the selected slice of state changes (shallow compare). Use () => ({}) to opt out of state-driven re-evaluation entirely and handle high-frequency state (e.g. column resizing) with explicit table.atoms.<slice>.subscribe() side effects. Options changes (e.g. new data) always re-evaluate.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

tableOptions

TableOptions<TFeatures, TData>

selector?

(state) => unknown

Returns

AlpineTable<TFeatures, TData>

Example

const table = createTable(options, (state) => ({ sorting: state.sorting }))