@tanstack/table-core 8.0.0-alpha.63 → 8.0.0-alpha.67

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.63",
+  "version": "8.0.0-alpha.67",
   "description": "Hooks for building lightweight, fast and extendable datagrids for React",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/react-table#readme",
@@ -28,6 +28,7 @@
   "main": "build/cjs/index.js",
   "browser": "build/umd/index.production.min.js",
   "types": "build/types/index.d.ts",
+  "sideEffects": false,
   "engines": {
     "node": ">=12"
   },

package/src/core.ts

@@ -116,14 +116,15 @@ export function createTableInstance<TGenerics extends TableGenerics>(
     coreProgress: 1,
   }
 
-  const initialState = {
+  let initialState = {
     ...coreInitialState,
     ...(options.initialState ?? {}),
-    ...instance._features.reduce((obj, feature) => {
-      return Object.assign(obj, feature.getInitialState?.(options.initialState))
-    }, {}),
   } as TableState
 
+  instance._features.forEach(feature => {
+    initialState = feature.getInitialState?.(initialState) ?? initialState
+  })
+
   const queued: (() => void)[] = []
   let queuedTimeout = false
 
@@ -154,7 +155,6 @@ export function createTableInstance<TGenerics extends TableGenerics>(
           )
       }
     },
-    // willUpdate: () => {},
     initialState,
     reset: () => {
       instance.setState(instance.initialState)

package/src/features/Cells.ts

@@ -42,7 +42,7 @@ export const Cells = {
           })
         },
         {
-          key: process.env.NODE_ENV !== 'production' ? 'row.getAllCells' : '',
+          key: process.env.NODE_ENV === 'development' ? 'row.getAllCells' : '',
           debug: () => instance.options.debugAll ?? instance.options.debugRows,
         }
       ),
@@ -56,7 +56,9 @@ export const Cells = {
           }, {} as Record<string, Cell<TGenerics>>)
         },
         {
-          key: 'row.getAllCellsByColumnId',
+          key:
+            process.env.NODE_ENV === 'production' &&
+            'row.getAllCellsByColumnId',
           debug: () => instance.options.debugAll ?? instance.options.debugRows,
         }
       ),

package/src/features/ColumnSizing.ts

@@ -44,19 +44,10 @@ export type ColumnSizingDefaultOptions = {
 }
 
 export type ColumnSizingInstance<TGenerics extends TableGenerics> = {
-  getColumnSize: (columnId: string) => number
-  getColumnStart: (columnId: string, position?: ColumnPinningPosition) => number
   setColumnSizing: (updater: Updater<ColumnSizingState>) => void
   setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void
   resetColumnSizing: () => void
-  resetColumnSize: (columnId: string) => void
-  resetHeaderSize: (headerId: string) => void
   resetHeaderSizeInfo: () => void
-  getColumnCanResize: (columnId: string) => boolean
-  getHeaderCanResize: (headerId: string) => boolean
-  getResizeHandler: (headerId: string) => (event: unknown) => void
-  getColumnIsResizing: (columnId: string) => boolean
-  getHeaderIsResizing: (headerId: string) => boolean
   getTotalSize: () => number
   getLeftTotalSize: () => number
   getCenterTotalSize: () => number
@@ -65,7 +56,6 @@ export type ColumnSizingInstance<TGenerics extends TableGenerics> = {
 
 export type ColumnSizingColumnDef = {
   enableResizing?: boolean
-  defaultCanResize?: boolean
   size?: number
   minSize?: number
   maxSize?: number
@@ -80,10 +70,9 @@ export type ColumnSizingColumn<TGenerics extends TableGenerics> = {
 }
 
 export type ColumnSizingHeader<TGenerics extends TableGenerics> = {
-  getCanResize: () => boolean
-  getIsResizing: () => boolean
+  getSize: () => number
+  getStart: (position?: ColumnPinningPosition) => number
   getResizeHandler: () => (event: unknown) => void
-  resetSize: () => void
 }
 
 //
@@ -98,7 +87,7 @@ export const ColumnSizing: TableFeature = {
   getDefaultColumn: (): ColumnSizingColumnDef => {
     return defaultColumnSizing
   },
-  getInitialState: (): ColumnSizingTableState => {
+  getInitialState: (state): ColumnSizingTableState => {
     return {
       columnSizing: {},
       columnSizingInfo: {
@@ -109,6 +98,7 @@ export const ColumnSizing: TableFeature = {
         isResizingColumn: false,
         columnSizingStart: [],
       },
+      ...state,
     }
   },
 
@@ -127,37 +117,7 @@ export const ColumnSizing: TableFeature = {
     instance: TableInstance<TGenerics>
   ): ColumnSizingColumn<TGenerics> => {
     return {
-      getSize: () => instance.getColumnSize(column.id),
-      getStart: position => instance.getColumnStart(column.id, position),
-      getIsResizing: () => instance.getColumnIsResizing(column.id),
-      getCanResize: () => instance.getColumnCanResize(column.id),
-      resetSize: () => instance.resetColumnSize(column.id),
-    }
-  },
-
-  createHeader: <TGenerics extends TableGenerics>(
-    header: Header<TGenerics>,
-    instance: TableInstance<TGenerics>
-  ): ColumnSizingHeader<TGenerics> => {
-    return {
-      getIsResizing: () => instance.getColumnIsResizing(header.column.id),
-      getCanResize: () => instance.getColumnCanResize(header.column.id),
-      resetSize: () => instance.resetColumnSize(header.column.id),
-      getResizeHandler: () => instance.getResizeHandler(header.id),
-    }
-  },
-
-  createInstance: <TGenerics extends TableGenerics>(
-    instance: TableInstance<TGenerics>
-  ): ColumnSizingInstance<TGenerics> => {
-    return {
-      getColumnSize: (columnId: string) => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
+      getSize: () => {
         const columnSize = instance.getState().columnSizing[column.id]
 
         return Math.min(
@@ -168,99 +128,73 @@ export const ColumnSizing: TableFeature = {
           column.maxSize ?? defaultColumnSizing.maxSize
         )
       },
-      getColumnStart: (columnId, position) => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
+      getStart: position => {
         const columns = !position
           ? instance.getVisibleLeafColumns()
           : position === 'left'
           ? instance.getLeftVisibleLeafColumns()
           : instance.getRightVisibleLeafColumns()
 
-        const index = columns.findIndex(d => d.id === columnId)
+        const index = columns.findIndex(d => d.id === column.id)
 
         if (index > 0) {
           const prevSiblingColumn = columns[index - 1]
 
           return (
-            instance.getColumnStart(prevSiblingColumn.id, position) +
-            prevSiblingColumn.getSize()
+            prevSiblingColumn.getStart(position) + prevSiblingColumn.getSize()
           )
         }
 
         return 0
       },
-      setColumnSizing: updater =>
-        instance.options.onColumnSizingChange?.(updater),
-      setColumnSizingInfo: updater =>
-        instance.options.onColumnSizingInfoChange?.(updater),
-      resetColumnSizing: () => {
-        instance.setColumnSizing(instance.initialState.columnSizing ?? {})
-      },
-      resetHeaderSizeInfo: () => {
-        instance.setColumnSizingInfo(
-          instance.initialState.columnSizingInfo ?? {}
-        )
-      },
-      resetColumnSize: columnId => {
-        instance.setColumnSizing(({ [columnId]: _, ...rest }) => {
+      resetSize: () => {
+        instance.setColumnSizing(({ [column.id]: _, ...rest }) => {
           return rest
         })
       },
-      resetHeaderSize: headerId => {
-        const header = instance.getHeader(headerId)
-
-        return instance.resetColumnSize(header.column.id)
-      },
-      getHeaderCanResize: headerId => {
-        const header = instance.getHeader(headerId)
-
-        if (!header) {
-          throw new Error()
-        }
-
-        return instance.getColumnCanResize(header.column.id)
+      getCanResize: () => {
+        return (
+          (column.enableResizing ?? true) &&
+          (instance.options.enableColumnResizing ?? true)
+        )
       },
-      getColumnCanResize: columnId => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
+      getIsResizing: () => {
         return (
-          column.enableResizing ??
-          instance.options.enableColumnResizing ??
-          column.defaultCanResize ??
-          true
+          instance.getState().columnSizingInfo.isResizingColumn === column.id
         )
       },
-      getColumnIsResizing: columnId => {
-        const column = instance.getColumn(columnId)
+    }
+  },
+
+  createHeader: <TGenerics extends TableGenerics>(
+    header: Header<TGenerics>,
+    instance: TableInstance<TGenerics>
+  ): ColumnSizingHeader<TGenerics> => {
+    return {
+      getSize: () => {
+        let sum = 0
 
-        if (!column) {
-          throw new Error()
+        const recurse = (header: Header<TGenerics>) => {
+          if (header.subHeaders.length) {
+            header.subHeaders.forEach(recurse)
+          } else {
+            sum += header.column.getSize() ?? 0
+          }
         }
 
-        return (
-          instance.getState().columnSizingInfo.isResizingColumn === columnId
-        )
-      },
-      getHeaderIsResizing: headerId => {
-        const header = instance.getHeader(headerId)
+        recurse(header)
 
-        if (!header) {
-          throw new Error()
+        return sum
+      },
+      getStart: () => {
+        if (header.index > 0) {
+          const prevSiblingHeader = header.headerGroup.headers[header.index - 1]
+          return prevSiblingHeader.getStart() + prevSiblingHeader.getSize()
         }
 
-        return instance.getColumnIsResizing(header.column.id)
+        return 0
       },
-      getResizeHandler: (headerId: string) => {
-        const header = instance.getHeader(headerId)
+      getResizeHandler: () => {
         const column = instance.getColumn(header.column.id)
         const canResize = column.getCanResize()
 
@@ -278,12 +212,12 @@ export const ColumnSizing: TableFeature = {
             }
           }
 
-          const header = headerId ? instance.getHeader(headerId) : undefined
-
-          const startSize = header ? header.getSize() : column.getSize()
+          const startSize = column.getSize()
 
           const columnSizingStart: [string, number][] = header
-            ? header.getLeafHeaders().map(d => [d.column.id, d.getSize()])
+            ? header
+                .getLeafHeaders()
+                .map(d => [d.column.id, d.column.getSize()])
             : [[column.id, column.getSize()]]
 
           const clientX = isTouchStartEvent(e)
@@ -383,16 +317,6 @@ export const ColumnSizing: TableFeature = {
             : false
 
           if (isTouchStartEvent(e)) {
-            document.addEventListener(
-              'touchmove',
-              touchEvents.moveHandler,
-              passiveIfSupported
-            )
-            document.addEventListener(
-              'touchend',
-              touchEvents.upHandler,
-              passiveIfSupported
-            )
           } else {
             document.addEventListener(
               'mousemove',
@@ -417,21 +341,40 @@ export const ColumnSizing: TableFeature = {
           }))
         }
       },
+    }
+  },
+
+  createInstance: <TGenerics extends TableGenerics>(
+    instance: TableInstance<TGenerics>
+  ): ColumnSizingInstance<TGenerics> => {
+    return {
+      setColumnSizing: updater =>
+        instance.options.onColumnSizingChange?.(updater),
+      setColumnSizingInfo: updater =>
+        instance.options.onColumnSizingInfoChange?.(updater),
+      resetColumnSizing: () => {
+        instance.setColumnSizing(instance.initialState.columnSizing ?? {})
+      },
+      resetHeaderSizeInfo: () => {
+        instance.setColumnSizingInfo(
+          instance.initialState.columnSizingInfo ?? {}
+        )
+      },
       getTotalSize: () =>
         instance.getHeaderGroups()[0]?.headers.reduce((sum, header) => {
-          return sum + header.getSize()
+          return sum + header.column.getSize()
         }, 0) ?? 0,
       getLeftTotalSize: () =>
         instance.getLeftHeaderGroups()[0]?.headers.reduce((sum, header) => {
-          return sum + header.getSize()
+          return sum + header.column.getSize()
         }, 0) ?? 0,
       getCenterTotalSize: () =>
         instance.getCenterHeaderGroups()[0]?.headers.reduce((sum, header) => {
-          return sum + header.getSize()
+          return sum + header.column.getSize()
         }, 0) ?? 0,
       getRightTotalSize: () =>
         instance.getRightHeaderGroups()[0]?.headers.reduce((sum, header) => {
-          return sum + header.getSize()
+          return sum + header.column.getSize()
         }, 0) ?? 0,
     }
   },

package/src/features/Columns.ts

@@ -108,7 +108,7 @@ export const Columns = {
         {
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
-          key: 'getDefaultColumn',
+          key: process.env.NODE_ENV === 'development' && 'getDefaultColumn',
         }
       ),
 
@@ -165,7 +165,9 @@ export const Columns = {
               ]
             },
             {
-              key: 'column.getFlatColumns',
+              key:
+                process.env.NODE_ENV === 'production' &&
+                'column.getFlatColumns',
               debug: () =>
                 instance.options.debugAll ?? instance.options.debugColumns,
             }
@@ -184,7 +186,9 @@ export const Columns = {
               return [column as Column<TGenerics>]
             },
             {
-              key: 'column.getLeafColumns',
+              key:
+                process.env.NODE_ENV === 'production' &&
+                'column.getLeafColumns',
               debug: () =>
                 instance.options.debugAll ?? instance.options.debugColumns,
             }
@@ -221,7 +225,7 @@ export const Columns = {
           return recurseColumns(columnDefs)
         },
         {
-          key: 'getAllColumns',
+          key: process.env.NODE_ENV === 'development' && 'getAllColumns',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
         }
@@ -235,7 +239,7 @@ export const Columns = {
           })
         },
         {
-          key: 'getAllFlatColumns',
+          key: process.env.NODE_ENV === 'development' && 'getAllFlatColumns',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
         }
@@ -250,7 +254,8 @@ export const Columns = {
           }, {} as Record<string, Column<TGenerics>>)
         },
         {
-          key: 'getAllFlatColumnsById',
+          key:
+            process.env.NODE_ENV === 'development' && 'getAllFlatColumnsById',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
         }
@@ -265,7 +270,7 @@ export const Columns = {
           return orderColumns(leafColumns)
         },
         {
-          key: 'getAllLeafColumns',
+          key: process.env.NODE_ENV === 'development' && 'getAllLeafColumns',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
         }

package/src/features/Expanding.ts

@@ -5,8 +5,10 @@ import {
   TableInstance,
   Row,
   Updater,
+  TableFeature,
 } from '../types'
 import { makeStateUpdater } from '../utils'
+import { Rows } from './Rows'
 
 export type ExpandedStateList = Record<string, boolean>
 export type ExpandedState = true | Record<string, boolean>
@@ -25,12 +27,11 @@ export type ExpandedOptions<TGenerics extends TableGenerics> = {
   manualExpanding?: boolean
   onExpandedChange?: OnChangeFn<ExpandedState>
   autoResetExpanded?: boolean
-  enableExpanded?: boolean
+  enableExpanding?: boolean
   getExpandedRowModel?: (
     instance: TableInstance<TGenerics>
   ) => () => RowModel<TGenerics>
   expandSubRows?: boolean
-  defaultCanExpand?: boolean
   getIsRowExpanded?: (row: Row<TGenerics>) => boolean
   getRowCanExpand?: (row: Row<TGenerics>) => boolean
   paginateExpandedRows?: boolean
@@ -39,13 +40,9 @@ export type ExpandedOptions<TGenerics extends TableGenerics> = {
 export type ExpandedInstance<TGenerics extends TableGenerics> = {
   _autoResetExpanded: () => void
   setExpanded: (updater: Updater<ExpandedState>) => void
-  toggleRowExpanded: (rowId: string, expanded?: boolean) => void
   toggleAllRowsExpanded: (expanded?: boolean) => void
   resetExpanded: () => void
-  getRowCanExpand: (rowId: string) => boolean
   getCanSomeRowsExpand: () => boolean
-  getIsRowExpanded: (rowId: string) => boolean
-  getToggleExpandedHandler: (rowId: string) => undefined | (() => void)
   getToggleAllRowsExpandedHandler: () => (event: unknown) => void
   getIsSomeRowsExpanded: () => boolean
   getIsAllRowsExpanded: () => boolean
@@ -57,10 +54,11 @@ export type ExpandedInstance<TGenerics extends TableGenerics> = {
 
 //
 
-export const Expanding = {
-  getInitialState: (): ExpandedTableState => {
+export const Expanding: TableFeature = {
+  getInitialState: (state): ExpandedTableState => {
     return {
       expanded: {},
+      ...state,
     }
   },
 
@@ -99,39 +97,6 @@ export const Expanding = {
         }
       },
       setExpanded: updater => instance.options.onExpandedChange?.(updater),
-      toggleRowExpanded: (rowId, expanded) => {
-        if (!rowId) return
-
-        instance.setExpanded(old => {
-          const exists = old === true ? true : !!old?.[rowId]
-
-          let oldExpanded: ExpandedStateList = {}
-
-          if (old === true) {
-            Object.keys(instance.getRowModel().rowsById).forEach(rowId => {
-              oldExpanded[rowId] = true
-            })
-          } else {
-            oldExpanded = old
-          }
-
-          expanded = expanded ?? !exists
-
-          if (!exists && expanded) {
-            return {
-              ...oldExpanded,
-              [rowId]: true,
-            }
-          }
-
-          if (exists && !expanded) {
-            const { [rowId]: _, ...rest } = oldExpanded
-            return rest
-          }
-
-          return old
-        })
-      },
       toggleAllRowsExpanded: expanded => {
         if (expanded ?? !instance.getIsAllRowsExpanded()) {
           instance.setExpanded(true)
@@ -142,62 +107,8 @@ export const Expanding = {
       resetExpanded: () => {
         instance.setExpanded(instance.initialState?.expanded ?? {})
       },
-      getIsRowExpanded: rowId => {
-        const row = instance.getPreExpandedRowModel().rowsById[rowId]
-
-        if (!row) {
-          if (process.env.NODE_ENV !== 'production') {
-            console.warn(
-              `[Table] getIsRowExpanded: no row found with id ${rowId}`
-            )
-          }
-          throw new Error()
-        }
-
-        const expanded = instance.getState().expanded
-
-        return !!(
-          instance.options.getIsRowExpanded?.(row) ??
-          (expanded === true || expanded?.[rowId])
-        )
-      },
-      getRowCanExpand: rowId => {
-        const row = instance.getRow(rowId)
-
-        if (!row) {
-          if (process.env.NODE_ENV !== 'production') {
-            console.warn(
-              `[Table] getRowCanExpand: no row found with id ${rowId}`
-            )
-          }
-          throw new Error()
-        }
-
-        return (
-          instance.options.getRowCanExpand?.(row) ??
-          instance.options.enableExpanded ??
-          instance.options.defaultCanExpand ??
-          !!row.subRows?.length
-        )
-      },
       getCanSomeRowsExpand: () => {
-        return Object.keys(instance.getRowModel().rowsById).some(id =>
-          instance.getRowCanExpand(id)
-        )
-      },
-      getToggleExpandedHandler: rowId => {
-        const row = instance.getRow(rowId)
-
-        if (!row) {
-          return
-        }
-
-        const canExpand = instance.getRowCanExpand(rowId)
-
-        return () => {
-          if (!canExpand) return
-          instance.toggleRowExpanded(rowId)
-        }
+        return instance.getRowModel().flatRows.some(row => row.getCanExpand())
       },
       getToggleAllRowsExpandedHandler: () => {
         return (e: unknown) => {
@@ -218,11 +129,7 @@ export const Expanding = {
         }
 
         // If any row is not expanded, return false
-        if (
-          Object.keys(instance.getRowModel().rowsById).some(
-            id => !instance.getIsRowExpanded(id)
-          )
-        ) {
+        if (instance.getRowModel().flatRows.some(row => row.getIsExpanded())) {
           return false
         }
 
@@ -271,12 +178,60 @@ export const Expanding = {
     instance: TableInstance<TGenerics>
   ): ExpandedRow => {
     return {
-      toggleExpanded: expanded =>
-        void instance.toggleRowExpanded(row.id, expanded),
-      getIsExpanded: () => instance.getIsRowExpanded(row.id),
-      getCanExpand: () => row.subRows && !!row.subRows.length,
-      getToggleExpandedHandler: () =>
-        instance.getToggleExpandedHandler(row.id)!,
+      toggleExpanded: expanded => {
+        instance.setExpanded(old => {
+          const exists = old === true ? true : !!old?.[row.id]
+
+          let oldExpanded: ExpandedStateList = {}
+
+          if (old === true) {
+            Object.keys(instance.getRowModel().rowsById).forEach(rowId => {
+              oldExpanded[rowId] = true
+            })
+          } else {
+            oldExpanded = old
+          }
+
+          expanded = expanded ?? !exists
+
+          if (!exists && expanded) {
+            return {
+              ...oldExpanded,
+              [row.id]: true,
+            }
+          }
+
+          if (exists && !expanded) {
+            const { [row.id]: _, ...rest } = oldExpanded
+            return rest
+          }
+
+          return old
+        })
+      },
+      getIsExpanded: () => {
+        const expanded = instance.getState().expanded
+
+        return !!(
+          instance.options.getIsRowExpanded?.(row) ??
+          (expanded === true || expanded?.[row.id])
+        )
+      },
+      getCanExpand: () => {
+        return (
+          (instance.options.getRowCanExpand?.(row) ?? true) &&
+          (instance.options.enableExpanding ?? true) &&
+          !!row.subRows?.length
+        )
+      },
+      getToggleExpandedHandler: () => {
+        const canExpand = row.getCanExpand()
+
+        return () => {
+          if (!canExpand) return
+          row.toggleExpanded()
+        }
+      },
     }
   },
 }