material-react-table 1.2.10 → 1.3.0-beta.1

package/dist/cjs/MaterialReactTable.d.ts

@@ -18,8 +18,9 @@ import type { TableProps } from '@mui/material/Table';
 import type { TableRowProps } from '@mui/material/TableRow';
 import type { TextFieldProps } from '@mui/material/TextField';
 import type { ToolbarProps } from '@mui/material/Toolbar';
-import type { Cell, Column, ColumnDef, DeepKeys, FilterFn, Header, HeaderGroup, OnChangeFn, Row, SortingFn, Table, TableOptions, TableState } from '@tanstack/react-table';
+import type { AggregationFn, Cell, Column, ColumnDef, DeepKeys, FilterFn, Header, HeaderGroup, OnChangeFn, Row, SortingFn, Table, TableOptions, TableState } from '@tanstack/react-table';
 import type { Options as VirtualizerOptions, VirtualItem } from 'react-virtual';
+import { MRT_AggregationFns } from './aggregationFns';
 import { MRT_FilterFns } from './filterFns';
 import { MRT_Icons } from './icons';
 import { MRT_SortingFns } from './sortingFns';
@@ -196,7 +197,7 @@ export declare type MRT_TableState<TData extends Record<string, any> = {}> = Tab
     showProgressBars: boolean;
     showSkeletons: boolean;
 };
-export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnDef<TData, unknown>, 'aggregatedCell' | 'cell' | 'columns' | 'filterFn' | 'footer' | 'header' | 'id' | 'sortingFn'> & {
+export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<ColumnDef<TData, unknown>, 'accessorKey' | 'aggregatedCell' | 'aggregationFn' | 'cell' | 'columns' | 'filterFn' | 'footer' | 'header' | 'id' | 'sortingFn'> & {
     AggregatedCell?: ({ cell, column, row, table, }: {
         cell: MRT_Cell<TData>;
         column: MRT_Column<TData>;
@@ -253,6 +254,7 @@ export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit
      * @example accessorKey: 'name.firstName' //deep key dot notation
      */
     accessorKey?: DeepKeys<TData>;
+    aggregationFn?: MRT_AggregationFn<TData> | Array<MRT_AggregationFn<TData>>;
     /**
      * Specify what type of column this is. Either `data`, `display`, or `group`. Defaults to `data`.
      * Leave this blank if you are just creating a normal data column.
@@ -378,6 +380,8 @@ export declare type MRT_Cell<TData extends Record<string, any> = {}> = Omit<Cell
     column: MRT_Column<TData>;
     row: MRT_Row<TData>;
 };
+export declare type MRT_AggregationOption = string & keyof typeof MRT_AggregationFns;
+export declare type MRT_AggregationFn<TData extends Record<string, any> = {}> = AggregationFn<TData> | MRT_AggregationOption;
 export declare type MRT_SortingOption = LiteralUnion<string & keyof typeof MRT_SortingFns>;
 export declare type MRT_SortingFn<TData extends Record<string, any> = {}> = SortingFn<TData> | MRT_SortingOption;
 export declare type MRT_FilterOption = LiteralUnion<string & keyof typeof MRT_FilterFns>;
@@ -609,7 +613,7 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
         values: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
     }) => Promise<void> | void;
     onEditingRowChange?: OnChangeFn<MRT_Row<TData> | null>;
-    onFilterFnsChange?: OnChangeFn<{
+    onColumnFilterFnsChange?: OnChangeFn<{
         [key: string]: MRT_FilterOption;
     }>;
     onGlobalFilterFnChange?: OnChangeFn<MRT_FilterOption>;

package/dist/cjs/column.utils.d.ts

@@ -1,4 +1,5 @@
-import type { ColumnOrderState, GroupingState } from '@tanstack/react-table';
+import type { ColumnOrderState, GroupingState, Row } from '@tanstack/react-table';
+import { MRT_AggregationFns } from './aggregationFns';
 import { MRT_FilterFns } from './filterFns';
 import { MRT_SortingFns } from './sortingFns';
 import type { TableCellProps } from '@mui/material/TableCell';
@@ -6,7 +7,18 @@ import type { Theme } from '@mui/material/styles';
 import type { MaterialReactTableProps, MRT_Column, MRT_ColumnDef, MRT_DefinedColumnDef, MRT_DisplayColumnIds, MRT_FilterOption, MRT_Header, MRT_TableInstance } from '.';
 export declare const getColumnId: <TData extends Record<string, any> = {}>(columnDef: MRT_ColumnDef<TData>) => string;
 export declare const getAllLeafColumnDefs: <TData extends Record<string, any> = {}>(columns: MRT_ColumnDef<TData>[]) => MRT_ColumnDef<TData>[];
-export declare const prepareColumns: <TData extends Record<string, any> = {}>({ columnDefs, columnFilterFns, defaultDisplayColumn, filterFns, sortingFns, }: {
+export declare const prepareColumns: <TData extends Record<string, any> = {}>({ aggregationFns, columnDefs, columnFilterFns, defaultDisplayColumn, filterFns, sortingFns, }: {
+    aggregationFns: {
+        sum: import("@tanstack/table-core").AggregationFn<any>;
+        min: import("@tanstack/table-core").AggregationFn<any>;
+        max: import("@tanstack/table-core").AggregationFn<any>;
+        extent: import("@tanstack/table-core").AggregationFn<any>;
+        mean: import("@tanstack/table-core").AggregationFn<any>;
+        median: import("@tanstack/table-core").AggregationFn<any>;
+        unique: import("@tanstack/table-core").AggregationFn<any>;
+        uniqueCount: import("@tanstack/table-core").AggregationFn<any>;
+        count: import("@tanstack/table-core").AggregationFn<any>;
+    } & Record<string, import("@tanstack/table-core").AggregationFn<any>>;
     columnDefs: MRT_ColumnDef<TData>[];
     columnFilterFns: {
         [key: string]: MRT_FilterOption;
@@ -14,59 +26,59 @@ export declare const prepareColumns: <TData extends Record<string, any> = {}>({
     defaultDisplayColumn: Partial<MRT_ColumnDef<TData>>;
     filterFns: {
         between: {
-            <TData_1 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_1>, id: string, filterValues: [string | number, string | number]): boolean;
+            <TData_1 extends Record<string, any> = {}>(row: Row<TData_1>, id: string, filterValues: [string | number, string | number]): boolean;
             autoRemove(val: any): boolean;
         };
         betweenInclusive: {
-            <TData_2 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_2>, id: string, filterValues: [string | number, string | number]): boolean;
+            <TData_2 extends Record<string, any> = {}>(row: Row<TData_2>, id: string, filterValues: [string | number, string | number]): boolean;
             autoRemove(val: any): boolean;
         };
         contains: {
-            <TData_3 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_3>, id: string, filterValue: string | number): boolean;
+            <TData_3 extends Record<string, any> = {}>(row: Row<TData_3>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         empty: {
-            <TData_4 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_4>, id: string, _filterValue: string | number): boolean;
+            <TData_4 extends Record<string, any> = {}>(row: Row<TData_4>, id: string, _filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         endsWith: {
-            <TData_5 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_5>, id: string, filterValue: string | number): boolean;
+            <TData_5 extends Record<string, any> = {}>(row: Row<TData_5>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         equals: {
-            <TData_6 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_6>, id: string, filterValue: string | number): boolean;
+            <TData_6 extends Record<string, any> = {}>(row: Row<TData_6>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         fuzzy: {
-            <TData_7 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_7>, columnId: string, filterValue: string | number, addMeta: (item: import("@tanstack/match-sorter-utils").RankingInfo) => void): boolean;
+            <TData_7 extends Record<string, any> = {}>(row: Row<TData_7>, columnId: string, filterValue: string | number, addMeta: (item: import("@tanstack/match-sorter-utils").RankingInfo) => void): boolean;
             autoRemove(val: any): boolean;
         };
         greaterThan: {
-            <TData_8 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_8>, id: string, filterValue: string | number): boolean;
+            <TData_8 extends Record<string, any> = {}>(row: Row<TData_8>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         greaterThanOrEqualTo: {
-            <TData_9 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_9>, id: string, filterValue: string | number): boolean;
+            <TData_9 extends Record<string, any> = {}>(row: Row<TData_9>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         lessThan: {
-            <TData_10 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_10>, id: string, filterValue: string | number): boolean;
+            <TData_10 extends Record<string, any> = {}>(row: Row<TData_10>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         lessThanOrEqualTo: {
-            <TData_11 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_11>, id: string, filterValue: string | number): boolean;
+            <TData_11 extends Record<string, any> = {}>(row: Row<TData_11>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         notEmpty: {
-            <TData_12 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_12>, id: string, _filterValue: string | number): boolean;
+            <TData_12 extends Record<string, any> = {}>(row: Row<TData_12>, id: string, _filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         notEquals: {
-            <TData_13 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_13>, id: string, filterValue: string | number): boolean;
+            <TData_13 extends Record<string, any> = {}>(row: Row<TData_13>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         startsWith: {
-            <TData_14 extends Record<string, any> = {}>(row: import("@tanstack/table-core").Row<TData_14>, id: string, filterValue: string | number): boolean;
+            <TData_14 extends Record<string, any> = {}>(row: Row<TData_14>, id: string, filterValue: string | number): boolean;
             autoRemove(val: any): boolean;
         };
         includesString: import("@tanstack/table-core").FilterFn<any>;
@@ -79,7 +91,7 @@ export declare const prepareColumns: <TData extends Record<string, any> = {}>({
         inNumberRange: import("@tanstack/table-core").FilterFn<any>;
     } & Record<string, import("@tanstack/table-core").FilterFn<any>>;
     sortingFns: {
-        fuzzy: <TData_15 extends Record<string, any> = {}>(rowA: import("@tanstack/table-core").Row<TData_15>, rowB: import("@tanstack/table-core").Row<TData_15>, columnId: string) => number;
+        fuzzy: <TData_15 extends Record<string, any> = {}>(rowA: Row<TData_15>, rowB: Row<TData_15>, columnId: string) => number;
         alphanumeric: import("@tanstack/table-core").SortingFn<any>;
         alphanumericCaseSensitive: import("@tanstack/table-core").SortingFn<any>;
         text: import("@tanstack/table-core").SortingFn<any>;