material-react-table 0.39.0 → 0.40.2

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 import { MutableRefObject, Dispatch, SetStateAction, ReactNode, DragEvent } from 'react';
 import { ButtonProps, TextFieldProps, TableCellProps, IconButtonProps, ToolbarProps, LinearProgressProps, CheckboxProps, SkeletonProps, TableBodyProps, TableRowProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, PaperProps, TableProps, ChipProps, AlertProps } from '@mui/material';
 import { Row, Table, TableState, ColumnDef, DeepKeys, Column, Header, HeaderGroup, Cell, SortingFn, FilterFn, TableOptions, OnChangeFn } from '@tanstack/react-table';
-import { Options } from 'react-virtual';
+import { Options, VirtualItem } from 'react-virtual';
 import * as _tanstack_table_core from '@tanstack/table-core';
 import { RankingInfo } from '@tanstack/match-sorter-utils';
 
@@ -697,11 +697,20 @@ declare type MaterialReactTableProps<TData extends Record<string, any> = {}> = O
     rowNumberMode?: 'original' | 'static';
     selectAllMode?: 'all' | 'page';
     state?: Partial<MRT_TableState<TData>>;
+    tableInstanceRef?: MutableRefObject<MRT_TableInstance<TData> | null>;
     virtualizerProps?: Partial<Options<HTMLDivElement>> | (({ table, }: {
         table: MRT_TableInstance<TData>;
     }) => Partial<Options<HTMLDivElement>>);
+    virtualizerInstanceRef?: MutableRefObject<Virtualizer | null>;
 };
-declare const _default: <TData extends Record<string, any> = {}>({ aggregationFns, autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableBottomToolbar, enableColumnActions, enableColumnFilterModes, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, enableGlobalFilterModes, 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;
+declare type Virtualizer = {
+    virtualItems: VirtualItem[];
+    totalSize: number;
+    scrollToOffset: (index: number, options?: any | undefined) => void;
+    scrollToIndex: (index: number, options?: any | undefined) => void;
+    measure: () => void;
+};
+declare const _default: <TData extends Record<string, any> = {}>({ aggregationFns, autoResetExpanded, columnResizeMode, defaultColumn, editingMode, enableBottomToolbar, enableColumnActions, enableColumnFilters, enableColumnOrdering, enableColumnResizing, enableDensityToggle, enableExpandAll, enableFilters, enableFullScreenToggle, enableGlobalFilter, 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;
 
 interface Props$6<TData extends Record<string, any> = {}> {
     cell: MRT_Cell<TData>;
@@ -740,4 +749,4 @@ interface Props<TData extends Record<string, any> = {}> extends IconButtonProps
 }
 declare const MRT_ToggleGlobalFilterButton: <TData extends Record<string, any> = {}>({ table, ...rest }: Props<TData>) => JSX.Element;
 
-export { MRT_Cell, MRT_Column, MRT_ColumnDef, MRT_CopyButton, MRT_DefinedColumnDef, MRT_DisplayColumnIds, MRT_FilterFn, MRT_FilterOption, MRT_FullScreenToggleButton, MRT_GlobalFilterTextField, MRT_Header, MRT_HeaderGroup, MRT_Icons, MRT_InternalFilterOption, MRT_Localization, MRT_Row, MRT_RowModel, MRT_ShowHideColumnsButton, MRT_SortingFn, MRT_SortingOption, MRT_TableInstance, MRT_TableState, MRT_ToggleDensePaddingButton, MRT_ToggleFiltersButton, MRT_ToggleGlobalFilterButton, MaterialReactTableProps, _default as default };
+export { MRT_Cell, MRT_Column, MRT_ColumnDef, MRT_CopyButton, MRT_DefinedColumnDef, MRT_DisplayColumnIds, MRT_FilterFn, MRT_FilterOption, MRT_FullScreenToggleButton, MRT_GlobalFilterTextField, MRT_Header, MRT_HeaderGroup, MRT_Icons, MRT_InternalFilterOption, MRT_Localization, MRT_Row, MRT_RowModel, MRT_ShowHideColumnsButton, MRT_SortingFn, MRT_SortingOption, MRT_TableInstance, MRT_TableState, MRT_ToggleDensePaddingButton, MRT_ToggleFiltersButton, MRT_ToggleGlobalFilterButton, MaterialReactTableProps, Virtualizer, _default as default };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.39.0",
+  "version": "0.40.2",
   "license": "MIT",
   "name": "material-react-table",
   "description": "A fully featured Material UI V5 implementation of TanStack React Table V8, written from the ground up in TypeScript.",
@@ -49,13 +49,13 @@
     "storybook": "start-storybook -p 6006"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.10",
+    "@babel/core": "^7.18.13",
     "@babel/preset-react": "^7.18.6",
     "@emotion/react": "^11.10.0",
     "@emotion/styled": "^11.10.0",
     "@faker-js/faker": "^7.4.0",
-    "@mui/icons-material": "^5.8.4",
-    "@mui/material": "^5.10.1",
+    "@mui/icons-material": "^5.10.2",
+    "@mui/material": "^5.10.2",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^8.3.4",

package/src/MaterialReactTable.tsx

@@ -40,7 +40,7 @@ import type {
   TableOptions,
   TableState,
 } from '@tanstack/react-table';
-import type { Options as VirtualizerOptions } from 'react-virtual';
+import type { Options as VirtualizerOptions, VirtualItem } from 'react-virtual';
 // import type { VirtualizerOptions } from '@tanstack/react-virtual';
 import { MRT_AggregationFns } from './aggregationFns';
 import { MRT_Default_Icons, MRT_Icons } from './icons';
@@ -841,6 +841,7 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> =
     rowNumberMode?: 'original' | 'static';
     selectAllMode?: 'all' | 'page';
     state?: Partial<MRT_TableState<TData>>;
+    tableInstanceRef?: MutableRefObject<MRT_TableInstance<TData> | null>;
     virtualizerProps?:
       | Partial<VirtualizerOptions<HTMLDivElement>>
       | (({
@@ -855,8 +856,17 @@ export type MaterialReactTableProps<TData extends Record<string, any> = {}> =
     //     }: {
     //       table: MRT_TableInstance<TData>;
     //     }) => Partial<VirtualizerOptions<HTMLDivElement, HTMLTableRowElement>>);
+    virtualizerInstanceRef?: MutableRefObject<Virtualizer | null>;
   };
 
+export type Virtualizer = {
+  virtualItems: VirtualItem[];
+  totalSize: number;
+  scrollToOffset: (index: number, options?: any | undefined) => void;
+  scrollToIndex: (index: number, options?: any | undefined) => void;
+  measure: () => void;
+};
+
 export default <TData extends Record<string, any> = {}>({
   aggregationFns,
   autoResetExpanded = false,
@@ -865,7 +875,6 @@ export default <TData extends Record<string, any> = {}>({
   editingMode = 'modal',
   enableBottomToolbar = true,
   enableColumnActions = true,
-  enableColumnFilterModes = false,
   enableColumnFilters = true,
   enableColumnOrdering = false,
   enableColumnResizing = false,
@@ -874,7 +883,6 @@ export default <TData extends Record<string, any> = {}>({
   enableFilters = true,
   enableFullScreenToggle = true,
   enableGlobalFilter = true,
-  enableGlobalFilterModes = false,
   enableGlobalFilterRankedResults = true,
   enableGrouping = false,
   enableHiding = true,
@@ -912,7 +920,6 @@ export default <TData extends Record<string, any> = {}>({
     editingMode={editingMode}
     enableBottomToolbar={enableBottomToolbar}
     enableColumnActions={enableColumnActions}
-    enableColumnFilterModes={enableColumnFilterModes}
     enableColumnFilters={enableColumnFilters}
     enableColumnOrdering={enableColumnOrdering}
     enableColumnResizing={enableColumnResizing}
@@ -921,7 +928,6 @@ export default <TData extends Record<string, any> = {}>({
     enableFilters={enableFilters}
     enableFullScreenToggle={enableFullScreenToggle}
     enableGlobalFilter={enableGlobalFilter}
-    enableGlobalFilterModes={enableGlobalFilterModes}
     enableGlobalFilterRankedResults={enableGlobalFilterRankedResults}
     enableGrouping={enableGrouping}
     enableHiding={enableHiding}

package/src/body/MRT_TableBody.tsx

@@ -1,5 +1,5 @@
-import React, { FC, RefObject, useMemo } from 'react';
-import { useVirtual } from 'react-virtual';
+import React, { FC, RefObject, useEffect, useMemo } from 'react';
+import { useVirtual } from 'react-virtual'; //stuck on v2 for now
 // import { useVirtualizer, Virtualizer } from '@tanstack/react-virtual';
 import { TableBody } from '@mui/material';
 import { MRT_TableBodyRow } from './MRT_TableBodyRow';
@@ -22,6 +22,7 @@ export const MRT_TableBody: FC<Props> = ({ table, tableContainerRef }) => {
       enableRowVirtualization,
       muiTableBodyProps,
       virtualizerProps,
+      virtualizerInstanceRef,
     },
   } = table;
   const { globalFilter, pagination, sorting } = getState();
@@ -62,7 +63,7 @@ export const MRT_TableBody: FC<Props> = ({ table, tableContainerRef }) => {
     globalFilter,
   ]);
 
-  const rowVirtualizer = enableRowVirtualization
+  const virtualizer = enableRowVirtualization
     ? useVirtual({
         size: rows.length,
         parentRef: tableContainerRef,
@@ -71,7 +72,13 @@ export const MRT_TableBody: FC<Props> = ({ table, tableContainerRef }) => {
       })
     : ({} as any);
 
-  // const rowVirtualizer: Virtualizer = enableRowVirtualization
+  useEffect(() => {
+    if (virtualizerInstanceRef) {
+      virtualizerInstanceRef.current = virtualizer;
+    }
+  }, [virtualizer]);
+
+  // const virtualizer: Virtualizer = enableRowVirtualization
   //   ? useVirtualizer({
   //       count: rows.length,
   //       estimateSize: () => (density === 'compact' ? 25 : 50),
@@ -81,12 +88,10 @@ export const MRT_TableBody: FC<Props> = ({ table, tableContainerRef }) => {
   //     })
   //   : ({} as any);
 
-  const virtualRows = enableRowVirtualization
-    ? rowVirtualizer.virtualItems
-    : [];
+  const virtualRows = enableRowVirtualization ? virtualizer.virtualItems : [];
 
   // const virtualRows = enableRowVirtualization
-  //   ? rowVirtualizer.getVirtualItems()
+  //   ? virtualizer.getVirtualItems()
   //   : [];
 
   let paddingTop = 0;
@@ -94,13 +99,13 @@ export const MRT_TableBody: FC<Props> = ({ table, tableContainerRef }) => {
   if (enableRowVirtualization) {
     paddingTop = !!virtualRows.length ? virtualRows[0].start : 0;
     paddingBottom = !!virtualRows.length
-      ? rowVirtualizer.totalSize - virtualRows[virtualRows.length - 1].end
+      ? virtualizer.totalSize - virtualRows[virtualRows.length - 1].end
       : 0;
   }
   // if (enableRowVirtualization) {
   //   paddingTop = !!virtualRows.length ? virtualRows[0].start : 0;
   //   paddingBottom = !!virtualRows.length
-  //     ? rowVirtualizer.getTotalSize() - virtualRows[virtualRows.length - 1].end
+  //     ? virtualizer.getTotalSize() - virtualRows[virtualRows.length - 1].end
   //     : 0;
   // }
 

package/src/body/MRT_TableBodyCell.tsx

@@ -109,7 +109,8 @@ export const MRT_TableBodyCell: FC<Props> = ({
     [isLoading, showSkeletons],
   );
 
-  const handleDoubleClick = (_event: MouseEvent<HTMLTableCellElement>) => {
+  const handleDoubleClick = (event: MouseEvent<HTMLTableCellElement>) => {
+    tableCellProps?.onDoubleClick?.(event);
     if (
       (enableEditing || columnDef.enableEditing) &&
       columnDef.enableEditing !== false &&
@@ -143,7 +144,8 @@ export const MRT_TableBodyCell: FC<Props> = ({
     );
   };
 
-  const handleDragEnter = (_e: DragEvent) => {
+  const handleDragEnter = (e: DragEvent<HTMLTableCellElement>) => {
+    tableCellProps?.onDragEnter?.(e);
     if (enableGrouping && hoveredColumn?.id === 'drop-zone') {
       setHoveredColumn(null);
     }
@@ -179,9 +181,9 @@ export const MRT_TableBodyCell: FC<Props> = ({
 
   return (
     <TableCell
-      onDoubleClick={handleDoubleClick}
-      onDragEnter={handleDragEnter}
       {...tableCellProps}
+      onDragEnter={handleDragEnter}
+      onDoubleClick={handleDoubleClick}
       sx={(theme) => ({
         backgroundColor: column.getIsPinned()
           ? alpha(lighten(theme.palette.background.default, 0.04), 0.95)

package/src/head/MRT_TableHeadCell.tsx

@@ -28,8 +28,13 @@ export const MRT_TableHeadCell: FC<Props> = ({ header, table }) => {
     },
     setHoveredColumn,
   } = table;
-  const { density, draggingColumn, hoveredColumn, showColumnFilters } =
-    getState();
+  const {
+    density,
+    draggingColumn,
+    grouping,
+    hoveredColumn,
+    showColumnFilters,
+  } = getState();
   const { column } = header;
   const { columnDef } = column;
   const { columnDefType } = columnDef;
@@ -221,17 +226,20 @@ export const MRT_TableHeadCell: FC<Props> = ({ header, table }) => {
           </Box>
           {columnDefType !== 'group' && (
             <Box sx={{ whiteSpace: 'nowrap' }}>
-              {((enableColumnDragging &&
-                columnDef.enableColumnDragging !== false) ||
-                (enableColumnOrdering &&
-                  columnDef.enableColumnOrdering !== false) ||
-                (enableGrouping && columnDef.enableGrouping !== false)) && (
-                <MRT_TableHeadCellGrabHandle
-                  column={column}
-                  table={table}
-                  tableHeadCellRef={tableHeadCellRef}
-                />
-              )}
+              {enableColumnDragging !== false &&
+                columnDef.enableColumnDragging !== false &&
+                (enableColumnDragging ||
+                  (enableColumnOrdering &&
+                    columnDef.enableColumnOrdering !== false) ||
+                  (enableGrouping &&
+                    columnDef.enableGrouping !== false &&
+                    !grouping.includes(column.id))) && (
+                  <MRT_TableHeadCellGrabHandle
+                    column={column}
+                    table={table}
+                    tableHeadCellRef={tableHeadCellRef}
+                  />
+                )}
               {(enableColumnActions || columnDef.enableColumnActions) &&
                 columnDef.enableColumnActions !== false && (
                   <MRT_TableHeadCellColumnActionsButton

package/src/menus/MRT_ShowHideColumnsMenuItems.tsx

@@ -84,7 +84,7 @@ export const MRT_ShowHideColumnsMenuItems = <
   };
 
   const handleDragEnter = (_e: DragEvent) => {
-    if (!isDragging) {
+    if (!isDragging && columnDef.enableColumnOrdering !== false) {
       setHoveredColumn(column);
     }
   };

package/src/table/MRT_TableRoot.tsx

@@ -1,4 +1,4 @@
-import React, { useMemo, useRef, useState } from 'react';
+import React, { useEffect, useMemo, useRef, useState } from 'react';
 import {
   TableState,
   getCoreRowModel,
@@ -134,7 +134,7 @@ export const MRT_TableRoot = <TData extends Record<string, any> = {}>(
               <MRT_ToggleRowActionMenuButton
                 cell={cell as any}
                 row={row as any}
-                table={table}
+                table={table as any}
               />
             ),
             header: props.localization?.actions,
@@ -146,11 +146,11 @@ export const MRT_TableRoot = <TData extends Record<string, any> = {}>(
           columnOrder.includes('mrt-row-expand') &&
             showExpandColumn(props, grouping) && {
               Cell: ({ row }) => (
-                <MRT_ExpandButton row={row as any} table={table} />
+                <MRT_ExpandButton row={row as any} table={table as any} />
               ),
               Header: () =>
                 props.enableExpandAll ? (
-                  <MRT_ExpandAllButton table={table} />
+                  <MRT_ExpandAllButton table={table as any} />
                 ) : null,
               header: props.localization?.expand,
               size: 60,
@@ -160,11 +160,11 @@ export const MRT_TableRoot = <TData extends Record<string, any> = {}>(
             },
           columnOrder.includes('mrt-row-select') && {
             Cell: ({ row }) => (
-              <MRT_SelectCheckbox row={row as any} table={table} />
+              <MRT_SelectCheckbox row={row as any} table={table as any} />
             ),
             Header: () =>
               props.enableSelectAll ? (
-                <MRT_SelectCheckbox selectAll table={table} />
+                <MRT_SelectCheckbox selectAll table={table as any} />
               ) : null,
             header: props.localization?.select,
             size: 60,
@@ -301,7 +301,13 @@ export const MRT_TableRoot = <TData extends Record<string, any> = {}>(
     setShowAlertBanner: props.onShowAlertBannerChange ?? setShowAlertBanner,
     setShowFilters: props.onShowFiltersChange ?? setShowFilters,
     setShowGlobalFilter: props.onShowGlobalFilterChange ?? setShowGlobalFilter,
-  } as MRT_TableInstance;
+  } as MRT_TableInstance<TData>;
+
+  useEffect(() => {
+    if (props.tableInstanceRef) {
+      props.tableInstanceRef.current = table;
+    }
+  }, [table]);
 
   return (
     <>
@@ -315,9 +321,9 @@ export const MRT_TableRoot = <TData extends Record<string, any> = {}>(
         open={isFullScreen}
         transitionDuration={400}
       >
-        <MRT_TablePaper table={table} />
+        <MRT_TablePaper table={table as any} />
       </Dialog>
-      {!isFullScreen && <MRT_TablePaper table={table} />}
+      {!isFullScreen && <MRT_TablePaper table={table as any} />}
       {editingRow && props.editingMode === 'modal' && (
         <MRT_EditRowModal row={editingRow as any} table={table} open />
       )}

package/src/toolbar/MRT_ToolbarDropZone.tsx

@@ -13,14 +13,22 @@ export const MRT_ToolbarDropZone: FC<Props> = ({ table }) => {
     setHoveredColumn,
   } = table;
 
-  const { draggingColumn, hoveredColumn } = getState();
+  const { draggingColumn, hoveredColumn, grouping } = getState();
 
   const handleDragEnter = (_event: DragEvent<HTMLDivElement>) => {
     setHoveredColumn({ id: 'drop-zone' });
   };
 
   return (
-    <Fade unmountOnExit mountOnEnter in={!!enableGrouping && !!draggingColumn}>
+    <Fade
+      unmountOnExit
+      mountOnEnter
+      in={
+        !!enableGrouping &&
+        !!draggingColumn &&
+        !grouping.includes(draggingColumn.id)
+      }
+    >
       <Box
         sx={(theme) => ({
           alignItems: 'center',