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

package/package.json

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

package/src/features/ColumnSizing.ts

@@ -46,8 +46,8 @@ export type ColumnSizingDefaultOptions = {
 export type ColumnSizingInstance<TGenerics extends TableGenerics> = {
   setColumnSizing: (updater: Updater<ColumnSizingState>) => void
   setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void
-  resetColumnSizing: () => void
-  resetHeaderSizeInfo: () => void
+  resetColumnSizing: (defaultState?: boolean) => void
+  resetHeaderSizeInfo: (defaultState?: boolean) => void
   getTotalSize: () => number
   getLeftTotalSize: () => number
   getCenterTotalSize: () => number
@@ -83,6 +83,15 @@ export const defaultColumnSizing = {
   maxSize: Number.MAX_SAFE_INTEGER,
 }
 
+const getDefaultColumnSizingInfoState = (): ColumnSizingInfoState => ({
+  startOffset: null,
+  startSize: null,
+  deltaOffset: null,
+  deltaPercentage: null,
+  isResizingColumn: false,
+  columnSizingStart: [],
+})
+
 export const ColumnSizing: TableFeature = {
   getDefaultColumn: (): ColumnSizingColumnDef => {
     return defaultColumnSizing
@@ -90,14 +99,7 @@ export const ColumnSizing: TableFeature = {
   getInitialState: (state): ColumnSizingTableState => {
     return {
       columnSizing: {},
-      columnSizingInfo: {
-        startOffset: null,
-        startSize: null,
-        deltaOffset: null,
-        deltaPercentage: null,
-        isResizingColumn: false,
-        columnSizingStart: [],
-      },
+      columnSizingInfo: getDefaultColumnSizingInfoState(),
       ...state,
     }
   },
@@ -353,12 +355,17 @@ export const ColumnSizing: TableFeature = {
         instance.options.onColumnSizingChange?.(updater),
       setColumnSizingInfo: updater =>
         instance.options.onColumnSizingInfoChange?.(updater),
-      resetColumnSizing: () => {
-        instance.setColumnSizing(instance.initialState.columnSizing ?? {})
+      resetColumnSizing: defaultState => {
+        instance.setColumnSizing(
+          defaultState ? {} : instance.initialState.columnSizing ?? {}
+        )
       },
-      resetHeaderSizeInfo: () => {
+      resetHeaderSizeInfo: defaultState => {
         instance.setColumnSizingInfo(
-          instance.initialState.columnSizingInfo ?? {}
+          defaultState
+            ? getDefaultColumnSizingInfoState()
+            : instance.initialState.columnSizingInfo ??
+                getDefaultColumnSizingInfoState()
         )
       },
       getTotalSize: () =>

package/src/features/Expanding.ts

@@ -41,7 +41,7 @@ export type ExpandedInstance<TGenerics extends TableGenerics> = {
   _autoResetExpanded: () => void
   setExpanded: (updater: Updater<ExpandedState>) => void
   toggleAllRowsExpanded: (expanded?: boolean) => void
-  resetExpanded: () => void
+  resetExpanded: (defaultState?: boolean) => void
   getCanSomeRowsExpand: () => boolean
   getToggleAllRowsExpandedHandler: () => (event: unknown) => void
   getIsSomeRowsExpanded: () => boolean
@@ -104,8 +104,10 @@ export const Expanding: TableFeature = {
           instance.setExpanded({})
         }
       },
-      resetExpanded: () => {
-        instance.setExpanded(instance.initialState?.expanded ?? {})
+      resetExpanded: defaultState => {
+        instance.setExpanded(
+          defaultState ? {} : instance.initialState?.expanded ?? {}
+        )
       },
       getCanSomeRowsExpand: () => {
         return instance.getRowModel().flatRows.some(row => row.getCanExpand())

package/src/features/Filters.ts

@@ -131,7 +131,7 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
 export type FiltersInstance<TGenerics extends TableGenerics> = {
   setColumnFilters: (updater: Updater<ColumnFiltersState>) => void
 
-  resetColumnFilters: () => void
+  resetColumnFilters: (defaultState?: boolean) => void
 
   // Column Filters
   getPreFilteredRowModel: () => RowModel<TGenerics>
@@ -140,7 +140,7 @@ export type FiltersInstance<TGenerics extends TableGenerics> = {
 
   // Global Filters
   setGlobalFilter: (updater: Updater<any>) => void
-  resetGlobalFilter: () => void
+  resetGlobalFilter: (defaultState?: boolean) => void
   getGlobalAutoFilterFn: () => FilterFn<TGenerics> | undefined
   getGlobalFilterFn: () => FilterFn<TGenerics> | undefined
   getGlobalFacetedRowModel: () => RowModel<TGenerics>
@@ -398,12 +398,16 @@ export const Filters: TableFeature = {
         instance.options.onGlobalFilterChange?.(updater)
       },
 
-      resetGlobalFilter: () => {
-        instance.setGlobalFilter(instance.initialState.globalFilter)
+      resetGlobalFilter: defaultState => {
+        instance.setGlobalFilter(
+          defaultState ? undefined : instance.initialState.globalFilter
+        )
       },
 
-      resetColumnFilters: () => {
-        instance.setColumnFilters(instance.initialState?.columnFilters ?? [])
+      resetColumnFilters: defaultState => {
+        instance.setColumnFilters(
+          defaultState ? [] : instance.initialState?.columnFilters ?? []
+        )
       },
 
       getPreFilteredRowModel: () => instance.getCoreRowModel(),

package/src/features/Grouping.ts

@@ -99,7 +99,7 @@ export type GroupingColumnMode = false | 'reorder' | 'remove'
 
 export type GroupingInstance<TGenerics extends TableGenerics> = {
   setGrouping: (updater: Updater<GroupingState>) => void
-  resetGrouping: () => void
+  resetGrouping: (defaultState?: boolean) => void
   getPreGroupedRowModel: () => RowModel<TGenerics>
   getGroupedRowModel: () => RowModel<TGenerics>
   _getGroupedRowModel?: () => RowModel<TGenerics>
@@ -214,8 +214,10 @@ export const Grouping: TableFeature = {
     return {
       setGrouping: updater => instance.options.onGroupingChange?.(updater),
 
-      resetGrouping: () => {
-        instance.setGrouping(instance.initialState?.grouping ?? [])
+      resetGrouping: defaultState => {
+        instance.setGrouping(
+          defaultState ? [] : instance.initialState?.grouping ?? []
+        )
       },
 
       getPreGroupedRowModel: () => instance.getSortedRowModel(),

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(
         () => [

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 => {

package/src/features/Pinning.ts

@@ -49,7 +49,7 @@ export type ColumnPinningRow<TGenerics extends TableGenerics> = {
 
 export type ColumnPinningInstance<TGenerics extends TableGenerics> = {
   setColumnPinning: (updater: Updater<ColumnPinningState>) => void
-  resetColumnPinning: () => void
+  resetColumnPinning: (defaultState?: boolean) => void
   getIsSomeColumnsPinned: () => boolean
   getLeftLeafColumns: () => Column<TGenerics>[]
   getRightLeafColumns: () => Column<TGenerics>[]
@@ -58,13 +58,15 @@ export type ColumnPinningInstance<TGenerics extends TableGenerics> = {
 
 //
 
+const getDefaultPinningState = (): ColumnPinningState => ({
+  left: [],
+  right: [],
+})
+
 export const Pinning: TableFeature = {
   getInitialState: (state): ColumnPinningTableState => {
     return {
-      columnPinning: {
-        left: [],
-        right: [],
-      },
+      columnPinning: getDefaultPinningState(),
       ...state,
     }
   },
@@ -220,8 +222,12 @@ export const Pinning: TableFeature = {
       setColumnPinning: updater =>
         instance.options.onColumnPinningChange?.(updater),
 
-      resetColumnPinning: () =>
-        instance.setColumnPinning(instance.initialState?.columnPinning ?? {}),
+      resetColumnPinning: defaultState =>
+        instance.setColumnPinning(
+          defaultState
+            ? getDefaultPinningState()
+            : instance.initialState?.columnPinning ?? getDefaultPinningState()
+        ),
 
       getIsSomeColumnsPinned: () => {
         const { left, right } = instance.getState().columnPinning

package/src/features/RowSelection.ts

@@ -53,7 +53,7 @@ export type RowSelectionInstance<TGenerics extends TableGenerics> = {
   getToggleAllRowsSelectedHandler: () => (event: unknown) => void
   getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void
   setRowSelection: (updater: Updater<RowSelectionState>) => void
-  resetRowSelection: () => void
+  resetRowSelection: (defaultState?: boolean) => void
   getIsAllRowsSelected: () => boolean
   getIsAllPageRowsSelected: () => boolean
   getIsSomeRowsSelected: () => boolean
@@ -96,8 +96,10 @@ export const RowSelection: TableFeature = {
     return {
       setRowSelection: updater =>
         instance.options.onRowSelectionChange?.(updater),
-      resetRowSelection: () =>
-        instance.setRowSelection(instance.initialState.rowSelection ?? {}),
+      resetRowSelection: defaultState =>
+        instance.setRowSelection(
+          defaultState ? {} : instance.initialState.rowSelection ?? {}
+        ),
       toggleAllRowsSelected: value => {
         instance.setRowSelection(old => {
           value =

package/src/features/Sorting.ts

@@ -62,7 +62,7 @@ export type SortingColumn<TGenerics extends TableGenerics> = {
   getCanMultiSort: () => boolean
   getSortIndex: () => number
   getIsSorted: () => false | SortDirection
-  resetSorting: () => void
+  clearSorting: () => void
   toggleSorting: (desc?: boolean, isMulti?: boolean) => void
   getToggleSortingHandler: () => undefined | ((event: unknown) => void)
 }
@@ -85,6 +85,7 @@ export type SortingOptions<TGenerics extends TableGenerics> = {
 
 export type SortingInstance<TGenerics extends TableGenerics> = {
   setSorting: (updater: Updater<SortingState>) => void
+  resetSorting: (defaultState?: boolean) => void
   getPreSortedRowModel: () => RowModel<TGenerics>
   getSortedRowModel: () => RowModel<TGenerics>
   _getSortedRowModel?: () => RowModel<TGenerics>
@@ -304,14 +305,11 @@ export const Sorting: TableFeature = {
       getSortIndex: () =>
         instance.getState().sorting?.findIndex(d => d.id === column.id) ?? -1,
 
-      resetSorting: (columnId?: string) => {
-        if (columnId) {
-          instance.setSorting(old =>
-            old?.length ? old.filter(d => d.id !== columnId) : []
-          )
-        } else {
-          instance.setSorting(instance.initialState?.sorting ?? [])
-        }
+      clearSorting: () => {
+        //clear sorting for just 1 column
+        instance.setSorting(old =>
+          old?.length ? old.filter(d => d.id !== column.id) : []
+        )
       },
 
       getToggleSortingHandler: () => {
@@ -338,7 +336,11 @@ export const Sorting: TableFeature = {
 
     return {
       setSorting: updater => instance.options.onSortingChange?.(updater),
-
+      resetSorting: defaultState => {
+        instance.setSorting(
+          defaultState ? [] : instance.initialState?.sorting ?? []
+        )
+      },
       getPreSortedRowModel: () => instance.getFilteredRowModel(),
       getSortedRowModel: () => {
         if (

package/src/features/Visibility.ts

@@ -32,6 +32,7 @@ export type VisibilityInstance<TGenerics extends TableGenerics> = {
   getRightVisibleLeafColumns: () => Column<TGenerics>[]
   getCenterVisibleLeafColumns: () => Column<TGenerics>[]
   setColumnVisibility: (updater: Updater<VisibilityState>) => void
+  resetColumnVisibility: (defaultState?: boolean) => void
   toggleAllColumnsVisible: (value?: boolean) => void
   getIsAllColumnsVisible: () => boolean
   getIsSomeColumnsVisible: () => boolean
@@ -202,6 +203,12 @@ export const Visibility: TableFeature = {
       setColumnVisibility: updater =>
         instance.options.onColumnVisibilityChange?.(updater),
 
+      resetColumnVisibility: defaultState => {
+        instance.setColumnVisibility(
+          defaultState ? {} : instance.initialState.columnVisibility ?? {}
+        )
+      },
+
       toggleAllColumnsVisible: value => {
         value = value ?? !instance.getIsAllColumnsVisible()