@tanstack/table-core 8.0.0-beta.1 → 8.0.0-beta.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/table-core",
   "author": "Tanner Linsley",
-  "version": "8.0.0-beta.1",
+  "version": "8.0.0-beta.4",
   "description": "Headless UI for building powerful tables & datagrids for TS/JS.",
   "license": "MIT",
   "homepage": "https://github.com/tanstack/table#readme",

package/src/core/cell.ts

@@ -14,6 +14,9 @@ export function createCell<TGenerics extends TableGenerics>(
   column: Column<TGenerics>,
   columnId: string
 ) {
+  const getRenderValue = () =>
+    cell.getValue() ?? instance.options.renderFallbackValue
+
   const cell: CoreCell<TGenerics> = {
     id: `${row.id}_${column.id}`,
     row,
@@ -26,7 +29,7 @@ export function createCell<TGenerics extends TableGenerics>(
             column,
             row,
             cell: cell as Cell<TGenerics>,
-            getValue: cell.getValue,
+            getValue: getRenderValue,
           })
         : null
     },

package/src/core/instance.ts

@@ -73,9 +73,7 @@ export type CoreOptions<TGenerics extends TableGenerics> = {
   autoResetAll?: boolean
   mergeOptions?: <T>(defaultOptions: T, options: Partial<T>) => T
   meta?: TGenerics['TableMeta']
-  getCoreRowModel: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getCoreRowModel: (instance: TableInstance<any>) => () => RowModel<any>
   getSubRows?: (
     originalRow: TGenerics['Row'],
     index: number
@@ -87,6 +85,7 @@ export type CoreOptions<TGenerics extends TableGenerics> = {
   ) => string
   columns: ColumnDef<TGenerics>[]
   defaultColumn?: Partial<ColumnDef<TGenerics>>
+  renderFallbackValue: any
 }
 
 export type CoreInstance<TGenerics extends TableGenerics> = {
@@ -256,7 +255,7 @@ export function createTableInstance<TGenerics extends TableGenerics>(
         return {
           header: props => props.header.column.id,
           footer: props => props.header.column.id,
-          cell: props => props.getValue().toString?.() ?? null,
+          cell: props => props.getValue()?.toString?.() ?? null,
           ...instance._features.reduce((obj, feature) => {
             return Object.assign(obj, feature.getDefaultColumnDef?.())
           }, {}),

package/src/features/Expanding.ts

@@ -27,9 +27,7 @@ export type ExpandedOptions<TGenerics extends TableGenerics> = {
   onExpandedChange?: OnChangeFn<ExpandedState>
   autoResetExpanded?: boolean
   enableExpanding?: boolean
-  getExpandedRowModel?: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getExpandedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>
   getIsRowExpanded?: (row: Row<TGenerics>) => boolean
   getRowCanExpand?: (row: Row<TGenerics>) => boolean
   paginateExpandedRows?: boolean

package/src/features/Filters.ts

@@ -75,7 +75,6 @@ export type FiltersColumnDef<TGenerics extends TableGenerics> = {
 }
 
 export type FiltersColumn<TGenerics extends TableGenerics> = {
-  filterFn: FilterFnOption<Overwrite<TGenerics, { Value: any }>>
   getAutoFilterFn: () => FilterFn<TGenerics> | undefined
   getFilterFn: () => FilterFn<TGenerics> | undefined
   setFilterValue: (updater: Updater<any>) => void
@@ -102,9 +101,7 @@ export type FiltersOptions<TGenerics extends TableGenerics> = {
   manualFiltering?: boolean
   filterFromLeafRows?: boolean
   filterFns?: TGenerics['FilterFns']
-  getFilteredRowModel?: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getFilteredRowModel?: (instance: TableInstance<any>) => () => RowModel<any>
 
   // Column
   onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>
@@ -199,7 +196,6 @@ export const Filters: TableFeature = {
     instance: TableInstance<TGenerics>
   ): FiltersColumn<TGenerics> => {
     return {
-      filterFn: column.filterFn,
       getAutoFilterFn: () => {
         const firstRow = instance.getCoreRowModel().flatRows[0]
 
@@ -230,15 +226,15 @@ export const Filters: TableFeature = {
       getFilterFn: () => {
         const userFilterFns = instance.options.filterFns
 
-        return isFunction(column.filterFn)
-          ? column.filterFn
-          : column.filterFn === 'auto'
+        return isFunction(column.columnDef.filterFn)
+          ? column.columnDef.filterFn
+          : column.columnDef.filterFn === 'auto'
           ? column.getAutoFilterFn()
           : (userFilterFns as Record<string, any>)?.[
-              column.filterFn as string
+              column.columnDef.filterFn as string
             ] ??
             (filterFns[
-              column.filterFn as BuiltInFilterFn
+              column.columnDef.filterFn as BuiltInFilterFn
             ] as FilterFn<TGenerics>)
       },
       getCanFilter: () => {

package/src/features/Grouping.ts

@@ -52,7 +52,6 @@ export type GroupingColumnDef<TGenerics extends TableGenerics> = {
 }
 
 export type GroupingColumn<TGenerics extends TableGenerics> = {
-  aggregationFn?: AggregationFnOption<Overwrite<TGenerics, { Value: any }>>
   getCanGroup: () => boolean
   getIsGrouped: () => boolean
   getGroupedIndex: () => number
@@ -87,9 +86,7 @@ export type GroupingOptions<TGenerics extends TableGenerics> = {
   aggregationFns?: TGenerics['AggregationFns']
   onGroupingChange?: OnChangeFn<GroupingState>
   enableGrouping?: boolean
-  getGroupedRowModel?: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getGroupedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>
   groupedColumnMode?: false | 'reorder' | 'remove'
 }
 
@@ -110,6 +107,7 @@ export const Grouping: TableFeature = {
     TGenerics extends TableGenerics
   >(): GroupingColumnDef<TGenerics> => {
     return {
+      aggregatedCell: props => props.getValue()?.toString?.() ?? null,
       aggregationFn: 'auto',
     }
   },
@@ -182,8 +180,6 @@ export const Grouping: TableFeature = {
         if (Object.prototype.toString.call(value) === '[object Date]') {
           return aggregationFns.extent
         }
-
-        return aggregationFns.count
       },
       getAggregationFn: () => {
         const userAggregationFns = instance.options.aggregationFns
@@ -192,15 +188,15 @@ export const Grouping: TableFeature = {
           throw new Error()
         }
 
-        return isFunction(column.aggregationFn)
-          ? column.aggregationFn
-          : column.aggregationFn === 'auto'
+        return isFunction(column.columnDef.aggregationFn)
+          ? column.columnDef.aggregationFn
+          : column.columnDef.aggregationFn === 'auto'
           ? column.getAutoAggregationFn()
           : (userAggregationFns as Record<string, any>)?.[
-              column.aggregationFn as string
+              column.columnDef.aggregationFn as string
             ] ??
             (aggregationFns[
-              column.aggregationFn as BuiltInAggregationFn
+              column.columnDef.aggregationFn as BuiltInAggregationFn
             ] as AggregationFn<TGenerics>)
       },
     }
@@ -252,6 +248,9 @@ export const Grouping: TableFeature = {
     row: Row<TGenerics>,
     instance: TableInstance<TGenerics>
   ): GroupingCell<TGenerics> => {
+    const getRenderValue = () =>
+      cell.getValue() ?? instance.options.renderFallbackValue
+
     return {
       getIsGrouped: () =>
         column.getIsGrouped() && column.id === row.groupingColumnId,
@@ -261,8 +260,16 @@ export const Grouping: TableFeature = {
         !cell.getIsPlaceholder() &&
         row.subRows?.length > 1,
       renderAggregatedCell: () => {
+        if (process.env.NODE_ENV === 'development') {
+          if (!column.columnDef.aggregatedCell) {
+            console.warn(
+              'A columnDef.aggregatedCell template is recommended for displaying aggregated values.'
+            )
+          }
+        }
+
         const template =
-          column.columnDef.aggregatedCell ?? column.columnDef.cell
+          column.columnDef.aggregatedCell || column.columnDef.cell
 
         return template
           ? instance._render(template, {
@@ -270,7 +277,7 @@ export const Grouping: TableFeature = {
               column,
               row,
               cell,
-              getValue: cell.getValue,
+              getValue: getRenderValue,
             })
           : null
       },

package/src/features/Pagination.ts

@@ -26,9 +26,7 @@ export type PaginationOptions<TGenerics extends TableGenerics> = {
   manualPagination?: boolean
   onPaginationChange?: OnChangeFn<PaginationState>
   autoResetPageIndex?: boolean
-  getPaginationRowModel?: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getPaginationRowModel?: (instance: TableInstance<any>) => () => RowModel<any>
 }
 
 export type PaginationDefaultOptions = {

package/src/features/Sorting.ts

@@ -58,6 +58,7 @@ export type SortingColumn<TGenerics extends TableGenerics> = {
   getAutoSortingFn: () => SortingFn<TGenerics>
   getAutoSortDir: () => SortDirection
   getSortingFn: () => SortingFn<TGenerics>
+  getNextSortingOrder: () => SortDirection | false
   getCanSort: () => boolean
   getCanMultiSort: () => boolean
   getSortIndex: () => number
@@ -76,9 +77,7 @@ export type SortingOptions<TGenerics extends TableGenerics> = {
   enableMultiRemove?: boolean
   enableMultiSort?: boolean
   sortDescFirst?: boolean
-  getSortedRowModel?: (
-    instance: TableInstance<TGenerics>
-  ) => () => RowModel<TGenerics>
+  getSortedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>
   maxMultiSortColCount?: number
   isMultiSortEvent?: (e: unknown) => boolean
 }
@@ -191,6 +190,9 @@ export const Sorting: TableFeature = {
         //   return
         // }
 
+        // this needs to be outside of instance.setSorting to be in sync with rerender
+        const nextSortingOrder = column.getNextSortingOrder()
+
         instance.setSorting(old => {
           // Find any existing sorting for this column
           const existingSorting = old?.find(d => d.id === column.id)
@@ -200,7 +202,7 @@ export const Sorting: TableFeature = {
           let newSorting: SortingState = []
 
           // What should we do with this sort action?
-          let sortAction
+          let sortAction: 'add' | 'remove' | 'toggle' | 'replace'
 
           if (column.getCanMultiSort() && multi) {
             if (existingSorting) {
@@ -219,20 +221,13 @@ export const Sorting: TableFeature = {
             }
           }
 
-          const sortDescFirst =
-            column.columnDef.sortDescFirst ??
-            instance.options.sortDescFirst ??
-            column.getAutoSortDir() === 'desc'
-
           // Handle toggle states that will remove the sorting
           if (
             sortAction === 'toggle' && // Must be toggling
             (instance.options.enableSortingRemoval ?? true) && // If enableSortRemove, enable in general
             !hasDescDefined && // Must not be setting desc
             (multi ? instance.options.enableMultiRemove ?? true : true) && // If multi, don't allow if enableMultiRemove
-            (existingSorting?.desc // Finally, detect if it should indeed be removed
-              ? !sortDescFirst
-              : sortDescFirst)
+            !nextSortingOrder // Finally, detect if it should indeed be removed
           ) {
             sortAction = 'remove'
           }
@@ -241,7 +236,7 @@ export const Sorting: TableFeature = {
             newSorting = [
               {
                 id: column.id,
-                desc: hasDescDefined ? desc! : !!sortDescFirst,
+                desc: hasDescDefined ? desc! : nextSortingOrder! === 'desc',
               },
             ]
           } else if (sortAction === 'add' && old?.length) {
@@ -249,7 +244,7 @@ export const Sorting: TableFeature = {
               ...old,
               {
                 id: column.id,
-                desc: hasDescDefined ? desc! : !!sortDescFirst,
+                desc: hasDescDefined ? desc! : nextSortingOrder! === 'desc',
               },
             ]
             // Take latest n columns
@@ -265,7 +260,7 @@ export const Sorting: TableFeature = {
               if (d.id === column.id) {
                 return {
                   ...d,
-                  desc: hasDescDefined ? desc! : !existingSorting?.desc,
+                  desc: hasDescDefined ? desc! : nextSortingOrder! === 'desc',
                 }
               }
               return d
@@ -278,6 +273,24 @@ export const Sorting: TableFeature = {
         })
       },
 
+      getNextSortingOrder: () => {
+        const sortDescFirst =
+          column.columnDef.sortDescFirst ??
+          instance.options.sortDescFirst ??
+          column.getAutoSortDir() === 'desc'
+        const firstSortDirection = sortDescFirst ? 'desc' : 'asc'
+
+        const isSorted = column.getIsSorted()
+        if (!isSorted) {
+          return firstSortDirection
+        }
+        if (isSorted === firstSortDirection) {
+          return isSorted === 'desc' ? 'asc' : 'desc'
+        } else {
+          return false
+        }
+      },
+
       getCanSort: () => {
         return (
           (column.columnDef.enableSorting ?? true) &&

package/src/types.ts

@@ -123,7 +123,7 @@ export type TableOptionsResolved<TGenerics extends TableGenerics> =
 
 export type TableOptions<TGenerics extends TableGenerics> = Omit<
   PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>,
-  'render'
+  'render' | 'renderFallbackValue'
 >
 
 export type TableState = CoreTableState &

package/src/utils/getGroupedRowModel.ts

@@ -93,13 +93,6 @@ export function getGroupedRowModel<TGenerics extends TableGenerics>(): (
                     )
 
                     return row._groupingValuesCache[columnId]
-                  } else if (column.aggregationFn) {
-                    console.info({ column })
-                    throw new Error(
-                      process.env.NODE_ENV !== 'production'
-                        ? `Table: Invalid column.aggregateType option for column listed above`
-                        : ''
-                    )
                   }
                 },
               })