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

package/src/features/Grouping.ts

@@ -9,6 +9,7 @@ import {
   Updater,
   Renderable,
   TableGenerics,
+  TableFeature,
 } from '../types'
 import { isFunction, makeStateUpdater, Overwrite } from '../utils'
 
@@ -48,7 +49,6 @@ export type GroupingColumnDef<TGenerics extends TableGenerics> = {
     }
   >
   enableGrouping?: boolean
-  defaultCanGroup?: boolean
 }
 
 export type GroupingColumn<TGenerics extends TableGenerics> = {
@@ -103,12 +103,6 @@ export type GroupingInstance<TGenerics extends TableGenerics> = {
   ) => 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
   getPreGroupedRowModel: () => RowModel<TGenerics>
   getGroupedRowModel: () => RowModel<TGenerics>
   _getGroupedRowModel?: () => RowModel<TGenerics>
@@ -116,7 +110,7 @@ export type GroupingInstance<TGenerics extends TableGenerics> = {
 
 //
 
-export const Grouping = {
+export const Grouping: TableFeature = {
   getDefaultColumn: <
     TGenerics extends TableGenerics
   >(): GroupingColumnDef<TGenerics> => {
@@ -125,9 +119,10 @@ export const Grouping = {
     }
   },
 
-  getInitialState: (): GroupingTableState => {
+  getInitialState: (state): GroupingTableState => {
     return {
       grouping: [],
+      ...state,
     }
   },
 
@@ -145,13 +140,41 @@ export const Grouping = {
     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)
+          }
+
+          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()
+        }
+      },
     }
   },
 
@@ -196,55 +219,10 @@ export const Grouping = {
 
       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
-        )
-      },
-
-      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 (
@@ -269,7 +247,7 @@ export const Grouping = {
     instance: TableInstance<TGenerics>
   ): GroupingRow => {
     return {
-      getIsGrouped: () => instance.getRowIsGrouped(row.id),
+      getIsGrouped: () => !!row.groupingColumnId,
     }
   },
 
@@ -302,28 +280,28 @@ export const Grouping = {
       },
     }
   },
+}
 
-  orderColumns: <TGenerics extends TableGenerics>(
-    leafColumns: Column<TGenerics>[],
-    grouping: string[],
-    groupedColumnMode?: GroupingColumnMode
-  ) => {
-    if (!grouping?.length || !groupedColumnMode) {
-      return leafColumns
-    }
+export function orderColumns<TGenerics extends TableGenerics>(
+  leafColumns: Column<TGenerics>[],
+  grouping: string[],
+  groupedColumnMode?: GroupingColumnMode
+) {
+  if (!grouping?.length || !groupedColumnMode) {
+    return leafColumns
+  }
 
-    const nonGroupingColumns = leafColumns.filter(
-      col => !grouping.includes(col.id)
-    )
+  const nonGroupingColumns = leafColumns.filter(
+    col => !grouping.includes(col.id)
+  )
 
-    if (groupedColumnMode === 'remove') {
-      return nonGroupingColumns
-    }
+  if (groupedColumnMode === 'remove') {
+    return nonGroupingColumns
+  }
 
-    const groupingColumns = grouping
-      .map(g => leafColumns.find(col => col.id === g)!)
-      .filter(Boolean)
+  const groupingColumns = grouping
+    .map(g => leafColumns.find(col => col.id === g)!)
+    .filter(Boolean)
 
-    return [...groupingColumns, ...nonGroupingColumns]
-  },
+  return [...groupingColumns, ...nonGroupingColumns]
 }

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: '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: '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: '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: '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: '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: '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: '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: 'getRightFooterGroups',
+          key: process.env.NODE_ENV === 'development' && 'getRightFooterGroups',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -285,7 +263,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: 'getFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -301,7 +279,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: 'getLeftFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeftFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -317,7 +295,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: 'getCenterFlatHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getCenterFlatHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -333,7 +311,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: '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: '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: '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: 'getRightLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getRightLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }
@@ -395,7 +373,7 @@ export const Headers = {
             .flat()
         },
         {
-          key: 'getLeafHeaders',
+          key: process.env.NODE_ENV === 'development' && 'getLeafHeaders',
           debug: () =>
             instance.options.debugAll ?? instance.options.debugHeaders,
         }

package/src/features/Ordering.ts

@@ -6,9 +6,10 @@ import {
   Updater,
   Column,
   TableGenerics,
+  TableFeature,
 } from '../types'
 
-import { Grouping } from './Grouping'
+import { Grouping, orderColumns } from './Grouping'
 
 export type ColumnOrderTableState = {
   columnOrder: ColumnOrderState
@@ -34,10 +35,11 @@ export type ColumnOrderInstance<TGenerics extends TableGenerics> = {
 
 //
 
-export const Ordering = {
-  getInitialState: (): ColumnOrderTableState => {
+export const Ordering: TableFeature = {
+  getInitialState: (state): ColumnOrderTableState => {
     return {
       columnOrder: [],
+      ...state,
     }
   },
 
@@ -95,14 +97,10 @@ export const Ordering = {
             orderedColumns = [...orderedColumns, ...columnsCopy]
           }
 
-          return Grouping.orderColumns(
-            orderedColumns,
-            grouping,
-            groupedColumnMode
-          )
+          return orderColumns(orderedColumns, grouping, groupedColumnMode)
         },
         {
-          key: 'getOrderColumnsFn',
+          key: process.env.NODE_ENV === 'development' && 'getOrderColumnsFn',
           // debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),

package/src/features/Pagination.ts

@@ -59,13 +59,14 @@ export type PaginationInstance<TGenerics extends TableGenerics> = {
 //
 
 export const Pagination: TableFeature = {
-  getInitialState: (initialState): PaginationTableState => {
+  getInitialState: (state): PaginationTableState => {
     return {
+      ...state,
       pagination: {
         pageCount: -1,
         pageIndex: 0,
         pageSize: 10,
-        ...initialState?.pagination,
+        ...state?.pagination,
       },
     }
   },
@@ -183,7 +184,7 @@ export const Pagination: TableFeature = {
           return pageOptions
         },
         {
-          key: 'getPageOptions',
+          key: process.env.NODE_ENV === 'development' && 'getPageOptions',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
         }
       ),