@tanstack/table-core 8.0.0-alpha.58 → 8.0.0-alpha.61

package/src/features/Sorting.ts

@@ -7,24 +7,14 @@ import {
 
 import {
   Column,
-  Getter,
-  Header,
   OnChangeFn,
   TableGenerics,
-  PropGetterValue,
   TableInstance,
   Row,
   Updater,
 } from '../types'
 
-import {
-  functionalUpdate,
-  isFunction,
-  makeStateUpdater,
-  memo,
-  Overwrite,
-  propGetter,
-} from '../utils'
+import { isFunction, makeStateUpdater, Overwrite } from '../utils'
 
 export type SortDirection = 'asc' | 'desc'
 
@@ -72,16 +62,13 @@ export type SortingColumn<TGenerics extends TableGenerics> = {
   getIsSorted: () => false | SortDirection
   resetSorting: () => void
   toggleSorting: (desc?: boolean, isMulti?: boolean) => void
-  getToggleSortingProps: <TGetter extends Getter<ToggleSortingProps>>(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleSortingProps, TGetter>
+  getToggleSortingHandler: () => undefined | ((event: unknown) => void)
 }
 
 export type SortingOptions<TGenerics extends TableGenerics> = {
   manualSorting?: boolean
   sortingFns?: TGenerics['SortingFns']
   onSortingChange?: OnChangeFn<SortingState>
-  autoResetSorting?: boolean
   enableSorting?: boolean
   enableSortingRemoval?: boolean
   enableMultiRemove?: boolean
@@ -94,13 +81,7 @@ export type SortingOptions<TGenerics extends TableGenerics> = {
   isMultiSortEvent?: (e: unknown) => boolean
 }
 
-export type ToggleSortingProps = {
-  title?: string
-  onClick?: (event: unknown) => void
-}
-
 export type SortingInstance<TGenerics extends TableGenerics> = {
-  queueResetSorting: () => void
   getColumnAutoSortingFn: (columnId: string) => SortingFn<TGenerics> | undefined
   getColumnAutoSortDir: (columnId: string) => SortDirection
 
@@ -117,10 +98,9 @@ export type SortingInstance<TGenerics extends TableGenerics> = {
   getColumnCanMultiSort: (columnId: string) => boolean
   getColumnIsSorted: (columnId: string) => false | 'asc' | 'desc'
   getColumnSortIndex: (columnId: string) => number
-  getToggleSortingProps: <TGetter extends Getter<ToggleSortingProps>>(
-    columnId: string,
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleSortingProps, TGetter>
+  getToggleSortingHandler: (
+    columnId: string
+  ) => undefined | ((event: unknown) => void)
   getPreSortedRowModel: () => RowModel<TGenerics>
   getSortedRowModel: () => RowModel<TGenerics>
   _getSortedRowModel?: () => RowModel<TGenerics>
@@ -148,7 +128,6 @@ export const Sorting = {
   ): SortingOptions<TGenerics> => {
     return {
       onSortingChange: makeStateUpdater('sorting', instance),
-      autoResetSorting: true,
       isMultiSortEvent: (e: unknown) => {
         return (e as MouseEvent).shiftKey
       },
@@ -168,8 +147,8 @@ export const Sorting = {
       resetSorting: () => instance.resetSorting(column.id),
       toggleSorting: (desc, isMulti) =>
         instance.toggleColumnSorting(column.id, desc, isMulti),
-      getToggleSortingProps: userProps =>
-        instance.getToggleSortingProps(column.id, userProps),
+      getToggleSortingHandler: () =>
+        instance.getToggleSortingHandler(column.id)!,
     }
   },
 
@@ -179,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()
@@ -416,7 +376,7 @@ export const Sorting = {
         }
       },
 
-      getToggleSortingProps: (columnId, userProps) => {
+      getToggleSortingHandler: columnId => {
         const column = instance.getColumn(columnId)
 
         if (!column) {
@@ -425,22 +385,16 @@ export const Sorting = {
 
         const canSort = column.getCanSort()
 
-        const initialProps: ToggleSortingProps = {
-          title: canSort ? 'Toggle Sorting' : undefined,
-          onClick: canSort
-            ? (e: unknown) => {
-                ;(e as any).persist?.()
-                column.toggleSorting?.(
-                  undefined,
-                  column.getCanMultiSort()
-                    ? instance.options.isMultiSortEvent?.(e)
-                    : false
-                )
-              }
-            : undefined,
+        return (e: unknown) => {
+          if (!canSort) return
+          ;(e as any).persist?.()
+          column.toggleSorting?.(
+            undefined,
+            column.getCanMultiSort()
+              ? instance.options.isMultiSortEvent?.(e)
+              : false
+          )
         }
-
-        return propGetter(initialProps, userProps)
       },
 
       getPreSortedRowModel: () => instance.getGlobalFilteredRowModel(),

package/src/features/Visibility.ts

@@ -1,15 +1,13 @@
 import {
   Cell,
   Column,
-  Getter,
   OnChangeFn,
   TableGenerics,
-  PropGetterValue,
   TableInstance,
   Updater,
   Row,
 } from '../types'
-import { makeStateUpdater, memo, propGetter } from '../utils'
+import { makeStateUpdater, memo } from '../utils'
 
 export type VisibilityOptions = {
   onColumnVisibilityChange?: OnChangeFn<VisibilityState>
@@ -39,16 +37,11 @@ export type VisibilityInstance<TGenerics extends TableGenerics> = {
   getColumnCanHide: (columnId: string) => boolean
   getIsAllColumnsVisible: () => boolean
   getIsSomeColumnsVisible: () => boolean
-  getToggleAllColumnsVisibilityProps: <
-    TGetter extends Getter<ToggleAllColumnsVisibilityProps>
-  >(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleAllColumnsVisibilityProps, TGetter>
+  getToggleAllColumnsVisibilityHandler: () =>
+    | undefined
+    | ((event: unknown) => void)
 }
 
-type ToggleVisibilityProps = {}
-type ToggleAllColumnsVisibilityProps = {}
-
 export type VisibilityColumnDef = {
   enableHiding?: boolean
   defaultCanHide?: boolean
@@ -64,9 +57,7 @@ export type VisibilityColumn = {
   getCanHide: () => boolean
   getIsVisible: () => boolean
   toggleVisibility: (value?: boolean) => void
-  getToggleVisibilityProps: <TGetter extends Getter<ToggleVisibilityProps>>(
-    userProps?: TGetter
-  ) => PropGetterValue<ToggleVisibilityProps, TGetter>
+  getToggleVisibilityHandler: () => (event: unknown) => void
 }
 
 //
@@ -101,19 +92,12 @@ export const Visibility = {
       getIsVisible: () => instance.getColumnIsVisible(column.id),
       toggleVisibility: value =>
         instance.toggleColumnVisibility(column.id, value),
-      getToggleVisibilityProps: userProps => {
-        const props: ToggleVisibilityProps = {
-          type: 'checkbox',
-          checked: column.getIsVisible?.(),
-          title: 'Toggle Column Visibility',
-          onChange: (e: unknown) => {
-            column.toggleVisibility?.(
-              ((e as MouseEvent).target as HTMLInputElement).checked
-            )
-          },
+      getToggleVisibilityHandler: () => {
+        return (e: unknown) => {
+          column.toggleVisibility?.(
+            ((e as MouseEvent).target as HTMLInputElement).checked
+          )
         }
-
-        return propGetter(props, userProps)
       },
     }
   },
@@ -265,24 +249,12 @@ export const Visibility = {
       getIsSomeColumnsVisible: () =>
         instance.getAllLeafColumns().some(column => column.getIsVisible?.()),
 
-      getToggleAllColumnsVisibilityProps: userProps => {
-        const props: ToggleAllColumnsVisibilityProps = {
-          onChange: (e: MouseEvent) => {
-            instance.toggleAllColumnsVisible(
-              (e.target as HTMLInputElement)?.checked
-            )
-          },
-          type: 'checkbox',
-          title: 'Toggle visibility for all columns',
-          checked: instance.getIsAllColumnsVisible(),
-          indeterminate:
-            !instance.getIsAllColumnsVisible() &&
-            instance.getIsSomeColumnsVisible()
-              ? 'indeterminate'
-              : undefined,
+      getToggleAllColumnsVisibilityHandler: () => {
+        return (e: unknown) => {
+          instance.toggleAllColumnsVisible(
+            ((e as MouseEvent).target as HTMLInputElement)?.checked
+          )
         }
-
-        return propGetter(props, userProps)
       },
     }
   },

package/src/filterFns.ts

@@ -7,6 +7,7 @@ export const filterFns = {
   equalsStringSensitive,
   arrIncludes,
   arrIncludesAll,
+  arrIncludesSome,
   equals,
   weakEquals,
   betweenNumberRange,
@@ -117,6 +118,25 @@ function arrIncludesAll<TGenerics extends TableGenerics>(
 
 arrIncludesAll.autoRemove = (val: any) => testFalsey(val) || !val?.length
 
+function arrIncludesSome<TGenerics extends TableGenerics>(
+  rows: Row<TGenerics>[],
+  columnIds: string[],
+  filterValue: unknown[]
+) {
+  return rows.filter(row => {
+    return columnIds.some(id => {
+      const rowValue = row.values[id]
+      return (
+        rowValue &&
+        rowValue.length &&
+        filterValue.some(val => rowValue.includes(val))
+      )
+    })
+  })
+}
+
+arrIncludesSome.autoRemove = (val: any) => testFalsey(val) || !val?.length
+
 function equals<TGenerics extends TableGenerics>(
   rows: Row<TGenerics>[],
   columnIds: string[],

package/src/types.ts

@@ -62,6 +62,7 @@ import {
   ColumnSizingTableState,
 } from './features/ColumnSizing'
 import {
+  PaginationInitialTableState,
   PaginationInstance,
   PaginationOptions,
   PaginationTableState,
@@ -85,19 +86,17 @@ export type TableGenerics = {
   FilterFns?: any
   SortingFns?: any
   AggregationFns?: any
-  Render?: any
+  Renderer?: any
+  Rendered?: any
   ColumnMeta?: any
   TableMeta?: any
 }
 
 export type AnyRender = (Comp: any, props: any) => any
 
-export type UseRenderer<TGenerics extends TableGenerics> =
-  TGenerics['Render'] extends (...args: any) => any ? TGenerics['Render'] : any
-
 export type TableFeature = {
   getDefaultOptions?: (instance: any) => any
-  getInitialState?: () => any
+  getInitialState?: (initialState?: InitialTableState) => any
   createInstance?: (instance: any) => any
   getDefaultColumn?: () => any
   createColumn?: (column: any, instance: any) => any
@@ -123,19 +122,20 @@ export type TableInstance<TGenerics extends TableGenerics> =
     PaginationInstance<TGenerics> &
     RowSelectionInstance<TGenerics>
 
-export type Options<TGenerics extends TableGenerics> = CoreOptions<TGenerics> &
-  ColumnsOptions<TGenerics> &
-  RowsOptions<TGenerics> &
-  VisibilityOptions &
-  ColumnOrderOptions &
-  ColumnPinningOptions &
-  FiltersOptions<TGenerics> &
-  SortingOptions<TGenerics> &
-  GroupingOptions<TGenerics> &
-  ExpandedOptions<TGenerics> &
-  ColumnSizingOptions &
-  PaginationOptions<TGenerics> &
-  RowSelectionOptions<TGenerics>
+export type TableOptions<TGenerics extends TableGenerics> =
+  CoreOptions<TGenerics> &
+    ColumnsOptions<TGenerics> &
+    RowsOptions<TGenerics> &
+    VisibilityOptions &
+    ColumnOrderOptions &
+    ColumnPinningOptions &
+    FiltersOptions<TGenerics> &
+    SortingOptions<TGenerics> &
+    GroupingOptions<TGenerics> &
+    ExpandedOptions<TGenerics> &
+    ColumnSizingOptions &
+    PaginationOptions<TGenerics> &
+    RowSelectionOptions<TGenerics>
 
 export type TableState = CoreTableState &
   VisibilityTableState &
@@ -149,6 +149,20 @@ export type TableState = CoreTableState &
   PaginationTableState &
   RowSelectionTableState
 
+export type InitialTableState = Partial<
+  CoreTableState &
+    VisibilityTableState &
+    ColumnOrderTableState &
+    ColumnPinningTableState &
+    FiltersTableState &
+    SortingTableState &
+    ExpandedTableState &
+    GroupingTableState &
+    ColumnSizingTableState &
+    PaginationInitialTableState &
+    RowSelectionTableState
+>
+
 export type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> &
   CellsRow<TGenerics> &
   VisibilityRow<TGenerics> &
@@ -171,7 +185,7 @@ export type AccessorFn<TData> = (originalRow: TData, index: number) => any
 
 export type Renderable<TGenerics extends TableGenerics, TProps> =
   | string
-  | ((props: TProps) => ReturnType<UseRenderer<TGenerics>>)
+  | ((props: TProps) => TGenerics['Rendered'])
 
 export type ColumnDef<TGenerics extends TableGenerics> =
   CoreColumnDef<TGenerics> &
@@ -201,8 +215,7 @@ export type CoreCell<TGenerics extends TableGenerics> = {
   value: TGenerics['Value']
   row: Row<TGenerics>
   column: Column<TGenerics>
-  getCellProps: PropGetter<CellProps>
-  renderCell: () => string | null | ReturnType<UseRenderer<TGenerics>>
+  renderCell: () => string | null | TGenerics['Rendered']
 }
 
 export type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> &
@@ -219,25 +232,21 @@ export type CoreHeader<TGenerics extends TableGenerics> = {
   subHeaders: Header<TGenerics>[]
   colSpan?: number
   rowSpan?: number
-  getHeaderProps: PropGetter<HeaderProps>
-  getFooterProps: PropGetter<HeaderProps>
   getLeafHeaders: () => Header<TGenerics>[]
   isPlaceholder?: boolean
   placeholderId?: string
   renderHeader: (options?: {
     renderPlaceholder?: boolean
-  }) => string | null | ReturnType<UseRenderer<TGenerics>>
+  }) => string | null | TGenerics['Rendered']
   renderFooter: (options?: {
     renderPlaceholder?: boolean
-  }) => string | null | ReturnType<UseRenderer<TGenerics>>
+  }) => string | null | TGenerics['Rendered']
 }
 
 export type HeaderGroup<TGenerics extends TableGenerics> = {
   id: string
   depth: number
   headers: Header<TGenerics>[]
-  getHeaderGroupProps: PropGetter<HeaderGroupProps>
-  getFooterGroupProps: PropGetter<FooterGroupProps>
 }
 
 export type HeaderRenderProps<THeader> = {
@@ -253,75 +262,4 @@ export type CellRenderProps<TCell, TRow> = {
   row: TRow
 }
 
-export type TableProps = {
-  role: string
-}
-
-export type TableBodyProps = {
-  role: string
-}
-
-export type TableHeadProps = {
-  key: string
-  role: string
-}
-
-export type TableFooterProps = {
-  key: string
-  role: string
-}
-
-export type HeaderGroupProps = {
-  key: string
-  role: string
-}
-
-export type FooterGroupProps = {
-  key: string
-  role: string
-}
-
-export type HeaderProps = {
-  key: string
-  role: string
-  colSpan?: number
-  rowSpan?: number
-}
-
-export type FooterProps = {
-  key: string
-  role: string
-  colSpan?: number
-  rowSpan?: number
-}
-
-export type RowProps = {
-  key: string
-  role: string
-}
-
-export type CellProps = {
-  key: string
-  role: string
-}
-
-//
-
-export type PropGetter<TBase> = <TGetter extends Getter<TBase>>(
-  userProps?: TGetter
-) => PropGetterValue<TBase, TGetter>
-
-export type Getter<TInitial> =
-  | ((initial: TInitial) => object)
-  | object
-  | undefined
-
-export type PropGetterValue<TBase, TGetter> = TGetter extends undefined
-  ? TBase
-  : TGetter extends (...args: any[]) => infer TReturn
-  ? Overwrite<TBase, TReturn>
-  : TGetter extends object
-  ? Overwrite<TBase, TGetter>
-  : never
-
 export type NoInfer<A extends any> = [A][A extends any ? 0 : never]

package/src/utils/getColumnFilteredRowModelAsync.ts

@@ -1,9 +1,5 @@
 import { TableInstance, RowModel, TableGenerics, Row } from '../types'
-import { incrementalMemo, memo } from '../utils'
-import {
-  filterRowModelFromLeafs,
-  filterRowModelFromRoot,
-} from './filterRowsUtils'
+import { incrementalMemo } from '../utils'
 
 export function getColumnFilteredRowModelAsync<
   TGenerics extends TableGenerics
@@ -114,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

@@ -1,9 +1,5 @@
-import { TableInstance, RowModel, TableGenerics, Row } from '../types'
-import { incrementalMemo, memo } from '../utils'
-import {
-  filterRowModelFromLeafs,
-  filterRowModelFromRoot,
-} from './filterRowsUtils'
+import { TableInstance, RowModel, TableGenerics } from '../types'
+import { incrementalMemo } from '../utils'
 
 export function getGlobalFilteredRowModelAsync<
   TGenerics extends TableGenerics
@@ -92,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

@@ -1,5 +1,4 @@
 import { TableInstance, Row, RowModel, TableGenerics } from '../types'
-import { SortingFn } from '../features/Sorting'
 import { incrementalMemo, memo } from '../utils'
 
 export function getSortedRowModelSync<TGenerics extends TableGenerics>(opts?: {
@@ -84,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()
           })
         },
       }

package/src/utils.ts

@@ -1,6 +1,5 @@
-import { Getter, NoInfer, PropGetterValue, TableState, Updater } from './types'
+import { NoInfer, TableState, Updater } from './types'
 
-export type IsAny<T> = 0 extends 1 & T ? true : false
 export type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 export type RequiredKeys<T, K extends keyof T> = Omit<T, K> &
   Required<Pick<T, K>>
@@ -12,15 +11,6 @@ export type Overwrite<T, U extends { [TKey in keyof T]?: any }> = Omit<
 
 export type IfDefined<T, N> = 0 extends 1 & T ? N : T extends {} ? T : N
 
-// export type DefinedGenericKeys<T extends TableGenerics> = {
-//   [K in keyof T]: 0 extends 1 & T[K] ? never : T[K] extends {} ? K : never
-// }[keyof T]
-
-// export type DefinedGenerics<T extends TableGenerics> = Pick<
-//   T,
-//   DefinedGenericKeys<T>
-// >
-
 export function functionalUpdate<T>(updater: Updater<T>, input: T): T {
   return typeof updater === 'function'
     ? (updater as (input: T) => T)(input)
@@ -98,23 +88,6 @@ export function flattenBy<TNode>(
   return flat
 }
 
-type PropGetterImpl = <TBaseProps, TGetter extends Getter<TBaseProps>>(
-  initial: TBaseProps,
-  userProps?: TGetter
-) => PropGetterValue<TBaseProps, TGetter>
-
-// @ts-ignore // Just rely on the type, not the implementation
-export const propGetter: PropGetterImpl = (initial, getter) => {
-  if (isFunction(getter)) {
-    return getter(initial)
-  }
-
-  return {
-    ...initial,
-    ...(getter ?? {}),
-  }
-}
-
 export function memo<TDeps extends readonly any[], TResult>(
   getDeps: () => [...TDeps],
   fn: (...args: NoInfer<[...TDeps]>) => TResult,