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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.60",
+  "version": "8.0.0-alpha.63",
   "description": "Hooks for building lightweight, fast and extendable datagrids for React",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/react-table#readme",

package/src/core.ts

@@ -55,7 +55,7 @@ export type TableCore<TGenerics extends TableGenerics> = {
   options: RequiredKeys<TableOptions<TGenerics>, 'state'>
   setOptions: (newOptions: Updater<TableOptions<TGenerics>>) => void
   queue: (cb: () => void) => void
-  willUpdate: () => void
+  // willUpdate: () => void
   getState: () => TableState
   setState: (updater: Updater<TableState>) => void
   render: <TProps>(
@@ -125,7 +125,7 @@ export function createTableInstance<TGenerics extends TableGenerics>(
   } as TableState
 
   const queued: (() => void)[] = []
-  let queuedTimeout: ReturnType<typeof setTimeout>
+  let queuedTimeout = false
 
   const finalInstance: TableInstance<TGenerics> = {
     ...instance,
@@ -134,18 +134,27 @@ export function createTableInstance<TGenerics extends TableGenerics>(
     }, {}) as unknown as TableInstance<TGenerics>),
     queue: cb => {
       queued.push(cb)
+
       if (!queuedTimeout) {
-        queuedTimeout = setTimeout(() => {
-          instance.setState(old => ({ ...old }))
-        })
-      }
-    },
-    willUpdate: () => {
-      clearTimeout(queuedTimeout)
-      while (queued.length) {
-        queued.shift()!()
+        queuedTimeout = true
+
+        // Schedule a microtask to run the queued callbacks after
+        // the current call stack (render, etc) has finished.
+        Promise.resolve()
+          .then(() => {
+            while (queued.length) {
+              queued.shift()!()
+            }
+            queuedTimeout = false
+          })
+          .catch(error =>
+            setTimeout(() => {
+              throw error
+            })
+          )
       }
     },
+    // willUpdate: () => {},
     initialState,
     reset: () => {
       instance.setState(instance.initialState)

package/src/features/Expanding.ts

@@ -37,7 +37,7 @@ export type ExpandedOptions<TGenerics extends TableGenerics> = {
 }
 
 export type ExpandedInstance<TGenerics extends TableGenerics> = {
-  queueResetExpanded: () => void
+  _autoResetExpanded: () => void
   setExpanded: (updater: Updater<ExpandedState>) => void
   toggleRowExpanded: (rowId: string, expanded?: boolean) => void
   toggleAllRowsExpanded: (expanded?: boolean) => void
@@ -81,9 +81,7 @@ export const Expanding = {
     let registered = false
 
     return {
-      queueResetExpanded: () => {
-        instance.queueResetPageIndex()
-
+      _autoResetExpanded: () => {
         if (!registered) {
           registered = true
           return

package/src/features/Filters.ts

@@ -85,7 +85,6 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
   // Column
   manualColumnFiltering?: boolean
   onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
-  autoResetColumnFilters?: boolean
   enableColumnFilters?: boolean
   getColumnFilteredRowModel?: (
     instance: TableInstance<TGenerics>
@@ -94,7 +93,6 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
   manualGlobalFiltering?: boolean
   globalFilterFn?: FilterFnOption<TGenerics>
   onGlobalFilterChange?: OnChangeFn<any>
-  autoResetGlobalFilter?: boolean
   enableGlobalFilter?: boolean
   getGlobalFilteredRowModel?: (
     instance: TableInstance<TGenerics>
@@ -103,7 +101,6 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
 }
 
 export type FiltersInstance<TGenerics extends TableGenerics> = {
-  queueResetFilters: () => void
   getColumnAutoFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
 
   getColumnFilterFn: (columnId: string) => FilterFn<TGenerics> | undefined
@@ -159,9 +156,7 @@ export const Filters = {
     return {
       onColumnFiltersChange: makeStateUpdater('columnFilters', instance),
       onGlobalFilterChange: makeStateUpdater('globalFilter', instance),
-      autoResetColumnFilters: true,
       filterFromLeafRows: true,
-      autoResetGlobalFilter: true,
       globalFilterFn: 'auto',
       getColumnCanGlobalFilterFn: column => {
         const value = instance
@@ -235,35 +230,7 @@ export const Filters = {
   createInstance: <TGenerics extends TableGenerics>(
     instance: TableInstance<TGenerics>
   ): FiltersInstance<TGenerics> => {
-    let registered = false
-
     return {
-      queueResetFilters: () => {
-        instance.queueResetSorting()
-
-        if (!registered) {
-          registered = true
-          return
-        }
-
-        if (instance.options.autoResetAll === false) {
-          return
-        }
-
-        if (
-          instance.options.autoResetAll === true ||
-          instance.options.autoResetColumnFilters
-        ) {
-          instance.resetColumnFilters()
-        }
-
-        if (
-          instance.options.autoResetAll === true ||
-          instance.options.autoResetGlobalFilter
-        ) {
-          instance.resetGlobalFilter()
-        }
-      },
       getColumnAutoFilterFn: columnId => {
         const firstRow = instance.getCoreRowModel().flatRows[0]
 

package/src/features/Grouping.ts

@@ -76,7 +76,6 @@ export type GroupingCell<TGenerics extends TableGenerics> = {
 export type ColumnDefaultOptions = {
   // Column
   onGroupingChange: OnChangeFn<GroupingState>
-  autoResetGrouping: boolean
   enableGrouping: boolean
 }
 
@@ -84,7 +83,6 @@ export type GroupingOptions<TGenerics extends TableGenerics> = {
   manualGrouping?: boolean
   aggregationFns?: TGenerics['AggregationFns']
   onGroupingChange?: OnChangeFn<GroupingState>
-  autoResetGrouping?: boolean
   enableGrouping?: boolean
   enableGroupingRemoval?: boolean
   getGroupedRowModel?: (
@@ -97,7 +95,6 @@ export type GroupingOptions<TGenerics extends TableGenerics> = {
 export type GroupingColumnMode = false | 'reorder' | 'remove'
 
 export type GroupingInstance<TGenerics extends TableGenerics> = {
-  queueResetGrouping: () => void
   getColumnAutoAggregationFn: (
     columnId: string
   ) => AggregationFn<TGenerics> | undefined
@@ -139,7 +136,6 @@ export const Grouping = {
   ): GroupingOptions<TGenerics> => {
     return {
       onGroupingChange: makeStateUpdater('grouping', instance),
-      autoResetGrouping: true,
       groupedColumnMode: 'reorder',
     }
   },
@@ -162,28 +158,7 @@ export const Grouping = {
   createInstance: <TGenerics extends TableGenerics>(
     instance: TableInstance<TGenerics>
   ): GroupingInstance<TGenerics> => {
-    let registered = false
-
     return {
-      queueResetGrouping: () => {
-        instance.queueResetExpanded()
-
-        if (!registered) {
-          registered = true
-          return
-        }
-
-        if (instance.options.autoResetAll === false) {
-          return
-        }
-
-        if (
-          instance.options.autoResetAll === true ||
-          instance.options.autoResetGrouping
-        ) {
-          instance.resetGrouping()
-        }
-      },
       getColumnAutoAggregationFn: columnId => {
         const firstRow = instance.getCoreRowModel().flatRows[0]
 

package/src/features/Pagination.ts

@@ -37,7 +37,7 @@ export type PaginationDefaultOptions = {
 }
 
 export type PaginationInstance<TGenerics extends TableGenerics> = {
-  queueResetPageIndex: () => void
+  _autoResetPageIndex: () => void
   setPagination: (updater: Updater<PaginationState>) => void
   resetPagination: () => void
   setPageIndex: (updater: Updater<number>) => void
@@ -83,8 +83,9 @@ export const Pagination: TableFeature = {
     instance: TableInstance<TGenerics>
   ): PaginationInstance<TGenerics> => {
     let registered = false
+
     return {
-      queueResetPageIndex: () => {
+      _autoResetPageIndex: () => {
         if (!registered) {
           registered = true
           return

package/src/features/RowSelection.ts

@@ -16,7 +16,6 @@ export type RowSelectionTableState = {
 
 export type RowSelectionOptions<TGenerics extends TableGenerics> = {
   onRowSelectionChange?: OnChangeFn<RowSelectionState>
-  autoResetRowSelection?: boolean
   enableRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
   enableMultiRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
   enableSubRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
@@ -49,7 +48,6 @@ export type RowSelectionRow = {
 }
 
 export type RowSelectionInstance<TGenerics extends TableGenerics> = {
-  queueResetRowSelection: () => void
   getToggleRowSelectedHandler: (
     rowId: string
   ) => undefined | ((e: unknown) => void)
@@ -90,7 +88,6 @@ export const RowSelection = {
   ): RowSelectionOptions<TGenerics> => {
     return {
       onRowSelectionChange: makeStateUpdater('rowSelection', instance),
-      autoResetRowSelection: true,
       enableRowSelection: true,
       enableMultiRowSelection: true,
       enableSubRowSelection: true,
@@ -103,28 +100,7 @@ export const RowSelection = {
   createInstance: <TGenerics extends TableGenerics>(
     instance: TableInstance<TGenerics>
   ): RowSelectionInstance<TGenerics> => {
-    let registered = false
-
-    // const pageRows = instance.getPageRows()
-
     return {
-      queueResetRowSelection: () => {
-        if (!registered) {
-          registered = true
-          return
-        }
-
-        if (instance.options.autoResetAll === false) {
-          return
-        }
-
-        if (
-          instance.options.autoResetAll === true ||
-          instance.options.autoResetRowSelection
-        ) {
-          instance.resetRowSelection()
-        }
-      },
       setRowSelection: updater =>
         instance.options.onRowSelectionChange?.(updater),
       resetRowSelection: () =>
@@ -263,9 +239,6 @@ export const RowSelection = {
         {
           key: 'getSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
-          onChange: () => {
-            instance.queue(() => instance.queueResetExpanded())
-          },
         }
       ),
 
@@ -288,7 +261,6 @@ export const RowSelection = {
         {
           key: 'getFilteredSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
-          onChange: () => instance.queue(() => instance.queueResetExpanded()),
         }
       ),
 
@@ -308,7 +280,6 @@ export const RowSelection = {
         {
           key: 'getGroupedSelectedRowModel',
           debug: () => instance.options.debugAll ?? instance.options.debugTable,
-          onChange: () => instance.queue(() => instance.queueResetExpanded()),
         }
       ),
 

package/src/features/Sorting.ts

@@ -69,7 +69,6 @@ export type SortingOptions<TGenerics extends TableGenerics> = {
   manualSorting?: boolean
   sortingFns?: TGenerics['SortingFns']
   onSortingChange?: OnChangeFn<SortingState>
-  autoResetSorting?: boolean
   enableSorting?: boolean
   enableSortingRemoval?: boolean
   enableMultiRemove?: boolean
@@ -83,7 +82,6 @@ export type SortingOptions<TGenerics extends TableGenerics> = {
 }
 
 export type SortingInstance<TGenerics extends TableGenerics> = {
-  queueResetSorting: () => void
   getColumnAutoSortingFn: (columnId: string) => SortingFn<TGenerics> | undefined
   getColumnAutoSortDir: (columnId: string) => SortDirection
 
@@ -130,7 +128,6 @@ export const Sorting = {
   ): SortingOptions<TGenerics> => {
     return {
       onSortingChange: makeStateUpdater('sorting', instance),
-      autoResetSorting: true,
       isMultiSortEvent: (e: unknown) => {
         return (e as MouseEvent).shiftKey
       },
@@ -161,25 +158,6 @@ export const Sorting = {
     let registered = false
 
     return {
-      queueResetSorting: () => {
-        instance.queueResetGrouping()
-
-        if (!registered) {
-          registered = true
-          return
-        }
-
-        if (instance.options.autoResetAll === false) {
-          return
-        }
-
-        if (
-          instance.options.autoResetAll === true ||
-          instance.options.autoResetSorting
-        ) {
-          instance.resetSorting()
-        }
-      },
       getColumnAutoSortingFn: columnId => {
         const firstRows = instance
           .getGlobalFilteredRowModel()

package/src/utils/getColumnFilteredRowModelAsync.ts

@@ -110,7 +110,7 @@ export function getColumnFilteredRowModelAsync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetSorting()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getColumnFilteredRowModelSync.ts

@@ -94,7 +94,7 @@ export function getColumnFilteredRowModelSync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetSorting()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getCoreRowModelAsync.ts

@@ -96,8 +96,7 @@ export function getCoreRowModelAsync<TGenerics extends TableGenerics>(opts?: {
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetFilters()
-            instance.queueResetRowSelection()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getCoreRowModelSync.ts

@@ -98,8 +98,7 @@ export function getCoreRowModelSync<TGenerics extends TableGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetFilters()
-            instance.queueResetRowSelection()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getGlobalFilteredRowModelAsync.ts

@@ -88,7 +88,7 @@ export function getGlobalFilteredRowModelAsync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetSorting()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getGlobalFilteredRowModelSync.ts

@@ -71,7 +71,7 @@ export function getGlobalFilteredRowModelSync<
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetSorting()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getGroupedRowModel.ts

@@ -165,7 +165,8 @@ export function getGroupedRowModelSync<TGenerics extends TableGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetExpanded()
+            instance._autoResetExpanded()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getSortedRowModelAsync.ts

@@ -83,7 +83,7 @@ export function getSortedRowModelSync<TGenerics extends TableGenerics>(opts?: {
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetGrouping()
+            instance._autoResetPageIndex()
           })
         },
       }

package/src/utils/getSortedRowModelSync.ts

@@ -110,7 +110,7 @@ export function getSortedRowModelSync<TGenerics extends TableGenerics>(): (
         debug: () => instance.options.debugAll ?? instance.options.debugTable,
         onChange: () => {
           instance.queue(() => {
-            instance.queueResetGrouping()
+            instance._autoResetPageIndex()
           })
         },
       }