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

package/build/types/core/instance.d.ts

@@ -30,6 +30,7 @@ export declare type CoreOptions<TGenerics extends TableGenerics> = {
     getRowId?: (originalRow: TGenerics['Row'], index: number, parent?: Row<TGenerics>) => string;
     columns: ColumnDef<TGenerics>[];
     defaultColumn?: Partial<ColumnDef<TGenerics>>;
+    renderFallbackValue: any;
 };
 export declare type CoreInstance<TGenerics extends TableGenerics> = {
     initialState: TableState;

package/build/types/features/Sorting.d.ts

@@ -31,6 +31,7 @@ export declare type SortingColumn<TGenerics extends TableGenerics> = {
     getAutoSortingFn: () => SortingFn<TGenerics>;
     getAutoSortDir: () => SortDirection;
     getSortingFn: () => SortingFn<TGenerics>;
+    getNextSortingOrder: () => SortDirection | false;
     getCanSort: () => boolean;
     getCanMultiSort: () => boolean;
     getSortIndex: () => number;

package/build/types/types.d.ts

@@ -31,7 +31,7 @@ export declare type TableGenerics = {
 export declare type AnyRender = (Comp: any, props: any) => any;
 export declare type TableInstance<TGenerics extends TableGenerics> = CoreInstance<TGenerics> & HeadersInstance<TGenerics> & VisibilityInstance<TGenerics> & ColumnOrderInstance<TGenerics> & ColumnPinningInstance<TGenerics> & FiltersInstance<TGenerics> & SortingInstance<TGenerics> & GroupingInstance<TGenerics> & ColumnSizingInstance<TGenerics> & ExpandedInstance<TGenerics> & PaginationInstance<TGenerics> & RowSelectionInstance<TGenerics>;
 export declare type TableOptionsResolved<TGenerics extends TableGenerics> = CoreOptions<TGenerics> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TGenerics> & SortingOptions<TGenerics> & GroupingOptions<TGenerics> & ExpandedOptions<TGenerics> & ColumnSizingOptions & PaginationOptions<TGenerics> & RowSelectionOptions<TGenerics>;
-export declare type TableOptions<TGenerics extends TableGenerics> = Omit<PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>, 'render'>;
+export declare type TableOptions<TGenerics extends TableGenerics> = Omit<PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>, 'render' | 'renderFallbackValue'>;
 export declare type TableState = CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationTableState & RowSelectionTableState;
 export declare type InitialTableState = Partial<CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationInitialTableState & RowSelectionTableState>;
 export declare type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> & VisibilityRow<TGenerics> & ColumnPinningRow<TGenerics> & FiltersRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;

package/build/umd/index.development.js

@@ -1525,6 +1525,12 @@
       };
     },
     createCell: (cell, column, row, instance) => {
+      const getRenderValue = () => {
+        var _cell$getValue;
+
+        return (_cell$getValue = cell.getValue()) != null ? _cell$getValue : instance.options.renderFallbackValue;
+      };
+
       return {
         getIsGrouped: () => column.getIsGrouped() && column.id === row.groupingColumnId,
         getIsPlaceholder: () => !cell.getIsGrouped() && column.getIsGrouped(),
@@ -1534,15 +1540,19 @@
           return !cell.getIsGrouped() && !cell.getIsPlaceholder() && ((_row$subRows = row.subRows) == null ? void 0 : _row$subRows.length) > 1;
         },
         renderAggregatedCell: () => {
-          var _column$columnDef$agg;
+          {
+            if (!column.columnDef.aggregatedCell) {
+              console.warn('A columnDef.aggregatedCell template is recommended for displaying aggregated values.');
+            }
+          }
 
-          const template = (_column$columnDef$agg = column.columnDef.aggregatedCell) != null ? _column$columnDef$agg : column.columnDef.cell;
+          const template = column.columnDef.aggregatedCell || column.columnDef.cell;
           return template ? instance._render(template, {
             instance,
             column,
             row,
             cell,
-            getValue: cell.getValue
+            getValue: getRenderValue
           }) : null;
         }
       };
@@ -2525,8 +2535,10 @@
           //   })
           //   return
           // }
+          // this needs to be outside of instance.setSorting to be in sync with rerender
+          const nextSortingOrder = column.getNextSortingOrder();
           instance.setSorting(old => {
-            var _ref2, _column$columnDef$sor, _instance$options$ena, _instance$options$ena2;
+            var _instance$options$ena, _instance$options$ena2;
 
             // Find any existing sorting for this column
             const existingSorting = old == null ? void 0 : old.find(d => d.id === column.id);
@@ -2551,30 +2563,29 @@
               } else {
                 sortAction = 'replace';
               }
-            }
+            } // Handle toggle states that will remove the sorting
 
-            const sortDescFirst = (_ref2 = (_column$columnDef$sor = column.columnDef.sortDescFirst) != null ? _column$columnDef$sor : instance.options.sortDescFirst) != null ? _ref2 : column.getAutoSortDir() === 'desc'; // Handle toggle states that will remove the sorting
 
             if (sortAction === 'toggle' && ( // Must be toggling
             (_instance$options$ena = instance.options.enableSortingRemoval) != null ? _instance$options$ena : true) && // If enableSortRemove, enable in general
             !hasDescDefined && ( // Must not be setting desc
-            multi ? (_instance$options$ena2 = instance.options.enableMultiRemove) != null ? _instance$options$ena2 : true : true) && ( // If multi, don't allow if enableMultiRemove
-            existingSorting != null && existingSorting.desc // Finally, detect if it should indeed be removed
-            ? !sortDescFirst : sortDescFirst)) {
+            multi ? (_instance$options$ena2 = instance.options.enableMultiRemove) != null ? _instance$options$ena2 : true : true) && // If multi, don't allow if enableMultiRemove
+            !nextSortingOrder // Finally, detect if it should indeed be removed
+            ) {
               sortAction = 'remove';
             }
 
             if (sortAction === 'replace') {
               newSorting = [{
                 id: column.id,
-                desc: hasDescDefined ? desc : !!sortDescFirst
+                desc: hasDescDefined ? desc : nextSortingOrder === 'desc'
               }];
             } else if (sortAction === 'add' && old != null && old.length) {
               var _instance$options$max;
 
               newSorting = [...old, {
                 id: column.id,
-                desc: hasDescDefined ? desc : !!sortDescFirst
+                desc: hasDescDefined ? desc : nextSortingOrder === 'desc'
               }]; // Take latest n columns
 
               newSorting.splice(0, newSorting.length - ((_instance$options$max = instance.options.maxMultiSortColCount) != null ? _instance$options$max : Number.MAX_SAFE_INTEGER));
@@ -2583,7 +2594,7 @@
               newSorting = old.map(d => {
                 if (d.id === column.id) {
                   return { ...d,
-                    desc: hasDescDefined ? desc : !(existingSorting != null && existingSorting.desc)
+                    desc: hasDescDefined ? desc : nextSortingOrder === 'desc'
                   };
                 }
 
@@ -2596,6 +2607,23 @@
             return newSorting;
           });
         },
+        getNextSortingOrder: () => {
+          var _ref2, _column$columnDef$sor;
+
+          const sortDescFirst = (_ref2 = (_column$columnDef$sor = column.columnDef.sortDescFirst) != null ? _column$columnDef$sor : instance.options.sortDescFirst) != null ? _ref2 : 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: () => {
           var _column$columnDef$ena, _instance$options$ena3;
 
@@ -3043,6 +3071,12 @@
   }
 
   function createCell(instance, row, column, columnId) {
+    const getRenderValue = () => {
+      var _cell$getValue;
+
+      return (_cell$getValue = cell.getValue()) != null ? _cell$getValue : instance.options.renderFallbackValue;
+    };
+
     const cell = {
       id: row.id + "_" + column.id,
       row,
@@ -3054,7 +3088,7 @@
           column,
           row,
           cell: cell,
-          getValue: cell.getValue
+          getValue: getRenderValue
         }) : null;
       }
     };