@tanstack/table-core 9.0.0-beta.36 → 9.0.0-beta.38

package/src/features/column-sizing/columnSizingFeature.ts

@@ -14,8 +14,8 @@ import {
   header_getStart,
   table_getCenterTotalSize,
   table_getColumnOffsets,
-  table_getLeftTotalSize,
-  table_getRightTotalSize,
+  table_getEndTotalSize,
+  table_getStartTotalSize,
   table_getTotalSize,
   table_resetColumnSizing,
   table_setColumnSizing,
@@ -119,8 +119,8 @@ export const columnSizingFeature: TableFeature = {
           table.getHeaderGroups(),
         ],
       },
-      table_getLeftTotalSize: {
-        fn: () => table_getLeftTotalSize(table),
+      table_getStartTotalSize: {
+        fn: () => table_getStartTotalSize(table),
         memoDeps: () => [
           table.atoms.columnSizing?.get(),
           table.getHeaderGroups(),
@@ -133,8 +133,8 @@ export const columnSizingFeature: TableFeature = {
           table.getHeaderGroups(),
         ],
       },
-      table_getRightTotalSize: {
-        fn: () => table_getRightTotalSize(table),
+      table_getEndTotalSize: {
+        fn: () => table_getEndTotalSize(table),
         memoDeps: () => [
           table.atoms.columnSizing?.get(),
           table.getHeaderGroups(),

package/src/features/column-sizing/columnSizingFeature.types.ts

@@ -30,13 +30,19 @@ export interface ColumnOffsetsByPosition {
    */
   center: ColumnOffsets
   /**
-   * Offsets within the left pinned region.
+   * Offsets within the logical start pinned region.
+   *
+   * In LTR languages/layouts, start usually corresponds to left. In RTL
+   * languages/layouts, start usually corresponds to right.
    */
-  left: ColumnOffsets
+  start: ColumnOffsets
   /**
-   * Offsets within the right pinned region.
+   * Offsets within the logical end pinned region.
+   *
+   * In LTR languages/layouts, end usually corresponds to right. In RTL
+   * languages/layouts, end usually corresponds to left.
    */
-  right: ColumnOffsets
+  end: ColumnOffsets
 }
 
 export interface TableOptions_ColumnSizing {
@@ -66,13 +72,13 @@ export interface Table_ColumnSizing {
    */
   getColumnOffsets: () => ColumnOffsetsByPosition
   /**
-   * Sums the current sizes of visible left-pinned leaf columns.
+   * Sums the current sizes of visible logical start-pinned leaf columns.
    */
-  getLeftTotalSize: () => number
+  getStartTotalSize: () => number
   /**
-   * Sums the current sizes of visible right-pinned leaf columns.
+   * Sums the current sizes of visible logical end-pinned leaf columns.
    */
-  getRightTotalSize: () => number
+  getEndTotalSize: () => number
   /**
    * Sums the current sizes of all visible leaf columns.
    */
@@ -107,8 +113,8 @@ export interface Column_ColumnSizing {
   /**
    * Measures the offset from this column's end edge to the end of its region.
    *
-   * Pass a pinned region to measure within that region. The value is the sum
-   * of visible leaf column sizes after this column.
+   * Pass a pinned region to measure within that logical region. The value is
+   * the sum of visible leaf column sizes after this column.
    */
   getAfter: (position?: ColumnPinningPosition | 'center') => number
   /**
@@ -119,8 +125,8 @@ export interface Column_ColumnSizing {
    * Measures the offset from the start of this column's region to its start
    * edge.
    *
-   * Pass a pinned region to measure within that region. The value is the sum
-   * of visible leaf column sizes before this column.
+   * Pass a pinned region to measure within that logical region. The value is
+   * the sum of visible leaf column sizes before this column.
    */
   getStart: (position?: ColumnPinningPosition | 'center') => number
   /**

package/src/features/column-sizing/columnSizingFeature.utils.ts

@@ -1,8 +1,8 @@
 import {
   table_getCenterHeaderGroups,
-  table_getLeftHeaderGroups,
+  table_getEndHeaderGroups,
   table_getPinnedVisibleLeafColumns,
-  table_getRightHeaderGroups,
+  table_getStartHeaderGroups,
 } from '../column-pinning/columnPinningFeature.utils'
 import {
   callMemoOrStaticFn,
@@ -125,7 +125,7 @@ function buildColumnOffsets<
  * @example
  * ```ts
  * const offsets = table_getColumnOffsets(table)
- * const leftOffset = offsets.left.starts[column.id]
+ * const startOffset = offsets.start.starts[column.id]
  * ```
  */
 export function table_getColumnOffsets<
@@ -143,13 +143,13 @@ export function table_getColumnOffsets<
         Column_Internal<TFeatures, TData, unknown>
       >,
     ),
-    left: buildColumnOffsets(
-      table_getPinnedVisibleLeafColumns(table, 'left') as Array<
+    start: buildColumnOffsets(
+      table_getPinnedVisibleLeafColumns(table, 'start') as Array<
         Column_Internal<TFeatures, TData, unknown>
       >,
     ),
-    right: buildColumnOffsets(
-      table_getPinnedVisibleLeafColumns(table, 'right') as Array<
+    end: buildColumnOffsets(
+      table_getPinnedVisibleLeafColumns(table, 'end') as Array<
         Column_Internal<TFeatures, TData, unknown>
       >,
     ),
@@ -159,10 +159,10 @@ export function table_getColumnOffsets<
 function toOffsetsKey(
   position: ColumnPinningPosition | 'center' | undefined,
 ): keyof ColumnOffsetsByPosition {
-  return position === 'left'
-    ? 'left'
-    : position === 'right'
-      ? 'right'
+  return position === 'start'
+    ? 'start'
+    : position === 'end'
+      ? 'end'
       : position === 'center'
         ? 'center'
         : 'all' // undefined | false use the full visible list
@@ -172,11 +172,15 @@ function toOffsetsKey(
  * Computes the offset from the start edge of a pinning region to this column.
  *
  * The value is the sum of all previous visible leaf column sizes in the
- * requested `'left'`, `'center'`, or `'right'` region.
+ * requested `'start'`, `'center'`, or `'end'` region.
+ *
+ * `start` and `end` are logical positions. In LTR languages/layouts, `start`
+ * usually corresponds to left and `end` to right. In RTL languages/layouts,
+ * `start` usually corresponds to right and `end` to left.
  *
  * @example
  * ```ts
- * const leftOffset = column_getStart(column, 'left')
+ * const startOffset = column_getStart(column, 'start')
  * ```
  */
 export function column_getStart<
@@ -203,7 +207,7 @@ export function column_getStart<
  *
  * @example
  * ```ts
- * const rightOffset = column_getAfter(column, 'right')
+ * const endOffset = column_getAfter(column, 'end')
  * ```
  */
 export function column_getAfter<
@@ -364,7 +368,7 @@ export function table_resetColumnSizing<
 /**
  * Sums the rendered size of the full table header row.
  *
- * This includes left, center, and right columns in the main header group.
+ * This includes start, center, and end columns in the main header group.
  *
  * @example
  * ```ts
@@ -383,24 +387,24 @@ export function table_getTotalSize<
 }
 
 /**
- * Sums the rendered size of the left pinned header region.
+ * Sums the rendered size of the logical start pinned header region.
  *
- * An empty left pinning region returns `0`.
+ * An empty start pinning region returns `0`.
  *
  * @example
  * ```ts
- * const width = table_getLeftTotalSize(table)
+ * const width = table_getStartTotalSize(table)
  * ```
  */
-export function table_getLeftTotalSize<
+export function table_getStartTotalSize<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   return (
     callMemoOrStaticFn(
       table,
-      'getLeftHeaderGroups',
-      table_getLeftHeaderGroups,
+      'getStartHeaderGroups',
+      table_getStartHeaderGroups,
     )[0]?.headers.reduce((sum: number, header: Header<TFeatures, TData>) => {
       return sum + header_getSize(header)
     }, 0) ?? 0
@@ -433,24 +437,24 @@ export function table_getCenterTotalSize<
 }
 
 /**
- * Sums the rendered size of the right pinned header region.
+ * Sums the rendered size of the logical end pinned header region.
  *
- * An empty right pinning region returns `0`.
+ * An empty end pinning region returns `0`.
  *
  * @example
  * ```ts
- * const width = table_getRightTotalSize(table)
+ * const width = table_getEndTotalSize(table)
  * ```
  */
-export function table_getRightTotalSize<
+export function table_getEndTotalSize<
   TFeatures extends TableFeatures,
   TData extends RowData,
 >(table: Table_Internal<TFeatures, TData>) {
   return (
     callMemoOrStaticFn(
       table,
-      'getRightHeaderGroups',
-      table_getRightHeaderGroups,
+      'getEndHeaderGroups',
+      table_getEndHeaderGroups,
     )[0]?.headers.reduce((sum: number, header: Header<TFeatures, TData>) => {
       return sum + header_getSize(header)
     }, 0) ?? 0

package/src/features/column-visibility/columnVisibilityFeature.utils.ts

@@ -32,7 +32,7 @@ export function getDefaultColumnVisibilityState(): ColumnVisibilityState {
  * Updates this column's visibility when hiding is allowed.
  *
  * Passing `visible` stores that value. Omitting it flips the column's current
- * visibility state. Columns that cannot hide are left unchanged.
+ * visibility state. Columns that cannot hide are start unchanged.
  *
  * @example
  * ```ts
@@ -137,8 +137,8 @@ export function column_getToggleVisibilityHandler<
 /**
  * Collects the cells from this row whose columns are visible.
  *
- * When column pinning is active, the result is ordered as left-pinned cells,
- * center cells, then right-pinned cells.
+ * When column pinning is active, the result is ordered as start-pinned cells,
+ * center cells, then end-pinned cells.
  *
  * @example
  * ```ts
@@ -158,9 +158,9 @@ export function row_getVisibleCells<
     }
   }
 
-  const { left, right } =
+  const { start, end } =
     row.table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()
-  if (!left.length && !right.length) return visibleCells // no pinning, return early
+  if (!start.length && !end.length) return visibleCells // no pinning, return early
 
   const visibleCellsByColumnId = callMemoOrStaticFn(
     row,
@@ -168,16 +168,16 @@ export function row_getVisibleCells<
     row_getVisibleCellsByColumnId,
   )
 
-  const leftCells: Array<Cell<TFeatures, TData, unknown>> = []
-  for (let i = 0; i < left.length; i++) {
-    const cell = visibleCellsByColumnId[left[i]!]
-    if (cell) leftCells.push(cell)
+  const startCells: Array<Cell<TFeatures, TData, unknown>> = []
+  for (let i = 0; i < start.length; i++) {
+    const cell = visibleCellsByColumnId[start[i]!]
+    if (cell) startCells.push(cell)
   }
 
-  const rightCells: Array<Cell<TFeatures, TData, unknown>> = []
-  for (let i = 0; i < right.length; i++) {
-    const cell = visibleCellsByColumnId[right[i]!]
-    if (cell) rightCells.push(cell)
+  const endCells: Array<Cell<TFeatures, TData, unknown>> = []
+  for (let i = 0; i < end.length; i++) {
+    const cell = visibleCellsByColumnId[end[i]!]
+    if (cell) endCells.push(cell)
   }
 
   // Center cells: visible cells in natural column order, minus pinned ones.
@@ -185,10 +185,10 @@ export function row_getVisibleCells<
   for (let i = 0; i < visibleCells.length; i++) {
     const cell = visibleCells[i]!
     const id = cell.column.id
-    if (!left.includes(id) && !right.includes(id)) centerCells.push(cell)
+    if (!start.includes(id) && !end.includes(id)) centerCells.push(cell)
   }
 
-  return [...leftCells, ...centerCells, ...rightCells]
+  return [...startCells, ...centerCells, ...endCells]
 }
 
 /**

package/src/features/row-expanding/rowExpandingFeature.types.ts

@@ -1,4 +1,3 @@
-import type { Table } from '../../types/Table'
 import type { OnChangeFn, RowData, Updater } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
@@ -71,8 +70,8 @@ export interface TableOptions_RowExpanding<
 }
 
 export interface Table_RowExpanding<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
+  in out _TFeatures extends TableFeatures,
+  in out _TData extends RowData,
 > {
   autoResetExpanded: () => void
   /**

package/src/features/row-pagination/rowPaginationFeature.types.ts

@@ -1,5 +1,4 @@
 import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
-import type { Table } from '../../types/Table'
 import type { OnChangeFn, RowData, Updater } from '../../types/type-utils'
 import type { TableFeatures } from '../../types/TableFeatures'
 
@@ -42,8 +41,8 @@ export interface PaginationDefaultOptions {
 }
 
 export interface Table_RowPagination<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
+  in out _TFeatures extends TableFeatures,
+  in out _TData extends RowData,
 > {
   _autoResetPageIndex: () => void
   /**

package/src/features/row-sorting/rowSortingFeature.types.ts

@@ -199,8 +199,8 @@ export interface TableOptions_RowSorting {
 }
 
 export interface Table_RowSorting<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
+  in out _TFeatures extends TableFeatures,
+  in out _TData extends RowData,
 > {
   /**
    * Resets `sorting` to `initialState.sorting`.

package/src/types/ColumnDef.ts

@@ -15,6 +15,7 @@ import type { ColumnDef_ColumnVisibility } from '../features/column-visibility/c
 import type { ColumnDef_GlobalFiltering } from '../features/global-filtering/globalFilteringFeature.types'
 import type { ColumnDef_RowSorting } from '../features/row-sorting/rowSortingFeature.types'
 
+// @ts-expect-error Phantom type params: unused in this empty base declaration, but required with these exact names so user `declare module` augmentations merge correctly.
 export interface ColumnMeta<
   in out TFeatures extends TableFeatures,
   in out TData extends RowData,

package/src/utils.ts

@@ -254,8 +254,7 @@ export function tableMemo<
   let debugCache: boolean | undefined
 
   if (process.env.NODE_ENV === 'development') {
-    const { debugCache: _debugCache, debugAll } = table.options
-    debugCache = _debugCache
+    const { debugAll } = table.options
     const { parentName } = getFunctionNameInfo(fnName, '.')
 
     const debugByParent =
@@ -360,7 +359,7 @@ export function tableMemo<
   })
 }
 
-export interface API<TDeps extends ReadonlyArray<any>, TDepArgs> {
+export interface API<_TDeps extends ReadonlyArray<any>, _TDepArgs> {
   fn: (...args: any) => any
   memoDeps?: (depArgs?: any) => [...any] | undefined
 }
@@ -415,7 +414,7 @@ export function assignTableAPIs<
   }
 }
 
-export interface PrototypeAPI<TDeps extends ReadonlyArray<any>, TDepArgs> {
+export interface PrototypeAPI<_TDeps extends ReadonlyArray<any>, _TDepArgs> {
   fn: (self: any, ...args: any) => any
   memoDeps?: (self: any, depArgs?: any) => [...any] | undefined
 }