material-react-table 0.32.1 → 0.33.1

package/dist/cjs/MaterialReactTable.d.ts

@@ -1,10 +1,10 @@
 import { ChangeEvent, Dispatch, DragEvent, FC, FocusEvent, ReactNode, SetStateAction } from 'react';
 import type { AlertProps, ButtonProps, CheckboxProps, IconButtonProps, LinearProgressProps, PaperProps, SkeletonProps, TableBodyProps, TableCellProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, TableProps, TableRowProps, TextFieldProps, ToolbarProps } from '@mui/material';
-import type { Cell, Column, ColumnDef, CoreColumnDefAccessorKey, FilterFn, Header, HeaderGroup, OnChangeFn, Row, SortingFn, Table, TableOptions, TableState } from '@tanstack/react-table';
+import type { Cell, Column, ColumnDef, DeepKeys, FilterFn, Header, HeaderGroup, OnChangeFn, Row, SortingFn, Table, TableOptions, TableState } from '@tanstack/react-table';
 import type { VirtualizerOptions } from '@tanstack/react-virtual';
-import { MRT_Localization } from './localization';
 import { MRT_Icons } from './icons';
-import { MRT_FilterFns } from './filtersFns';
+import { MRT_FilterFns } from './filterFns';
+import { MRT_Localization } from './localization';
 import { MRT_SortingFns } from './sortingFns';
 declare type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);
 export interface MRT_RowModel<TData extends Record<string, any> = {}> {
@@ -39,10 +39,10 @@ export declare type MRT_TableInstance<TData extends Record<string, any> = {}> =
     setCurrentDraggingRow: Dispatch<SetStateAction<MRT_Row<TData> | null>>;
     setCurrentEditingCell: Dispatch<SetStateAction<MRT_Cell | null>>;
     setCurrentEditingRow: Dispatch<SetStateAction<MRT_Row | null>>;
-    setCurrentFilterFns: Dispatch<SetStateAction<{
+    setColumnFilterFns: Dispatch<SetStateAction<{
         [key: string]: MRT_FilterOption;
     }>>;
-    setCurrentGlobalFilterFn: Dispatch<SetStateAction<MRT_FilterOption>>;
+    setGlobalFilterFn: Dispatch<SetStateAction<MRT_FilterOption>>;
     setCurrentHoveredColumn: Dispatch<SetStateAction<MRT_Column<TData> | {
         id: string;
     } | null>>;
@@ -60,8 +60,8 @@ export declare type MRT_TableState<TData extends Record<string, any> = {}> = Tab
     currentDraggingRow: MRT_Row<TData> | null;
     currentEditingCell: MRT_Cell<TData> | null;
     currentEditingRow: MRT_Row<TData> | null;
-    currentFilterFns: Record<string, MRT_FilterOption>;
-    currentGlobalFilterFn: Record<string, MRT_FilterOption>;
+    columnFilterFns: Record<string, MRT_FilterOption>;
+    globalFilterFn: Record<string, MRT_FilterOption>;
     currentHoveredColumn: MRT_Column<TData> | {
         id: string;
     } | null;
@@ -123,7 +123,7 @@ export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit
      * @example accessorKey: 'username' //simple
      * @example accessorKey: 'name.firstName' //deep key dot notation
      */
-    accessorKey?: CoreColumnDefAccessorKey<TData, unknown>['accessorKey'];
+    accessorKey?: DeepKeys<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.
@@ -246,12 +246,12 @@ export declare type MRT_DisplayColumnIds = 'mrt-row-drag' | 'mrt-row-actions' |
  * `columns` and `data` props are the only required props, but there are over 150 other optional props.
  *
  * See more info on creating columns and data on the official docs site:
- * @link https://www.material-react-table.com/docs/usage
+ * @link https://www.material-react-table.com/docs/getting-started/usage
  *
  * See the full props list on the official docs site:
  * @link https://www.material-react-table.com/docs/api/props
  */
-export declare type MaterialReactTableProps<TData extends Record<string, any> = {}> = Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'initialState' | 'state' | 'expandRowsFn'> & {
+export declare type MaterialReactTableProps<TData extends Record<string, any> = {}> = Omit<Partial<TableOptions<TData>>, 'columns' | 'data' | 'expandRowsFn' | 'initialState' | 'onStateChange' | 'state'> & {
     displayColumnDefOptions?: Partial<{
         [key in MRT_DisplayColumnIds]: Partial<MRT_ColumnDef>;
     }>;
@@ -259,6 +259,7 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
     columns: MRT_ColumnDef<TData>[];
     data: TData[];
     editingMode?: 'table' | 'row' | 'cell';
+    enableBottomToolbar?: boolean;
     enableClickToCopy?: boolean;
     enableColumnActions?: boolean;
     enableColumnDragging?: boolean;
@@ -280,9 +281,8 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
     enableStickyHeader?: boolean;
     enableTableFooter?: boolean;
     enableTableHead?: boolean;
-    enableToolbarBottom?: boolean;
     enableToolbarInternalActions?: boolean;
-    enableToolbarTop?: boolean;
+    enableTopToolbar?: boolean;
     enabledGlobalFilterOptions?: (MRT_FilterOption | string)[] | null;
     expandRowsFn?: (dataRow: TData) => TData[];
     icons?: Partial<MRT_Icons>;
@@ -336,6 +336,9 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
         table: MRT_TableInstance<TData>;
         row: MRT_Row<TData>;
     }) => TableRowProps);
+    muiTableBottomToolbarProps?: ToolbarProps | (({ table }: {
+        table: MRT_TableInstance<TData>;
+    }) => ToolbarProps);
     muiTableContainerProps?: TableContainerProps | (({ table, }: {
         table: MRT_TableInstance<TData>;
     }) => TableContainerProps);
@@ -390,10 +393,7 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
     muiTableToolbarAlertBannerProps?: AlertProps | (({ table }: {
         table: MRT_TableInstance<TData>;
     }) => AlertProps);
-    muiTableToolbarBottomProps?: ToolbarProps | (({ table }: {
-        table: MRT_TableInstance<TData>;
-    }) => ToolbarProps);
-    muiTableToolbarTopProps?: ToolbarProps | (({ table }: {
+    muiTableTopToolbarProps?: ToolbarProps | (({ table }: {
         table: MRT_TableInstance<TData>;
     }) => ToolbarProps);
     onCellEditBlur?: ({ cell, event, table, }: {
@@ -439,13 +439,15 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
     onShowAlertBannerChange?: OnChangeFn<boolean>;
     onShowFiltersChange?: OnChangeFn<boolean>;
     onShowGlobalFilterChange?: OnChangeFn<boolean>;
-    onTableInstanceChange?: (table: MRT_TableInstance<TData>) => void;
     positionActionsColumn?: 'first' | 'last';
     positionExpandColumn?: 'first' | 'last';
     positionGlobalFilter?: 'left' | 'right';
     positionPagination?: 'bottom' | 'top' | 'both';
     positionToolbarAlertBanner?: 'bottom' | 'top' | 'none';
     positionToolbarDropZone?: 'bottom' | 'top' | 'none' | 'both';
+    renderBottomToolbarCustomActions?: ({ table, }: {
+        table: MRT_TableInstance<TData>;
+    }) => ReactNode;
     renderDetailPanel?: ({ row, table, }: {
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
@@ -459,9 +461,6 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
         row: MRT_Row<TData>;
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
-    renderToolbarBottomCustomActions?: ({ table, }: {
-        table: MRT_TableInstance<TData>;
-    }) => ReactNode;
     renderToolbarInternalActions?: ({ table, MRT_ToggleGlobalFilterButton, MRT_ToggleFiltersButton, MRT_ShowHideColumnsButton, MRT_ToggleDensePaddingButton, MRT_FullScreenToggleButton, }: {
         table: MRT_TableInstance<TData>;
         MRT_ToggleGlobalFilterButton: FC<IconButtonProps & {
@@ -480,7 +479,7 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
             table: MRT_TableInstance<TData>;
         }>;
     }) => ReactNode;
-    renderToolbarTopCustomActions?: ({ table, }: {
+    renderTopToolbarCustomActions?: ({ table, }: {
         table: MRT_TableInstance<TData>;
     }) => ReactNode;
     rowCount?: number;
@@ -488,7 +487,9 @@ export declare type MaterialReactTableProps<TData extends Record<string, any> =
     selectAllMode?: 'all' | 'page';
     state?: Partial<MRT_TableState<TData>>;
     tableId?: string;
-    virtualizerProps?: Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>;
+    virtualizerProps?: ({ table, }: {
+        table: MRT_TableInstance<TData>;
+    }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>> | Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>;
 };
-declare const _default: <TData extends Record<string, any> = {}>({ autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableColumnActions, enableColumnFilterChangeMode, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGlobalFilterChangeMode, enableGlobalFilterRankedResults, enableGrouping, enableHiding, enableMultiRowSelection, enableMultiSort, enablePagination, enablePinning, enableRowSelection, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarBottom, enableToolbarInternalActions, enableToolbarTop, icons, localization, positionActionsColumn, positionExpandColumn, positionGlobalFilter, positionPagination, positionToolbarAlertBanner, positionToolbarDropZone, rowNumberMode, selectAllMode, ...rest }: MaterialReactTableProps<TData>) => JSX.Element;
+declare const _default: <TData extends Record<string, any> = {}>({ aggregationFns, autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableBottomToolbar, enableColumnActions, enableColumnFilterChangeMode, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGlobalFilterChangeMode, enableGlobalFilterRankedResults, enableGrouping, enableHiding, enableMultiRowSelection, enableMultiSort, enablePagination, enablePinning, enableRowSelection, enableSelectAll, enableSorting, enableStickyHeader, enableTableFooter, enableTableHead, enableToolbarInternalActions, enableTopToolbar, filterFns, icons, localization, positionActionsColumn, positionExpandColumn, positionGlobalFilter, positionPagination, positionToolbarAlertBanner, positionToolbarDropZone, rowNumberMode, selectAllMode, sortingFns, ...rest }: MaterialReactTableProps<TData>) => JSX.Element;
 export default _default;

package/dist/cjs/aggregationFns.d.ts

@@ -0,0 +1,11 @@
+export declare const MRT_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>;
+};

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

@@ -1,10 +1,85 @@
 import { ColumnOrderState } from '@tanstack/react-table';
 import { MaterialReactTableProps, MRT_Column, MRT_ColumnDef, MRT_DefinedColumnDef, MRT_DisplayColumnIds, MRT_FilterOption } from '.';
+import { MRT_FilterFns } from './filterFns';
+import { MRT_SortingFns } from './sortingFns';
 export declare const defaultDisplayColumnDefOptions: Partial<MRT_ColumnDef<{}>>;
 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: MRT_ColumnDef<TData>[], currentFilterFns: {
+export declare const prepareColumns: <TData extends Record<string, any> = {}>(columnDefs: MRT_ColumnDef<TData>[], columnFilterFns: {
     [key: string]: MRT_FilterOption;
-}) => MRT_DefinedColumnDef<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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        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;
+        autoRemove(val: any): boolean;
+    };
+    includesString: import("@tanstack/table-core").FilterFn<any>;
+    includesStringSensitive: import("@tanstack/table-core").FilterFn<any>;
+    equalsString: import("@tanstack/table-core").FilterFn<any>;
+    arrIncludes: import("@tanstack/table-core").FilterFn<any>;
+    arrIncludesAll: import("@tanstack/table-core").FilterFn<any>;
+    arrIncludesSome: import("@tanstack/table-core").FilterFn<any>;
+    weakEquals: import("@tanstack/table-core").FilterFn<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;
+    alphanumeric: import("@tanstack/table-core").SortingFn<any>;
+    alphanumericCaseSensitive: import("@tanstack/table-core").SortingFn<any>;
+    text: import("@tanstack/table-core").SortingFn<any>;
+    textCaseSensitive: import("@tanstack/table-core").SortingFn<any>;
+    datetime: import("@tanstack/table-core").SortingFn<any>;
+    basic: import("@tanstack/table-core").SortingFn<any>;
+} & Record<string, import("@tanstack/table-core").SortingFn<any>>) => MRT_DefinedColumnDef<TData>[];
 export declare const reorderColumn: <TData extends Record<string, any> = {}>(draggedColumn: MRT_Column<TData>, targetColumn: MRT_Column<TData>, columnOrder: ColumnOrderState) => ColumnOrderState;
 export declare const getLeadingDisplayColumnIds: <TData extends Record<string, any> = {}>(props: MaterialReactTableProps<TData>) => MRT_DisplayColumnIds[];
 export declare const getTrailingDisplayColumnIds: <TData extends Record<string, any> = {}>(props: MaterialReactTableProps<TData>) => (string | false | undefined)[];