Tanstack Solid Table Migrate V8 To V9

Read @tanstack/table-core#migrate-v8-to-v9, getting-started, and table-state. Use this as the exhaustive Solid migration checklist. Check the installed declarations before emitting APIs for a different v9 version.

Framework prerequisite: Solid 1.3 or newer (solid-js >=1.3).

Target architecture

import {
  createSortedRowModel,
  createTable,
  rowSortingFeature,
  tableFeatures,
} from '@tanstack/solid-table'

const features = tableFeatures({
  rowSortingFeature,
  sortedRowModel: createSortedRowModel(),
})

const table = createTable({
  features,
  columns,
  get data() {
    return data()
  },
})

Keep static features and columns outside reactive component work. Prefer explicit features as the end state; stockFeatures is a kitchen-sink migration shortcut.

Complete breaking-change map

Construction and feature registration

In the registry slots, register individually imported built-ins (filterFn_includesString, sortFn_alphanumeric, aggregationFn_sum, and so on) under their conventional keys alongside custom functions; the full filterFns/sortFns/aggregationFns registry objects still work but bundle every built-in.

Place each prerequisite feature before its row-model slot. Stock features are cellSelectionFeature, columnFilteringFeature, globalFilteringFeature, rowSortingFeature, rowPaginationFeature, rowSelectionFeature, rowExpandingFeature, rowPinningFeature, columnPinningFeature, columnVisibilityFeature, columnOrderingFeature, columnSizingFeature, columnResizingFeature, rowAggregationFeature, columnGroupingFeature, and columnFacetingFeature. Aggregation is independent from grouping: register rowAggregationFeature for aggregation APIs and add columnGroupingFeature only for grouped rows.

Solid state and reactivity

const [sorting, setSorting] = createSignal<SortingState>([])
const table = createTable({
  features,
  columns,
  get data() {
    return data()
  },
  state: {
    get sorting() {
      return sorting()
    },
  },
  onSortingChange: setSorting,
})

table.Subscribe passes atoms to its child. A Solid component child body is untracked, so read atoms inside JSX expressions or a thunk invoked by JSX:

<table.Subscribe>
  {(atoms) => <span>Page {atoms.pagination.get().pageIndex + 1}</span>}
</table.Subscribe>

Use createAtom/useSelector from @tanstack/solid-store for externally owned slices. An external atom wins over state for the same slice; do not combine ownership models accidentally.

Rendering and composition

• Replace flexRender(def, context) with <FlexRender header={header} /> or <table.FlexRender cell={cell} />.
• Use tableOptions() for typed reusable option fragments.
• Use createTableHook({ features, ...defaults }) for repeated conventions; it returns helpers such as createAppTable and createAppColumnHelper.
• Invoke row/cell/column/header methods through their instance. Prototype methods lose this when extracted and are absent from object spread, Object.keys, and JSON. Table-instance methods are not affected.

TypeScript and helper changes

Infer with typeof features; use StockFeatures only when deliberately typing stockFeatures.

Shared API and semantic changes

Logical pinning does not implement DOM direction styling; use logical CSS insets. columnResizeDirection is unchanged.

All other underscore-prefixed internals are removed. getIsSomeRowsSelected() and getIsSomePageRowsSelected() now mean at least one even when all are selected. Use getIsSomeRowsSelected() && !getIsAllRowsSelected() or getIsSomePageRowsSelected() && !getIsAllPageRowsSelected() for checkbox indeterminate state.

Migration procedure

1. Replace createSolidTable with createTable and inventory used features, processing, state, and APIs.
2. Build tableFeatures() in prerequisite order; remove getCoreRowModel and old row-model placement.
3. Apply all pinning, sizing, sorting, row, and selection mappings above.
4. Update helpers/types with typeof features; migrate meta and function augmentation to per-feature slots where appropriate.
5. Preserve Solid tracking with getters for data and controlled state; replace getState() and onStateChange.
6. Choose internal, controlled-signal, or external-atom ownership per slice.
7. Replace unbound row/cell/column/header methods and migrate rendering.
8. Add tableOptions, table.Subscribe, or createTableHook only where composition or fine-grained rendering calls for them.
9. Type-check and exercise every enabled client- and server-side flow.
10. Audit away stockFeatures when production tree-shaking matters.

Final migration checklist

• Replace createSolidTable with createTable and preserve reactive inputs through getters.
• Register every used stock feature explicitly and order prerequisites before slots.
• Remove getCoreRowModel; move all eight optional row models into tableFeatures.
• Move filterFns, sortFns, aggregationFns, and filterMeta into feature slots.
• Replace table.getState() and onStateChange with tracked atom/store reads, per-slice callbacks, subscriptions, or external atoms.
• Audit Solid tracking scopes, controlled getters, atom precedence, and reset ownership.
• Replace unbound/copied row, cell, column, and header methods.
• Apply the complete logical pinning map and CSS changes.
• Split pinning options and sizing/resizing; rename the resizing state, setter, and callback.
• Apply every sorting rename and remove each listed internal API.
• Pair some-selected with the matching all-selected predicate.
• Update TFeatures helpers/types, columns(), StockFeatures, meta/registry slots, and RowData.
• Migrate Solid FlexRender and use tableOptions/createTableHook only for repeated conventions.
• Type-check and exercise every enabled client/manual feature and LTR/RTL layout flow.
• Audit away temporary stockFeatures usage when explicit tree-shaking is intended.

Common migration failures

• Calling createTable({ data: data() }) and freezing the initial array instead of providing a getter.
• Leaving row models in table options or omitting their prerequisite feature.
• Reading atoms in an untracked component child body and expecting Solid updates.
• Supplying controlled state without getter properties or per-slice callbacks.
• Destructuring prototype-backed object methods.
• Updating pinning state names but not CSS and region APIs.
• Treating changed “some selected” semantics as checkbox indeterminate state.

API discovery

Inspect node_modules/@tanstack/solid-table/dist/index.d.ts and node_modules/@tanstack/table-core/dist/index.d.ts. Compare v8 names only against the migration guide, not current main-branch assumptions.