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

package/package.json

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

@@ -85,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> = {

package/src/features/Grouping.ts

@@ -248,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,
@@ -257,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, {
@@ -266,7 +277,7 @@ export const Grouping: TableFeature = {
               column,
               row,
               cell,
-              getValue: cell.getValue,
+              getValue: getRenderValue,
             })
           : null
       },

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
@@ -189,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)
@@ -198,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) {
@@ -217,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'
           }
@@ -239,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) {
@@ -247,7 +244,7 @@ export const Sorting: TableFeature = {
               ...old,
               {
                 id: column.id,
-                desc: hasDescDefined ? desc! : !!sortDescFirst,
+                desc: hasDescDefined ? desc! : nextSortingOrder! === 'desc',
               },
             ]
             // Take latest n columns
@@ -263,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
@@ -276,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 &