@tanstack/table-core 8.0.0-alpha.65 → 8.0.0-alpha.69

package/src/features/Grouping.ts

@@ -45,11 +45,10 @@ export type GroupingColumnDef<TGenerics extends TableGenerics> = {
       row: Row<TGenerics>
       column: Column<TGenerics>
       cell: Cell<TGenerics>
-      value: TGenerics['Value']
+      getValue: () => TGenerics['Value']
     }
   >
   enableGrouping?: boolean
-  defaultCanGroup?: boolean
 }
 
 export type GroupingColumn<TGenerics extends TableGenerics> = {
@@ -59,12 +58,15 @@ export type GroupingColumn<TGenerics extends TableGenerics> = {
   getGroupedIndex: () => number
   toggleGrouping: () => void
   getToggleGroupingHandler: () => () => void
+  getColumnAutoAggregationFn: () => AggregationFn<TGenerics> | undefined
+  getColumnAggregationFn: () => AggregationFn<TGenerics> | undefined
 }
 
 export type GroupingRow = {
   groupingColumnId?: string
   groupingValue?: any
   getIsGrouped: () => boolean
+  groupingValuesCache: Record<string, any>
 }
 
 export type GroupingCell<TGenerics extends TableGenerics> = {
@@ -96,20 +98,8 @@ export type GroupingOptions<TGenerics extends TableGenerics> = {
 export type GroupingColumnMode = false | 'reorder' | 'remove'
 
 export type GroupingInstance<TGenerics extends TableGenerics> = {
-  getColumnAutoAggregationFn: (
-    columnId: string
-  ) => AggregationFn<TGenerics> | undefined
-  getColumnAggregationFn: (
-    columnId: string
-  ) => AggregationFn<TGenerics> | undefined
   setGrouping: (updater: Updater<GroupingState>) => void
-  resetGrouping: () => void
-  toggleColumnGrouping: (columnId: string) => void
-  getColumnCanGroup: (columnId: string) => boolean
-  getColumnIsGrouped: (columnId: string) => boolean
-  getColumnGroupedIndex: (columnId: string) => number
-  getToggleGroupingHandler: (columnId: string) => undefined | (() => void)
-  getRowIsGrouped: (rowId: string) => boolean
+  resetGrouping: (defaultState?: boolean) => void
   getPreGroupedRowModel: () => RowModel<TGenerics>
   getGroupedRowModel: () => RowModel<TGenerics>
   _getGroupedRowModel?: () => RowModel<TGenerics>
@@ -147,24 +137,45 @@ export const Grouping: TableFeature = {
     instance: TableInstance<TGenerics>
   ): GroupingColumn<TGenerics> => {
     return {
-      aggregationFn: column.aggregationFn,
-      getCanGroup: () => instance.getColumnCanGroup(column.id),
-      getGroupedIndex: () => instance.getColumnGroupedIndex(column.id),
-      getIsGrouped: () => instance.getColumnIsGrouped(column.id),
-      toggleGrouping: () => instance.toggleColumnGrouping(column.id),
-      getToggleGroupingHandler: () =>
-        instance.getToggleGroupingHandler(column.id)!,
-    }
-  },
+      toggleGrouping: () => {
+        instance.setGrouping(old => {
+          // Find any existing grouping for this column
+          if (old?.includes(column.id)) {
+            return old.filter(d => d !== column.id)
+          }
 
-  createInstance: <TGenerics extends TableGenerics>(
-    instance: TableInstance<TGenerics>
-  ): GroupingInstance<TGenerics> => {
-    return {
-      getColumnAutoAggregationFn: columnId => {
+          return [...(old ?? []), column.id]
+        })
+      },
+
+      getCanGroup: () => {
+        return (
+          column.enableGrouping ??
+          true ??
+          instance.options.enableGrouping ??
+          true ??
+          !!column.accessorFn
+        )
+      },
+
+      getIsGrouped: () => {
+        return instance.getState().grouping?.includes(column.id)
+      },
+
+      getGroupedIndex: () => instance.getState().grouping?.indexOf(column.id),
+
+      getToggleGroupingHandler: () => {
+        const canGroup = column.getCanGroup()
+
+        return () => {
+          if (!canGroup) return
+          column.toggleGrouping()
+        }
+      },
+      getColumnAutoAggregationFn: () => {
         const firstRow = instance.getCoreRowModel().flatRows[0]
 
-        const value = firstRow?.values[columnId]
+        const value = firstRow?.getValue(column.id)
 
         if (typeof value === 'number') {
           return aggregationFns.sum
@@ -176,8 +187,7 @@ export const Grouping: TableFeature = {
 
         return aggregationFns.count
       },
-      getColumnAggregationFn: columnId => {
-        const column = instance.getColumn(columnId)
+      getColumnAggregationFn: () => {
         const userAggregationFns = instance.options.aggregationFns
 
         if (!column) {
@@ -187,7 +197,7 @@ export const Grouping: TableFeature = {
         return isFunction(column.aggregationFn)
           ? column.aggregationFn
           : column.aggregationFn === 'auto'
-          ? instance.getColumnAutoAggregationFn(columnId)
+          ? column.getColumnAutoAggregationFn()
           : (userAggregationFns as Record<string, any>)?.[
               column.aggregationFn as string
             ] ??
@@ -195,58 +205,21 @@ export const Grouping: TableFeature = {
               column.aggregationFn as BuiltInAggregationFn
             ] as AggregationFn<TGenerics>)
       },
+    }
+  },
 
+  createInstance: <TGenerics extends TableGenerics>(
+    instance: TableInstance<TGenerics>
+  ): GroupingInstance<TGenerics> => {
+    return {
       setGrouping: updater => instance.options.onGroupingChange?.(updater),
 
-      toggleColumnGrouping: columnId => {
-        instance.setGrouping(old => {
-          // Find any existing grouping for this column
-          if (old?.includes(columnId)) {
-            return old.filter(d => d !== columnId)
-          }
-
-          return [...(old ?? []), columnId]
-        })
-      },
-
-      getColumnCanGroup: columnId => {
-        const column = instance.getColumn(columnId)
-
-        if (!column) {
-          throw new Error()
-        }
-
-        return (
-          column.enableGrouping ??
-          instance.options.enableGrouping ??
-          column.defaultCanGroup ??
-          !!column.accessorFn
+      resetGrouping: defaultState => {
+        instance.setGrouping(
+          defaultState ? [] : instance.initialState?.grouping ?? []
         )
       },
 
-      getColumnIsGrouped: columnId => {
-        return instance.getState().grouping?.includes(columnId)
-      },
-
-      getColumnGroupedIndex: columnId =>
-        instance.getState().grouping?.indexOf(columnId),
-
-      resetGrouping: () => {
-        instance.setGrouping(instance.initialState?.grouping ?? [])
-      },
-
-      getToggleGroupingHandler: columnId => {
-        const column = instance.getColumn(columnId)
-        const canGroup = column.getCanGroup()
-
-        return () => {
-          if (!canGroup) return
-          column.toggleGrouping?.()
-        }
-      },
-
-      getRowIsGrouped: rowId => !!instance.getRow(rowId)?.groupingColumnId,
-
       getPreGroupedRowModel: () => instance.getSortedRowModel(),
       getGroupedRowModel: () => {
         if (
@@ -271,7 +244,8 @@ export const Grouping: TableFeature = {
     instance: TableInstance<TGenerics>
   ): GroupingRow => {
     return {
-      getIsGrouped: () => instance.getRowIsGrouped(row.id),
+      getIsGrouped: () => !!row.groupingColumnId,
+      groupingValuesCache: {},
     }
   },
 
@@ -298,7 +272,7 @@ export const Grouping: TableFeature = {
               column,
               row,
               cell,
-              value: cell.value,
+              getValue: cell.getValue,
             })
           : null
       },

package/src/features/Headers.ts

@@ -72,30 +72,6 @@ export const Headers = {
           colSpan: 0,
           rowSpan: 0,
           headerGroup: null!,
-          getSize: () => {
-            let sum = 0
-
-            const recurse = (header: CoreHeader<TGenerics>) => {
-              if (header.subHeaders.length) {
-                header.subHeaders.forEach(recurse)
-              } else {
-                sum += header.column.getSize() ?? 0
-              }
-            }
-
-            recurse(header)
-
-            return sum
-          },
-          getStart: () => {
-            if (header.index > 0) {
-              const prevSiblingHeader =
-                header.headerGroup.headers[header.index - 1]
-              return prevSiblingHeader.getStart() + prevSiblingHeader.getSize()
-            }
-
-            return 0
-          },
           getLeafHeaders: (): Header<TGenerics>[] => {
             const leafHeaders: CoreHeader<TGenerics>[] = []
 
@@ -163,7 +139,7 @@ export const Headers = {
           return headerGroups
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -183,7 +159,8 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'center')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterHeaderGroups',
+          key:
+            process.env.NODE_ENV === 'development' && 'getCenterHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -200,7 +177,7 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'left')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getLeftHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -217,7 +194,7 @@ export const Headers = {
           return buildHeaderGroups(allColumns, leafColumns, instance, 'right')
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightHeaderGroups',
+          key: process.env.NODE_ENV === 'development' && 'getRightHeaderGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -231,7 +208,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -243,7 +220,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getLeftFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -255,7 +232,8 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterFooterGroups',
+          key:
+            process.env.NODE_ENV === 'development' && 'getCenterFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -267,7 +245,7 @@ export const Headers = {
           return [...headerGroups].reverse()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getRightFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -285,7 +263,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -301,7 +279,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeftFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -317,7 +295,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getCenterFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -333,7 +311,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getRightFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -347,7 +325,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getCenterLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getCenterLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -359,7 +337,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeftLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeftLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -371,7 +349,7 @@ export const Headers = {
           return flatHeaders.filter(header => !header.subHeaders?.length)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getRightLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getRightLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -395,7 +373,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }

package/src/features/Ordering.ts

@@ -27,7 +27,7 @@ export type ColumnOrderDefaultOptions = {
 
 export type ColumnOrderInstance<TGenerics extends TableGenerics> = {
   setColumnOrder: (updater: Updater<ColumnOrderState>) => void
-  resetColumnOrder: () => void
+  resetColumnOrder: (defaultState?: boolean) => void
   _getOrderColumnsFn: () => (
     columns: Column<TGenerics>[]
   ) => Column<TGenerics>[]
@@ -57,8 +57,10 @@ export const Ordering: TableFeature = {
     return {
       setColumnOrder: updater =>
         instance.options.onColumnOrderChange?.(updater),
-      resetColumnOrder: () => {
-        instance.setColumnOrder(instance.initialState.columnOrder ?? [])
+      resetColumnOrder: defaultState => {
+        instance.setColumnOrder(
+          defaultState ? [] : instance.initialState.columnOrder ?? []
+        )
       },
       _getOrderColumnsFn: memo(
         () => [
@@ -100,7 +102,7 @@ export const Ordering: TableFeature = {
           return orderColumns(orderedColumns, grouping, groupedColumnMode)
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getOrderColumnsFn',
+          key: process.env.NODE_ENV === 'development' && 'getOrderColumnsFn',
           // debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),

package/src/features/Pagination.ts

@@ -39,11 +39,11 @@ export type PaginationDefaultOptions = {
 export type PaginationInstance<TGenerics extends TableGenerics> = {
   _autoResetPageIndex: () => void
   setPagination: (updater: Updater<PaginationState>) => void
-  resetPagination: () => void
+  resetPagination: (defaultState?: boolean) => void
   setPageIndex: (updater: Updater<number>) => void
-  resetPageIndex: () => void
+  resetPageIndex: (defaultState?: boolean) => void
   setPageSize: (updater: Updater<number>) => void
-  resetPageSize: () => void
+  resetPageSize: (defaultState?: boolean) => void
   setPageCount: (updater: Updater<number>) => void
   getPageOptions: () => number[]
   getCanPreviousPage: () => boolean
@@ -58,14 +58,22 @@ export type PaginationInstance<TGenerics extends TableGenerics> = {
 
 //
 
+const defaultPageCount = -1
+const defaultPageIndex = 0
+const defaultPageSize = 10
+
+const getDefaultPaginationState = (): PaginationState => ({
+  pageCount: defaultPageCount,
+  pageIndex: defaultPageIndex,
+  pageSize: defaultPageSize,
+})
+
 export const Pagination: TableFeature = {
   getInitialState: (state): PaginationTableState => {
     return {
       ...state,
       pagination: {
-        pageCount: -1,
-        pageIndex: 0,
-        pageSize: 10,
+        ...getDefaultPaginationState(),
         ...state?.pagination,
       },
     }
@@ -112,13 +120,11 @@ export const Pagination: TableFeature = {
 
         return instance.options.onPaginationChange?.(safeUpdater)
       },
-      resetPagination: () => {
+      resetPagination: defaultState => {
         instance.setPagination(
-          instance.initialState.pagination ?? {
-            pageIndex: 0,
-            pageSize: 10,
-            pageCount: -1,
-          }
+          defaultState
+            ? getDefaultPaginationState()
+            : instance.initialState.pagination ?? getDefaultPaginationState()
         )
       },
       setPageIndex: updater => {
@@ -138,11 +144,19 @@ export const Pagination: TableFeature = {
           }
         })
       },
-      resetPageIndex: () => {
-        instance.setPageIndex(0)
+      resetPageIndex: defaultState => {
+        instance.setPageIndex(
+          defaultState
+            ? defaultPageIndex
+            : instance.initialState?.pagination?.pageIndex ?? defaultPageIndex
+        )
       },
-      resetPageSize: () => {
-        instance.setPageSize(instance.initialState?.pagination?.pageSize ?? 10)
+      resetPageSize: defaultState => {
+        instance.setPageSize(
+          defaultState
+            ? defaultPageSize
+            : instance.initialState?.pagination?.pageSize ?? defaultPageSize
+        )
       },
       setPageSize: updater => {
         instance.setPagination(old => {
@@ -184,7 +198,7 @@ export const Pagination: TableFeature = {
           return pageOptions
         },
         {
-          key: process.env.NODE_ENV === 'production' && 'getPageOptions',
+          key: process.env.NODE_ENV === 'development' && 'getPageOptions',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),