@tanstack/table-core 8.0.0-alpha.82 → 8.0.0-alpha.83

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-alpha.82",
+  "version": "8.0.0-alpha.83",
   "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

@@ -2,7 +2,7 @@ import { functionalUpdate, RequiredKeys } from './utils'
 
 import {
   Updater,
-  TableOptions,
+  TableOptionsResolved,
   TableState,
   TableInstance,
   Renderable,
@@ -52,8 +52,8 @@ export type CoreInstance<TGenerics extends TableGenerics> = {
   // generics: TGenerics
   initialState: TableState
   reset: () => void
-  options: RequiredKeys<TableOptions<TGenerics>, 'state'>
-  setOptions: (newOptions: Updater<TableOptions<TGenerics>>) => void
+  options: RequiredKeys<TableOptionsResolved<TGenerics>, 'state'>
+  setOptions: (newOptions: Updater<TableOptionsResolved<TGenerics>>) => void
   getState: () => TableState
   setState: (updater: Updater<TableState>) => void
   _queue: (cb: () => void) => void
@@ -89,7 +89,7 @@ export type CoreInstance<TGenerics extends TableGenerics> = {
 // }
 
 export function createTableInstance<TGenerics extends TableGenerics>(
-  options: TableOptions<TGenerics>
+  options: TableOptionsResolved<TGenerics>
 ): TableInstance<TGenerics> {
   if (options.debugAll || options.debugTable) {
     console.info('Creating Table Instance...')
@@ -116,9 +116,9 @@ export function createTableInstance<TGenerics extends TableGenerics>(
 
   const defaultOptions = instance._features.reduce((obj, feature) => {
     return Object.assign(obj, feature.getDefaultOptions?.(instance))
-  }, {}) as TableOptions<TGenerics>
+  }, {}) as TableOptionsResolved<TGenerics>
 
-  const mergeOptions = (options: TableOptions<TGenerics>) => {
+  const mergeOptions = (options: TableOptionsResolved<TGenerics>) => {
     if (instance.options.mergeOptions) {
       return instance.options.mergeOptions(defaultOptions, options)
     }

package/src/createTable.ts

@@ -6,6 +6,7 @@ import {
   AccessorFn,
   AnyRender,
   TableGenerics,
+  TableOptionsResolved,
   TableOptions,
 } from './types'
 import { IfDefined, Overwrite } from './utils'
@@ -26,15 +27,15 @@ export type CreateTableOptions<
     sortingFns?: TSortingFns
     aggregationFns?: TAggregationFns
   } & Omit<
-    TableOptions<TGenerics>,
+    TableOptionsResolved<TGenerics>,
     'filterFns' | 'sortingFns' | 'aggregationFns'
   >
 >
 
 export type Table<TGenerics extends TableGenerics> = {
   generics: TGenerics
-  options: Partial<TableOptions<TGenerics>>
-  setGenerics: <T extends TableGenerics>() => Table<T>
+  options: Partial<TableOptionsResolved<TGenerics>>
+  // setGenerics: <T extends TableGenerics>() => Table<T>
   setRowType: <TRow>() => Table<Overwrite<TGenerics, { Row: TRow }>>
   setTableMetaType: <TTableMeta>() => Table<
     Overwrite<TGenerics, { TableMeta: TTableMeta }>
@@ -119,6 +120,7 @@ export type Table<TGenerics extends TableGenerics> = {
       }
     >
   ) => ColumnDef<TGenerics>
+  createOptions: (options: TableOptions<TGenerics>) => TableOptions<TGenerics>
 }
 
 //
@@ -143,7 +145,7 @@ function createTable<TGenerics extends TableGenerics>(
         throw new Error('')
       })(),
     },
-    setGenerics: () => table as any,
+    // setGenerics: () => table as any,
     setRowType: () => table as any,
     setTableMetaType: () => table as any,
     setColumnMetaType: () => table as any,
@@ -179,6 +181,7 @@ function createTable<TGenerics extends TableGenerics>(
 
       throw new Error('Invalid accessor')
     },
+    createOptions: options => options,
   }
 
   return table

package/src/features/Cells.ts

@@ -74,8 +74,8 @@ export const Cells = {
           column,
           getValue: () => row.getValue(columnId),
           renderCell: () =>
-            column.cell
-              ? instance._render(column.cell, {
+            column.columnDef.cell
+              ? instance._render(column.columnDef.cell, {
                   instance,
                   column,
                   row,

package/src/features/ColumnSizing.ts

@@ -93,7 +93,7 @@ const getDefaultColumnSizingInfoState = (): ColumnSizingInfoState => ({
 })
 
 export const ColumnSizing: TableFeature = {
-  getDefaultColumn: (): ColumnSizingColumnDef => {
+  getDefaultColumnDef: (): ColumnSizingColumnDef => {
     return defaultColumnSizing
   },
   getInitialState: (state): ColumnSizingTableState => {
@@ -124,10 +124,10 @@ export const ColumnSizing: TableFeature = {
 
         return Math.min(
           Math.max(
-            column.minSize ?? defaultColumnSizing.minSize,
-            columnSize ?? column.size ?? defaultColumnSizing.size
+            column.columnDef.minSize ?? defaultColumnSizing.minSize,
+            columnSize ?? column.columnDef.size ?? defaultColumnSizing.size
           ),
-          column.maxSize ?? defaultColumnSizing.maxSize
+          column.columnDef.maxSize ?? defaultColumnSizing.maxSize
         )
       },
       getStart: position => {
@@ -156,7 +156,7 @@ export const ColumnSizing: TableFeature = {
       },
       getCanResize: () => {
         return (
-          (column.enableResizing ?? true) &&
+          (column.columnDef.enableResizing ?? true) &&
           (instance.options.enableColumnResizing ?? true)
         )
       },

package/src/features/Columns.ts

@@ -61,11 +61,11 @@ export type CoreColumn<TGenerics extends TableGenerics> = {
 
 export type ColumnsOptions<TGenerics extends TableGenerics> = {
   columns: ColumnDef<TGenerics>[]
-  defaultColumn?: Partial<ColumnDef<TGenerics>>
+  defaultColumnDef?: Partial<ColumnDef<TGenerics>>
 }
 
 export type ColumnsInstance<TGenerics extends TableGenerics> = {
-  getDefaultColumn: () => Partial<ColumnDef<TGenerics>>
+  getDefaultColumnDef: () => Partial<ColumnDef<TGenerics>>
   getColumnDefs: () => ColumnDef<TGenerics>[]
   createColumn: (
     columnDef: ColumnDef<TGenerics>,
@@ -86,8 +86,8 @@ export const Columns = {
     instance: TableInstance<TGenerics>
   ): ColumnsInstance<TGenerics> => {
     return {
-      getDefaultColumn: memo(
-        () => [instance.options.defaultColumn],
+      getDefaultColumnDef: memo(
+        () => [instance.options.defaultColumnDef],
         defaultColumn => {
           defaultColumn = (defaultColumn ?? {}) as Partial<ColumnDef<TGenerics>>
 
@@ -96,7 +96,7 @@ export const Columns = {
             footer: props => props.header.column.id,
             cell: props => props.getValue().toString?.() ?? null,
             ...instance._features.reduce((obj, feature) => {
-              return Object.assign(obj, feature.getDefaultColumn?.())
+              return Object.assign(obj, feature.getDefaultColumnDef?.())
             }, {}),
             ...defaultColumn,
           } as Partial<ColumnDef<TGenerics>>
@@ -104,7 +104,7 @@ export const Columns = {
         {
           debug: () =>
             instance.options.debugAll ?? instance.options.debugColumns,
-          key: process.env.NODE_ENV === 'development' && 'getDefaultColumn',
+          key: process.env.NODE_ENV === 'development' && 'getDefaultColumnDef',
         }
       ),
 
@@ -115,7 +115,12 @@ export const Columns = {
         depth: number,
         parent
       ) => {
-        const defaultColumn = instance.getDefaultColumn()
+        const defaultColumnDef = instance.getDefaultColumnDef()
+
+        columnDef = {
+          ...defaultColumnDef,
+          ...columnDef,
+        }
 
         let id =
           columnDef.id ??
@@ -143,7 +148,6 @@ export const Columns = {
         }
 
         let column: CoreColumn<TGenerics> = {
-          ...defaultColumn,
           ...columnDef,
           id: `${id}`,
           accessorFn,

package/src/features/Filters.ts

@@ -161,7 +161,7 @@ export type FiltersInstance<TGenerics extends TableGenerics> = {
 //
 
 export const Filters: TableFeature = {
-  getDefaultColumn: <
+  getDefaultColumnDef: <
     TGenerics extends TableGenerics
   >(): FiltersColumnDef<TGenerics> => {
     return {
@@ -217,6 +217,10 @@ export const Filters: TableFeature = {
           return filterFns.inNumberRange
         }
 
+        if (typeof value === 'boolean') {
+          return filterFns.equals
+        }
+
         if (value !== null && typeof value === 'object') {
           return filterFns.equals
         }
@@ -243,7 +247,7 @@ export const Filters: TableFeature = {
       },
       getCanFilter: () => {
         return (
-          (column.enableColumnFilter ?? true) &&
+          (column.columnDef.enableColumnFilter ?? true) &&
           (instance.options.enableColumnFilters ?? true) &&
           (instance.options.enableFilters ?? true) &&
           !!column.accessorFn
@@ -252,7 +256,7 @@ export const Filters: TableFeature = {
 
       getCanGlobalFilter: () => {
         return (
-          (column.enableGlobalFilter ?? true) &&
+          (column.columnDef.enableGlobalFilter ?? true) &&
           (instance.options.enableGlobalFilter ?? true) &&
           (instance.options.enableFilters ?? true) &&
           (instance.options.getColumnCanGlobalFilter?.(column) ?? true) &&

package/src/features/Grouping.ts

@@ -108,7 +108,7 @@ export type GroupingInstance<TGenerics extends TableGenerics> = {
 //
 
 export const Grouping: TableFeature = {
-  getDefaultColumn: <
+  getDefaultColumnDef: <
     TGenerics extends TableGenerics
   >(): GroupingColumnDef<TGenerics> => {
     return {
@@ -150,7 +150,7 @@ export const Grouping: TableFeature = {
 
       getCanGroup: () => {
         return (
-          column.enableGrouping ??
+          column.columnDef.enableGrouping ??
           true ??
           instance.options.enableGrouping ??
           true ??
@@ -264,7 +264,8 @@ export const Grouping: TableFeature = {
         !cell.getIsPlaceholder() &&
         row.subRows?.length > 1,
       renderAggregatedCell: () => {
-        const template = column.aggregatedCell ?? column.cell
+        const template =
+          column.columnDef.aggregatedCell ?? column.columnDef.cell
 
         return template
           ? instance._render(template, {

package/src/features/Headers.ts

@@ -87,16 +87,16 @@ export const Headers = {
             return leafHeaders as Header<TGenerics>[]
           },
           renderHeader: () =>
-            column.header
-              ? instance._render(column.header, {
+            column.columnDef.header
+              ? instance._render(column.columnDef.header, {
                   instance,
                   header: header as Header<TGenerics>,
                   column,
                 })
               : null,
           renderFooter: () =>
-            column.footer
-              ? instance._render(column.footer, {
+            column.columnDef.footer
+              ? instance._render(column.columnDef.footer, {
                   instance,
                   header: header as Header<TGenerics>,
                   column,

package/src/features/Pinning.ts

@@ -50,7 +50,7 @@ export type ColumnPinningRow<TGenerics extends TableGenerics> = {
 export type ColumnPinningInstance<TGenerics extends TableGenerics> = {
   setColumnPinning: (updater: Updater<ColumnPinningState>) => void
   resetColumnPinning: (defaultState?: boolean) => void
-  getIsSomeColumnsPinned: () => boolean
+  getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean
   getLeftLeafColumns: () => Column<TGenerics>[]
   getRightLeafColumns: () => Column<TGenerics>[]
   getCenterLeafColumns: () => Column<TGenerics>[]
@@ -123,7 +123,7 @@ export const Pinning: TableFeature = {
 
         return leafColumns.some(
           d =>
-            (d.enablePinning ?? true) &&
+            (d.columnDef.enablePinning ?? true) &&
             (instance.options.enablePinning ?? true)
         )
       },
@@ -229,10 +229,15 @@ export const Pinning: TableFeature = {
             : instance.initialState?.columnPinning ?? getDefaultPinningState()
         ),
 
-      getIsSomeColumnsPinned: () => {
-        const { left, right } = instance.getState().columnPinning
+      getIsSomeColumnsPinned: position => {
+        const pinningState = instance.getState().columnPinning
 
-        return Boolean(left?.length || right?.length)
+        if (!position) {
+          return Boolean(
+            pinningState.left?.length || pinningState.right?.length
+          )
+        }
+        return Boolean(pinningState[position]?.length)
       },
 
       getLeftLeafColumns: memo(

package/src/features/Sorting.ts

@@ -101,7 +101,7 @@ export const Sorting: TableFeature = {
     }
   },
 
-  getDefaultColumn: <
+  getDefaultColumnDef: <
     TGenerics extends TableGenerics
   >(): SortingColumnDef<TGenerics> => {
     return {
@@ -170,15 +170,15 @@ export const Sorting: TableFeature = {
           throw new Error()
         }
 
-        return isFunction(column.sortingFn)
-          ? column.sortingFn
-          : column.sortingFn === 'auto'
+        return isFunction(column.columnDef.sortingFn)
+          ? column.columnDef.sortingFn
+          : column.columnDef.sortingFn === 'auto'
           ? column.getAutoSortingFn()
           : (userSortingFn as Record<string, any>)?.[
-              column.sortingFn as string
+              column.columnDef.sortingFn as string
             ] ??
             (sortingFns[
-              column.sortingFn as BuiltInSortingFn
+              column.columnDef.sortingFn as BuiltInSortingFn
             ] as SortingFn<TGenerics>)
       },
       toggleSorting: (desc, multi) => {
@@ -220,7 +220,7 @@ export const Sorting: TableFeature = {
           }
 
           const sortDescFirst =
-            column.sortDescFirst ??
+            column.columnDef.sortDescFirst ??
             instance.options.sortDescFirst ??
             column.getAutoSortDir() === 'desc'
 
@@ -280,7 +280,7 @@ export const Sorting: TableFeature = {
 
       getCanSort: () => {
         return (
-          (column.enableSorting ?? true) &&
+          (column.columnDef.enableSorting ?? true) &&
           (instance.options.enableSorting ?? true) &&
           !!column.accessorFn
         )
@@ -288,7 +288,7 @@ export const Sorting: TableFeature = {
 
       getCanMultiSort: () => {
         return (
-          column.enableMultiSort ??
+          column.columnDef.enableMultiSort ??
           instance.options.enableMultiSort ??
           !!column.accessorFn
         )

package/src/features/Visibility.ts

@@ -76,7 +76,7 @@ export const Visibility: TableFeature = {
     }
   },
 
-  getDefaultColumn: () => {
+  getDefaultColumnDef: () => {
     return {
       defaultIsVisible: true,
     }
@@ -101,7 +101,7 @@ export const Visibility: TableFeature = {
 
       getCanHide: () => {
         return (
-          (column.enableHiding ?? true) &&
+          (column.columnDef.enableHiding ?? true) &&
           (instance.options.enableHiding ?? true)
         )
       },

package/src/types.ts

@@ -53,7 +53,7 @@ import {
   ExpandedTableState,
   ExpandedRow,
 } from './features/Expanding'
-import { Overwrite } from './utils'
+import { Overwrite, PartialKeys } from './utils'
 import {
   ColumnSizingColumn,
   ColumnSizingColumnDef,
@@ -100,7 +100,7 @@ export type TableFeature = {
   getDefaultOptions?: (instance: any) => any
   getInitialState?: (initialState?: InitialTableState) => any
   createInstance?: (instance: any) => any
-  getDefaultColumn?: () => any
+  getDefaultColumnDef?: () => any
   createColumn?: (column: any, instance: any) => any
   createHeader?: (column: any, instance: any) => any
   createCell?: (cell: any, column: any, row: any, instance: any) => any
@@ -124,7 +124,7 @@ export type TableInstance<TGenerics extends TableGenerics> =
     PaginationInstance<TGenerics> &
     RowSelectionInstance<TGenerics>
 
-export type TableOptions<TGenerics extends TableGenerics> =
+export type TableOptionsResolved<TGenerics extends TableGenerics> =
   CoreOptions<TGenerics> &
     ColumnsOptions<TGenerics> &
     RowsOptions<TGenerics> &
@@ -139,6 +139,11 @@ export type TableOptions<TGenerics extends TableGenerics> =
     PaginationOptions<TGenerics> &
     RowSelectionOptions<TGenerics>
 
+export type TableOptions<TGenerics extends TableGenerics> = Omit<
+  PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>,
+  'render'
+>
+
 export type TableState = CoreTableState &
   VisibilityTableState &
   ColumnOrderTableState &
@@ -199,8 +204,7 @@ export type ColumnDef<TGenerics extends TableGenerics> =
     GroupingColumnDef<TGenerics> &
     ColumnSizingColumnDef
 
-export type Column<TGenerics extends TableGenerics> = ColumnDef<TGenerics> &
-  CoreColumn<TGenerics> &
+export type Column<TGenerics extends TableGenerics> = CoreColumn<TGenerics> &
   ColumnVisibilityColumn &
   ColumnPinningColumn &
   FiltersColumn<TGenerics> &

package/src/utils/getGroupedRowModel.ts

@@ -91,8 +91,9 @@ export function getGroupedRowModel<TGenerics extends TableGenerics>(): (
                         leafRows.map(row => {
                           let columnValue = row.getValue(columnId)
 
-                          if (!depth && column.aggregateValue) {
-                            columnValue = column.aggregateValue(columnValue)
+                          if (!depth && column.columnDef.aggregateValue) {
+                            columnValue =
+                              column.columnDef.aggregateValue(columnValue)
                           }
 
                           return columnValue

package/src/utils/getSortedRowModel.ts

@@ -35,8 +35,8 @@ export function getSortedRowModel<TGenerics extends TableGenerics>(): (
           const column = instance.getColumn(sortEntry.id)
 
           columnInfoById[sortEntry.id] = {
-            sortUndefined: column.sortUndefined,
-            invertSorting: column.invertSorting,
+            sortUndefined: column.columnDef.sortUndefined,
+            invertSorting: column.columnDef.invertSorting,
             sortingFn: column.getSortingFn(),
           }
         })