@tanstack/table-core 9.0.0-alpha.42 → 9.0.0-alpha.46

package/src/features/column-pinning/columnPinningFeature.utils.ts

@@ -1,6 +1,6 @@
 import {
   column_getIsVisible,
-  row_getAllVisibleCells,
+  row_getVisibleCells,
   table_getVisibleLeafColumns,
 } from '../column-visibility/columnVisibilityFeature.utils'
 import { buildHeaderGroups } from '../../core/headers/buildHeaderGroups'
@@ -19,6 +19,16 @@ import type {
 
 // State
 
+/**
+ * Returns the default column pinning state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultColumnPinningState()
+ * ```
+ */
 export function getDefaultColumnPinningState(): ColumnPinningState {
   return {
     left: [],
@@ -28,6 +38,16 @@ export function getDefaultColumnPinningState(): ColumnPinningState {
 
 // Column APIs
 
+/**
+ * Pin. for a column.
+ *
+ * This is the static implementation behind the matching column instance API.
+ *
+ * @example
+ * ```ts
+ * column_pin(column, 'left')
+ * ```
+ */
 export function column_pin<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -66,6 +86,16 @@ export function column_pin<
   })
 }
 
+/**
+ * Returns whether a column can use pin.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanPin(column)
+ * ```
+ */
 export function column_getCanPin<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -82,6 +112,16 @@ export function column_getCanPin<
   )
 }
 
+/**
+ * Returns is pinned for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getIsPinned(column)
+ * ```
+ */
 export function column_getIsPinned<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -100,6 +140,16 @@ export function column_getIsPinned<
   return isLeft ? 'left' : isRight ? 'right' : false
 }
 
+/**
+ * Returns pinned index for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getPinnedIndex(column)
+ * ```
+ */
 export function column_getPinnedIndex<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -115,14 +165,24 @@ export function column_getPinnedIndex<
 
 // Row APIs
 
+/**
+ * Returns center visible cells for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getCenterVisibleCells(row)
+ * ```
+ */
 export function row_getCenterVisibleCells<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(row: Row<TFeatures, TData>) {
   const allCells = callMemoOrStaticFn(
     row,
-    'getAllVisibleCells',
-    row_getAllVisibleCells,
+    'getVisibleCells',
+    row_getVisibleCells,
   )
   const { left, right } =
     row.table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
@@ -130,50 +190,86 @@ export function row_getCenterVisibleCells<
   return allCells.filter((d) => !leftAndRight.includes(d.column.id))
 }
 
+/**
+ * Returns left visible cells for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getLeftVisibleCells(row)
+ * ```
+ */
 export function row_getLeftVisibleCells<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>> {
-  const allCells = callMemoOrStaticFn(
-    row,
-    'getAllVisibleCells',
-    row_getAllVisibleCells,
-  )
   const { left } =
     row.table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
-  const cells = left
-    .map((columnId) => allCells.find((cell) => cell.column.id === columnId)!)
-    .filter(Boolean)
-  // Assign position property directly to preserve prototype chain
-  cells.forEach((cell) => {
-    cell.position = 'left'
-  })
-  return cells as any
+  if (!left.length) return []
+  const allVisibleCells = callMemoOrStaticFn(
+    row,
+    'getVisibleCells',
+    row_getVisibleCells,
+  )
+  const cells: typeof allVisibleCells = []
+  for (const columnId of left) {
+    const cell = allVisibleCells.find((c) => c.column.id === columnId)
+    if (cell) {
+      // Assign position property directly to preserve prototype chain
+      cell.position = 'left'
+      cells.push(cell)
+    }
+  }
+  return cells
 }
 
+/**
+ * Returns right visible cells for a row.
+ *
+ * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+ *
+ * @example
+ * ```ts
+ * const value = row_getRightVisibleCells(row)
+ * ```
+ */
 export function row_getRightVisibleCells<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(row: Row<TFeatures, TData>) {
-  const allCells = callMemoOrStaticFn(
-    row,
-    'getAllVisibleCells',
-    row_getAllVisibleCells,
-  )
   const { right } =
     row.table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
-  const cells = right
-    .map((columnId) => allCells.find((cell) => cell.column.id === columnId)!)
-    .filter(Boolean)
-  // Assign position property directly to preserve prototype chain
-  cells.forEach((cell) => {
-    cell.position = 'right'
-  })
-  return cells as any
+  if (!right.length) return [] as Array<Cell<TFeatures, TData, unknown>>
+  const allVisibleCells = callMemoOrStaticFn(
+    row,
+    'getVisibleCells',
+    row_getVisibleCells,
+  )
+  const cells: typeof allVisibleCells = []
+  for (const columnId of right) {
+    const cell = allVisibleCells.find((c) => c.column.id === columnId)
+    if (cell) {
+      // Assign position property directly to preserve prototype chain
+      cell.position = 'right'
+      cells.push(cell)
+    }
+  }
+  return cells
 }
 
 // Table APIs
 
+/**
+ * Updates the table's column pinning state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setColumnPinning(table, (old) => old)
+ * ```
+ */
 export function table_setColumnPinning<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -184,6 +280,17 @@ export function table_setColumnPinning<
   table.options.onColumnPinningChange?.(updater)
 }
 
+/**
+ * Resets the table's column pinning state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetColumnPinning(table)
+ * table_resetColumnPinning(table, true)
+ * ```
+ */
 export function table_resetColumnPinning<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -198,6 +305,16 @@ export function table_resetColumnPinning<
   )
 }
 
+/**
+ * Returns is some columns pinned for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getIsSomeColumnsPinned(table)
+ * ```
+ */
 export function table_getIsSomeColumnsPinned<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -212,46 +329,90 @@ export function table_getIsSomeColumnsPinned<
 
 // header groups
 
+/**
+ * Returns left header groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftHeaderGroups(table)
+ * ```
+ */
 export function table_getLeftHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   const allColumns = table.getAllColumns()
-  const leafColumns = callMemoOrStaticFn(
-    table,
-    'getVisibleLeafColumns',
-    table_getVisibleLeafColumns,
-  ) as Array<Column_Internal<TFeatures, TData, unknown>>
+  const leafColumnsById = table.getAllLeafColumnsById() as Record<
+    string,
+    Column_Internal<TFeatures, TData, unknown>
+  >
   const { left } =
     table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
 
-  const orderedLeafColumns = left
-    .map((columnId) => leafColumns.find((d) => d.id === columnId)!)
-    .filter(Boolean)
+  const orderedLeafColumns: Array<Column_Internal<TFeatures, TData, unknown>> =
+    []
+  for (const columnId of left) {
+    const column = leafColumnsById[columnId]
+    if (
+      column &&
+      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
+    ) {
+      orderedLeafColumns.push(column)
+    }
+  }
 
   return buildHeaderGroups(allColumns, orderedLeafColumns, table, 'left')
 }
 
+/**
+ * Returns right header groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightHeaderGroups(table)
+ * ```
+ */
 export function table_getRightHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   const allColumns = table.getAllColumns()
-  const leafColumns = callMemoOrStaticFn(
-    table,
-    'getVisibleLeafColumns',
-    table_getVisibleLeafColumns,
-  ) as unknown as Array<Column_Internal<TFeatures, TData, unknown>>
+  const leafColumnsById = table.getAllLeafColumnsById() as Record<
+    string,
+    Column_Internal<TFeatures, TData, unknown>
+  >
   const { right } =
     table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
 
-  const orderedLeafColumns = right
-    .map((columnId) => leafColumns.find((d) => d.id === columnId)!)
-    .filter(Boolean)
+  const orderedLeafColumns: Array<Column_Internal<TFeatures, TData, unknown>> =
+    []
+  for (const columnId of right) {
+    const column = leafColumnsById[columnId]
+    if (
+      column &&
+      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible)
+    ) {
+      orderedLeafColumns.push(column)
+    }
+  }
 
   return buildHeaderGroups(allColumns, orderedLeafColumns, table, 'right')
 }
 
+/**
+ * Returns center header groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterHeaderGroups(table)
+ * ```
+ */
 export function table_getCenterHeaderGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -276,6 +437,16 @@ export function table_getCenterHeaderGroups<
 
 // footer groups
 
+/**
+ * Returns left footer groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftFooterGroups(table)
+ * ```
+ */
 export function table_getLeftFooterGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -288,6 +459,16 @@ export function table_getLeftFooterGroups<
   return [...headerGroups].reverse()
 }
 
+/**
+ * Returns right footer groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightFooterGroups(table)
+ * ```
+ */
 export function table_getRightFooterGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -300,6 +481,16 @@ export function table_getRightFooterGroups<
   return [...headerGroups].reverse()
 }
 
+/**
+ * Returns center footer groups for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterFooterGroups(table)
+ * ```
+ */
 export function table_getCenterFooterGroups<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -314,6 +505,16 @@ export function table_getCenterFooterGroups<
 
 // flat headers
 
+/**
+ * Returns left flat headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftFlatHeaders(table)
+ * ```
+ */
 export function table_getLeftFlatHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -330,6 +531,16 @@ export function table_getLeftFlatHeaders<
     .flat()
 }
 
+/**
+ * Returns right flat headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightFlatHeaders(table)
+ * ```
+ */
 export function table_getRightFlatHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -346,6 +557,16 @@ export function table_getRightFlatHeaders<
     .flat()
 }
 
+/**
+ * Returns center flat headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterFlatHeaders(table)
+ * ```
+ */
 export function table_getCenterFlatHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -364,6 +585,16 @@ export function table_getCenterFlatHeaders<
 
 // leaf headers
 
+/**
+ * Returns left leaf headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftLeafHeaders(table)
+ * ```
+ */
 export function table_getLeftLeafHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -375,6 +606,16 @@ export function table_getLeftLeafHeaders<
   ).filter((header) => !header.subHeaders.length)
 }
 
+/**
+ * Returns right leaf headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightLeafHeaders(table)
+ * ```
+ */
 export function table_getRightLeafHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -386,6 +627,16 @@ export function table_getRightLeafHeaders<
   ).filter((header) => !header.subHeaders.length)
 }
 
+/**
+ * Returns center leaf headers for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterLeafHeaders(table)
+ * ```
+ */
 export function table_getCenterLeafHeaders<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -399,34 +650,66 @@ export function table_getCenterLeafHeaders<
 
 // leaf columns
 
+/**
+ * Returns left leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftLeafColumns(table)
+ * ```
+ */
 export function table_getLeftLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   const { left } =
     table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
-  return left
-    .map(
-      (columnId) =>
-        table.getAllLeafColumns().find((column) => column.id === columnId)!,
-    )
-    .filter(Boolean)
+  const leafColumnsById = table.getAllLeafColumnsById()
+  const result: Array<Column_Internal<TFeatures, TData, unknown>> = []
+  for (const columnId of left) {
+    const column = leafColumnsById[columnId]
+    if (column) result.push(column)
+  }
+  return result
 }
 
+/**
+ * Returns right leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightLeafColumns(table)
+ * ```
+ */
 export function table_getRightLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   const { right } =
     table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
-  return right
-    .map(
-      (columnId) =>
-        table.getAllLeafColumns().find((column) => column.id === columnId)!,
-    )
-    .filter(Boolean)
+  const leafColumnsById = table.getAllLeafColumnsById()
+  const result: Array<Column_Internal<TFeatures, TData, unknown>> = []
+  for (const columnId of right) {
+    const column = leafColumnsById[columnId]
+    if (column) result.push(column)
+  }
+  return result
 }
 
+/**
+ * Returns center leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterLeafColumns(table)
+ * ```
+ */
 export function table_getCenterLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -437,6 +720,16 @@ export function table_getCenterLeafColumns<
   return table.getAllLeafColumns().filter((d) => !leftAndRight.includes(d.id))
 }
 
+/**
+ * Returns pinned leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPinnedLeafColumns(table)
+ * ```
+ */
 export function table_getPinnedLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -467,6 +760,16 @@ export function table_getPinnedLeafColumns<
 
 // visible leaf columns
 
+/**
+ * Returns left visible leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getLeftVisibleLeafColumns(table)
+ * ```
+ */
 export function table_getLeftVisibleLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -480,6 +783,16 @@ export function table_getLeftVisibleLeafColumns<
   )
 }
 
+/**
+ * Returns right visible leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getRightVisibleLeafColumns(table)
+ * ```
+ */
 export function table_getRightVisibleLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -493,6 +806,16 @@ export function table_getRightVisibleLeafColumns<
   )
 }
 
+/**
+ * Returns center visible leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getCenterVisibleLeafColumns(table)
+ * ```
+ */
 export function table_getCenterVisibleLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -506,6 +829,16 @@ export function table_getCenterVisibleLeafColumns<
   )
 }
 
+/**
+ * Returns pinned visible leaf columns for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getPinnedVisibleLeafColumns(table)
+ * ```
+ */
 export function table_getPinnedVisibleLeafColumns<
   TFeatures extends TableFeatures,
   TData extends RowData,

package/src/features/column-resizing/columnResizingFeature.ts

@@ -32,6 +32,11 @@ export interface ColumnResizingFeatureConstructors<
   // TableState: TableState_ColumnResizing
 }
 
+/**
+ * Creates the stock column resizing feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 export function constructColumnResizingFeature<
   TFeatures extends TableFeatures,
   TData extends RowData,
@@ -86,7 +91,9 @@ export function constructColumnResizingFeature<
 }
 
 /**
- * The Column Resizing feature adds column resizing state and APIs to the table and column objects.
- * **Note:** This is dependent on the Column Sizing feature.
+ * The stock column resizing feature.
+ *
+ * Register this feature with `columnSizingFeature` to add resize interaction
+ * state and APIs for drag-based column resizing.
  */
 export const columnResizingFeature = constructColumnResizingFeature()