@tanstack/table-core 9.0.0-alpha.8 → 9.0.0-beta.1

package/src/static-functions.ts

@@ -0,0 +1,31 @@
+/**
+ * Static utility functions sub-entry.
+ *
+ * Re-exports all standalone utility functions from each feature's `.utils.ts`
+ * module so consumers that want the functions (without constructing a table)
+ * can grab them from a single path.
+ */
+
+// Core
+export * from './core/cells/coreCellsFeature.utils'
+export * from './core/columns/coreColumnsFeature.utils'
+export * from './core/headers/coreHeadersFeature.utils'
+export * from './core/rows/coreRowsFeature.utils'
+export * from './core/row-models/coreRowModelsFeature.utils'
+export * from './core/table/coreTablesFeature.utils'
+
+// Features
+export * from './features/column-faceting/columnFacetingFeature.utils'
+export * from './features/column-filtering/columnFilteringFeature.utils'
+export * from './features/column-grouping/columnGroupingFeature.utils'
+export * from './features/column-ordering/columnOrderingFeature.utils'
+export * from './features/column-pinning/columnPinningFeature.utils'
+export * from './features/column-resizing/columnResizingFeature.utils'
+export * from './features/column-sizing/columnSizingFeature.utils'
+export * from './features/column-visibility/columnVisibilityFeature.utils'
+export * from './features/global-filtering/globalFilteringFeature.utils'
+export * from './features/row-expanding/rowExpandingFeature.utils'
+export * from './features/row-pagination/rowPaginationFeature.utils'
+export * from './features/row-pinning/rowPinningFeature.utils'
+export * from './features/row-selection/rowSelectionFeature.utils'
+export * from './features/row-sorting/rowSortingFeature.utils'

package/src/store-reactivity-bindings.ts

@@ -0,0 +1,47 @@
+import { batch, createAtom } from '@tanstack/store'
+import type { TableReactivityBindings } from './core/reactivity/coreReactivityFeature.types'
+
+/**
+ * TanStack Store–based reactivity for vanilla / non-framework use of `constructTable`,
+ * with `createOptionsStore: true` so `table.optionsStore` is available for subscriptions.
+ *
+ * @example
+ * ```ts
+ * import { constructTable, tableFeatures } from '@tanstack/table-core'
+ * import { storeReactivityBindings } from '@tanstack/table-core/store-reactivity-bindings'
+ *
+ * const table = constructTable({
+ *   features: tableFeatures({ coreReativityFeature: storeReactivityBindings() }),
+ *   // ...
+ * })
+ * ```
+ */
+export function storeReactivityBindings(): TableReactivityBindings {
+  return {
+    createOptionsStore: true,
+    wrapExternalAtoms: false,
+    addSubscription: () => {
+      throw new Error(
+        'Feature not supported in current reactivity implementation',
+      )
+    },
+    unmount: () => {
+      throw new Error(
+        'Feature not supported in current reactivity implementation',
+      )
+    },
+    batch,
+    schedule: (fn) => queueMicrotask(fn),
+    untrack: (fn) => fn(),
+    createReadonlyAtom: (fn, options) => {
+      return createAtom(() => fn(), {
+        compare: options?.compare,
+      })
+    },
+    createWritableAtom: (value, options) => {
+      return createAtom(value, {
+        compare: options?.compare,
+      })
+    },
+  }
+}

package/src/types/Cell.ts

@@ -0,0 +1,41 @@
+import type { Cell_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { CellData, RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { Cell_Cell } from '../core/cells/coreCellsFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface Cell_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+export interface Cell_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> extends Cell_Cell<TFeatures, TData, TValue> {}
+
+export type Cell<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = Cell_Cell<TFeatures, TData, TValue> &
+  UnionToIntersection<
+    'columnGroupingFeature' extends keyof TFeatures
+      ? Cell_ColumnGrouping
+      : never
+  > &
+  ExtractFeatureTypes<'Cell', TFeatures> &
+  Cell_Plugins<TFeatures, TData, TValue>
+
+// export type Cell<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+//   TValue extends CellData = CellData,
+// > = Cell_Core<TFeatures, TData, TValue> &
+//   ExtractFeatureTypes<TFeatures, 'Cell'> &
+//   Cell_Plugins<TFeatures, TData, TValue>

package/src/types/Column.ts

@@ -0,0 +1,86 @@
+import type { Column_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
+import type { Column_ColumnFaceting } from '../features/column-faceting/columnFacetingFeature.types'
+import type { Column_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { Column_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { Column_ColumnOrdering } from '../features/column-ordering/columnOrderingFeature.types'
+import type { Column_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
+import type { Column_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
+import type { Column_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
+import type { Column_ColumnSizing } from '../features/column-sizing/columnSizingFeature.types'
+import type { Column_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { ColumnDefBase_All } from './ColumnDef'
+import type { RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { Column_Column } from '../core/columns/coreColumnsFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface Column_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue = unknown,
+> {}
+
+export interface Column_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue = unknown,
+> extends Column_Column<TFeatures, TData, TValue> {}
+
+export type Column<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue = unknown,
+> = Column_Core<TFeatures, TData, TValue> &
+  UnionToIntersection<
+    | ('columnFacetingFeature' extends keyof TFeatures
+        ? Column_ColumnFaceting<TFeatures, TData>
+        : never)
+    | ('columnFilteringFeature' extends keyof TFeatures
+        ? Column_ColumnFiltering<TFeatures, TData>
+        : never)
+    | ('columnGroupingFeature' extends keyof TFeatures
+        ? Column_ColumnGrouping<TFeatures, TData>
+        : never)
+    | ('columnOrderingFeature' extends keyof TFeatures
+        ? Column_ColumnOrdering
+        : never)
+    | ('columnPinningFeature' extends keyof TFeatures
+        ? Column_ColumnPinning
+        : never)
+    | ('columnResizingFeature' extends keyof TFeatures
+        ? Column_ColumnResizing
+        : never)
+    | ('columnSizingFeature' extends keyof TFeatures
+        ? Column_ColumnSizing
+        : never)
+    | ('columnVisibilityFeature' extends keyof TFeatures
+        ? Column_ColumnVisibility
+        : never)
+    | ('globalFilteringFeature' extends keyof TFeatures
+        ? Column_GlobalFiltering
+        : never)
+    | ('rowSortingFeature' extends keyof TFeatures
+        ? Column_RowSorting<TFeatures, TData>
+        : never)
+  > &
+  ExtractFeatureTypes<'Column', TFeatures> &
+  Column_Plugins<TFeatures, TData, TValue>
+
+// export type Column<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+//   TValue = unknown,
+// > = Column_Core<TFeatures, TData, TValue> &
+//   ExtractFeatureTypes<'Column', TFeatures> &
+//   Column_Plugins<TFeatures, TData, TValue>
+
+export type Column_Internal<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue = unknown,
+> = Column<TFeatures, TData, TValue> & {
+  columnDef: ColumnDefBase_All<TFeatures, TData, TValue>
+}

package/src/types/ColumnDef.ts

@@ -0,0 +1,255 @@
+import type { CellData, RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { CellContext } from '../core/cells/coreCellsFeature.types'
+import type { HeaderContext } from '../core/headers/coreHeadersFeature.types'
+import type { ColumnDef_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { ColumnDef_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { ColumnDef_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
+import type { ColumnDef_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
+import type { ColumnDef_ColumnSizing } from '../features/column-sizing/columnSizingFeature.types'
+import type { ColumnDef_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { ColumnDef_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
+import type { ColumnDef_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface ColumnDef_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+export interface ColumnMeta<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+/**
+ * Reads a cell value from an original row object.
+ *
+ * The row index is provided for accessors that need stable position-aware
+ * derived values.
+ */
+export type AccessorFn<
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = (originalRow: TData, index: number) => TValue
+
+/**
+ * A renderable column template value.
+ *
+ * Strings render directly; functions receive the relevant cell/header context
+ * and can return framework-specific render output.
+ */
+export type ColumnDefTemplate<TProps extends object> =
+  | string
+  | ((props: TProps) => any)
+
+export type StringOrTemplateHeader<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = string | ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
+
+export interface StringHeaderIdentifier {
+  /**
+   * Header text used both for rendering and as a fallback column id.
+   */
+  header: string
+  /**
+   * Optional explicit id that overrides the header-derived id.
+   */
+  id?: string
+}
+
+export interface IdIdentifier<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {
+  /**
+   * Explicit stable column id.
+   */
+  id: string
+  /**
+   * Header text or template used to render this column's header.
+   */
+  header?: StringOrTemplateHeader<TFeatures, TData, TValue>
+}
+type ColumnIdentifiers<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = IdIdentifier<TFeatures, TData, TValue> | StringHeaderIdentifier
+
+interface ColumnDefBase_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {
+  /**
+   * Produces the values used by faceting/grouping for this column.
+   *
+   * When omitted, the normal accessor value is wrapped in a single-item array.
+   */
+  getUniqueValues?: AccessorFn<TData, Array<unknown>>
+  /**
+   * Footer template rendered with header context.
+   */
+  footer?: ColumnDefTemplate<HeaderContext<TFeatures, TData, TValue>>
+  /**
+   * Cell template rendered with cell context.
+   */
+  cell?: ColumnDefTemplate<CellContext<TFeatures, TData, TValue>>
+  /**
+   * User-defined metadata available on the resolved column definition.
+   */
+  meta?: ColumnMeta<TFeatures, TData, TValue>
+}
+
+export type ColumnDefBase<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase_Core<TFeatures, TData, TValue> &
+  UnionToIntersection<
+    | ('columnVisibilityFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnVisibility
+        : never)
+    | ('columnPinningFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnPinning
+        : never)
+    | ('columnFilteringFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnFiltering<TFeatures, TData>
+        : never)
+    | ('globalFilteringFeature' extends keyof TFeatures
+        ? ColumnDef_GlobalFiltering
+        : never)
+    | ('rowSortingFeature' extends keyof TFeatures
+        ? ColumnDef_RowSorting<TFeatures, TData>
+        : never)
+    | ('columnGroupingFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnGrouping<TFeatures, TData, TValue>
+        : never)
+    | ('columnSizingFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnSizing
+        : never)
+    | ('columnResizingFeature' extends keyof TFeatures
+        ? ColumnDef_ColumnResizing
+        : never)
+  > &
+  ExtractFeatureTypes<'ColumnDef', TFeatures> &
+  ColumnDef_Plugins<TFeatures, TData, TValue>
+
+// export type ColumnDefBase<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+//   TValue extends CellData = CellData,
+// > = ColumnDefBase_Core<TFeatures, TData, TValue> &
+//   ExtractFeatureTypes<'ColumnDef', TFeatures> &
+//   ColumnDef_Plugins<TFeatures, TData, TValue>
+
+export type ColumnDefBase_All<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase_Core<TFeatures, TData, TValue> &
+  Partial<
+    ColumnDef_ColumnVisibility &
+      ColumnDef_ColumnPinning &
+      ColumnDef_ColumnFiltering<TFeatures, TData> &
+      ColumnDef_GlobalFiltering &
+      ColumnDef_RowSorting<TFeatures, TData> &
+      ColumnDef_ColumnGrouping<TFeatures, TData, TValue> &
+      ColumnDef_ColumnSizing &
+      ColumnDef_ColumnResizing
+  >
+
+export type IdentifiedColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase<TFeatures, TData, TValue> & {
+  id?: string
+  header?: StringOrTemplateHeader<TFeatures, TData, TValue>
+}
+
+export type DisplayColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase<TFeatures, TData, TValue> &
+  ColumnIdentifiers<TFeatures, TData, TValue>
+type GroupColumnDefBase<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase<TFeatures, TData, TValue> & {
+  columns?: ReadonlyArray<ColumnDef<TFeatures, TData, unknown>>
+}
+
+export type GroupColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = GroupColumnDefBase<TFeatures, TData, TValue> &
+  ColumnIdentifiers<TFeatures, TData, TValue>
+
+export type AccessorFnColumnDefBase<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase<TFeatures, TData, TValue> & {
+  accessorFn: AccessorFn<TData, TValue>
+}
+
+export type AccessorFnColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = AccessorFnColumnDefBase<TFeatures, TData, TValue> &
+  ColumnIdentifiers<TFeatures, TData, TValue>
+
+export type AccessorKeyColumnDefBase<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = ColumnDefBase<TFeatures, TData, TValue> & {
+  id?: string
+  accessorKey: (string & {}) | keyof TData
+}
+
+export type AccessorKeyColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = AccessorKeyColumnDefBase<TFeatures, TData, TValue> &
+  Partial<ColumnIdentifiers<TFeatures, TData, TValue>>
+
+export type AccessorColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> =
+  | AccessorKeyColumnDef<TFeatures, TData, TValue>
+  | AccessorFnColumnDef<TFeatures, TData, TValue>
+
+export type ColumnDef<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> =
+  | DisplayColumnDef<TFeatures, TData, TValue>
+  | GroupColumnDef<TFeatures, TData, TValue>
+  | AccessorColumnDef<TFeatures, TData, TValue>
+
+export type ColumnDefResolved<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = Partial<UnionToIntersection<ColumnDef<TFeatures, TData, TValue>>> & {
+  accessorKey?: string
+}

package/src/types/Header.ts

@@ -0,0 +1,45 @@
+import type { Header_ColumnSizing } from '../features/column-sizing/columnSizingFeature.types'
+import type { CellData, RowData, UnionToIntersection } from './type-utils'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { Header_Header } from '../core/headers/coreHeadersFeature.types'
+import type { Header_ColumnResizing } from '../features/column-resizing/columnResizingFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface Header_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> {}
+
+export interface Header_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> extends Header_Header<TFeatures, TData, TValue> {}
+
+export type Header<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+> = Header_Core<TFeatures, TData, TValue> &
+  UnionToIntersection<
+    | ('columnSizingFeature' extends keyof TFeatures
+        ? Header_ColumnSizing
+        : never)
+    | ('columnResizingFeature' extends keyof TFeatures
+        ? Header_ColumnResizing
+        : never)
+  > &
+  ExtractFeatureTypes<'Header', TFeatures> &
+  Header_Plugins<TFeatures, TData, TValue>
+
+// export type Header<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+//   TValue extends CellData = CellData,
+// > = Header_Core<TFeatures, TData, TValue> &
+//   ExtractFeatureTypes<'Header', TFeatures> &
+//   Header_Plugins<TFeatures, TData, TValue>

package/src/types/HeaderGroup.ts

@@ -0,0 +1,24 @@
+import type { HeaderGroup_Header } from '../core/headers/coreHeadersFeature.types'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { RowData } from './type-utils'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface HeaderGroup_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {}
+
+export interface HeaderGroup_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> extends HeaderGroup_Header<TFeatures, TData> {}
+
+export type HeaderGroup<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = HeaderGroup_Core<TFeatures, TData> &
+  ExtractFeatureTypes<'HeaderGroup', TFeatures> &
+  HeaderGroup_Plugins<TFeatures, TData>

package/src/types/Row.ts

@@ -0,0 +1,55 @@
+import type { Row_ColumnVisibility } from '../features/column-visibility/columnVisibilityFeature.types'
+import type { Row_ColumnPinning } from '../features/column-pinning/columnPinningFeature.types'
+import type { Row_ColumnGrouping } from '../features/column-grouping/columnGroupingFeature.types'
+import type { Row_ColumnFiltering } from '../features/column-filtering/columnFilteringFeature.types'
+import type { RowData, UnionToIntersection } from './type-utils'
+import type { Row_RowExpanding } from '../features/row-expanding/rowExpandingFeature.types'
+import type { Row_RowPinning } from '../features/row-pinning/rowPinningFeature.types'
+import type { Row_RowSelection } from '../features/row-selection/rowSelectionFeature.types'
+import type { ExtractFeatureTypes, TableFeatures } from './TableFeatures'
+import type { Row_Row } from '../core/rows/coreRowsFeature.types'
+
+/**
+ * Use this interface as a target for declaration merging to add your own plugin properties.
+ * Note: This will affect the types of all tables in your project.
+ */
+export interface Row_Plugins<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {}
+
+export interface Row_Core<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> extends Row_Row<TFeatures, TData> {}
+
+export type Row<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = Row_Core<TFeatures, TData> &
+  UnionToIntersection<
+    | ('columnFilteringFeature' extends keyof TFeatures
+        ? Row_ColumnFiltering<TFeatures, TData>
+        : never)
+    | ('columnGroupingFeature' extends keyof TFeatures
+        ? Row_ColumnGrouping
+        : never)
+    | ('columnPinningFeature' extends keyof TFeatures
+        ? Row_ColumnPinning<TFeatures, TData>
+        : never)
+    | ('columnVisibilityFeature' extends keyof TFeatures
+        ? Row_ColumnVisibility<TFeatures, TData>
+        : never)
+    | ('rowExpandingFeature' extends keyof TFeatures ? Row_RowExpanding : never)
+    | ('rowPinningFeature' extends keyof TFeatures ? Row_RowPinning : never)
+    | ('rowSelectionFeature' extends keyof TFeatures ? Row_RowSelection : never)
+  > &
+  ExtractFeatureTypes<'Row', TFeatures> &
+  Row_Plugins<TFeatures, TData>
+
+// export type Row<
+//   TFeatures extends TableFeatures,
+//   TData extends RowData,
+// > = Row_Core<TFeatures, TData> &
+//   ExtractFeatureTypes<'Row', TFeatures> &
+//   Row_Plugins<TFeatures, TData>