material-react-table 2.4.1 → 2.5.0

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.4.1",
+  "version": "2.5.0",
   "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.",

package/src/body/MRT_TableBodyCell.tsx

@@ -11,7 +11,6 @@ import Skeleton from '@mui/material/Skeleton';
 import TableCell, { type TableCellProps } from '@mui/material/TableCell';
 import { useTheme } from '@mui/material/styles';
 import { MRT_TableBodyCellValue } from './MRT_TableBodyCellValue';
-import { MRT_TableBodyRowGrabHandle } from './MRT_TableBodyRowGrabHandle';
 import { MRT_CopyButton } from '../buttons/MRT_CopyButton';
 import {
   getIsFirstColumn,
@@ -58,11 +57,9 @@ export const MRT_TableBodyCell = <TData extends MRT_RowData>({
       enableColumnOrdering,
       enableEditing,
       enableGrouping,
-      enableRowNumbers,
       layoutMode,
       muiSkeletonProps,
       muiTableBodyCellProps,
-      rowNumberDisplayMode,
     },
     refs: { editInputRefs },
     setEditingCell,
@@ -210,6 +207,11 @@ export const MRT_TableBodyCell = <TData extends MRT_RowData>({
     }
   };
 
+  const cellValueProps = {
+    cell,
+    table,
+  };
+
   return (
     <TableCell
       data-index={virtualColumnIndex}
@@ -286,25 +288,18 @@ export const MRT_TableBodyCell = <TData extends MRT_RowData>({
               width={skeletonWidth}
               {...skeletonProps}
             />
-          ) : enableRowNumbers &&
-            rowNumberDisplayMode === 'static' &&
-            column.id === 'mrt-row-numbers' ? (
-            rowIndex + 1
-          ) : column.id === 'mrt-row-drag' ? (
-            <MRT_TableBodyRowGrabHandle
-              row={row}
-              rowRef={rowRef}
-              table={table}
-            />
           ) : columnDefType === 'display' &&
-            (column.id === 'mrt-row-select' ||
-              column.id === 'mrt-row-expand' ||
+            (['mrt-row-expand', 'mrt-row-numbers', 'mrt-row-select'].includes(
+              column.id,
+            ) ||
               !row.getIsGrouped()) ? (
             columnDef.Cell?.({
               cell,
               column,
               renderedCellValue: cell.renderValue() as any,
               row,
+              rowRef,
+              staticRowIndex: rowIndex,
               table,
             })
           ) : isCreating || isEditing ? (
@@ -312,10 +307,10 @@ export const MRT_TableBodyCell = <TData extends MRT_RowData>({
           ) : (enableClickToCopy || columnDef.enableClickToCopy) &&
             columnDef.enableClickToCopy !== false ? (
             <MRT_CopyButton cell={cell} table={table}>
-              <MRT_TableBodyCellValue cell={cell} table={table} />
+              <MRT_TableBodyCellValue {...cellValueProps} />
             </MRT_CopyButton>
           ) : (
-            <MRT_TableBodyCellValue cell={cell} table={table} />
+            <MRT_TableBodyCellValue {...cellValueProps} />
           )}
           {cell.getIsGrouped() && !columnDef.GroupedCell && (
             <> ({row.subRows?.length})</>

package/src/body/MRT_TableBodyCellValue.tsx

@@ -1,4 +1,4 @@
-import { type ReactNode } from 'react';
+import { type ReactNode, type RefObject } from 'react';
 import Box from '@mui/material/Box';
 import { getMRTTheme } from '../style.utils';
 import {
@@ -12,11 +12,15 @@ const allowedTypes = ['string', 'number'];
 
 interface Props<TData extends MRT_RowData> {
   cell: MRT_Cell<TData>;
+  rowRef?: RefObject<HTMLTableRowElement>;
+  staticRowIndex?: number;
   table: MRT_TableInstance<TData>;
 }
 
 export const MRT_TableBodyCellValue = <TData extends MRT_RowData>({
   cell,
+  rowRef,
+  staticRowIndex,
   table,
 }: Props<TData>) => {
   const {
@@ -108,6 +112,8 @@ export const MRT_TableBodyCellValue = <TData extends MRT_RowData>({
       column,
       renderedCellValue,
       row,
+      rowRef,
+      staticRowIndex,
       table,
     });
   }

package/src/hooks/useMRT_DisplayColumns.tsx

@@ -1,4 +1,6 @@
-import { type RefObject, useMemo } from 'react';
+import { type ReactNode, type RefObject, useMemo } from 'react';
+import Stack from '@mui/material/Stack';
+import Tooltip from '@mui/material/Tooltip';
 import { MRT_TableBodyRowGrabHandle } from '../body';
 import { MRT_TableBodyRowPinButton } from '../body/MRT_TableBodyRowPinButton';
 import { MRT_ExpandAllButton } from '../buttons/MRT_ExpandAllButton';
@@ -63,6 +65,7 @@ export const useMRT_DisplayColumns = <TData extends MRT_RowData>(
       tableOptions.enableRowOrdering,
       tableOptions.enableRowSelection,
       tableOptions.enableSelectAll,
+      tableOptions.groupedColumnMode,
       tableOptions.localization,
       tableOptions.positionActionsColumn,
       tableOptions.renderDetailPanel,
@@ -158,11 +161,60 @@ function makeRowExpandColumn<TData extends MRT_RowData>(
     showExpandColumn(tableOptions, tableOptions.state?.grouping ?? grouping)
   ) {
     return {
-      Cell: ({ row, table }) => <MRT_ExpandButton row={row} table={table} />,
+      Cell: ({ cell, column, row, table }) => {
+        const expandButtonProps = { row, table };
+        const subRowsLength = row.subRows?.length;
+        if (
+          tableOptions.groupedColumnMode === 'remove' &&
+          row.groupingColumnId
+        ) {
+          return (
+            <Stack alignItems="center" flexDirection="row" gap="0.25rem">
+              <MRT_ExpandButton {...expandButtonProps} />
+              <Tooltip
+                enterDelay={1000}
+                enterNextDelay={1000}
+                placement="right"
+                title={table.getColumn(row.groupingColumnId).columnDef.header}
+              >
+                <span>{row.groupingValue as ReactNode}</span>
+              </Tooltip>
+              {!!subRowsLength && <span>({subRowsLength})</span>}
+            </Stack>
+          );
+        } else {
+          return (
+            <>
+              <MRT_ExpandButton {...expandButtonProps} />
+              {column.columnDef.GroupedCell?.({ cell, column, row, table })}
+            </>
+          );
+        }
+      },
       Header: tableOptions.enableExpandAll
-        ? ({ table }) => <MRT_ExpandAllButton table={table} />
+        ? ({ table }) => {
+            return (
+              <>
+                <MRT_ExpandAllButton table={table} />
+                {tableOptions.groupedColumnMode === 'remove' &&
+                  grouping
+                    .map(
+                      (groupedColumnId) =>
+                        table.getColumn(groupedColumnId).columnDef.header,
+                    )
+                    .join(', ')}
+              </>
+            );
+          }
         : undefined,
-      ...defaultDisplayColumnProps(tableOptions, id, 'expand'),
+      ...defaultDisplayColumnProps(
+        tableOptions,
+        id,
+        'expand',
+        tableOptions.groupedColumnMode === 'remove'
+          ? tableOptions?.defaultColumn?.size
+          : 60,
+      ),
     };
   }
   return null;
@@ -175,7 +227,13 @@ function makeRowSelectColumn<TData extends MRT_RowData>(
   const id: MRT_DisplayColumnIds = 'mrt-row-select';
   if (order.includes(id)) {
     return {
-      Cell: ({ row, table }) => <MRT_SelectCheckbox row={row} table={table} />,
+      Cell: ({ row, staticRowIndex, table }) => (
+        <MRT_SelectCheckbox
+          row={row}
+          staticRowIndex={staticRowIndex}
+          table={table}
+        />
+      ),
       Header:
         tableOptions.enableSelectAll && tableOptions.enableMultiRowSelection
           ? ({ table }) => <MRT_SelectCheckbox selectAll table={table} />
@@ -193,7 +251,10 @@ function makeRowNumbersColumn<TData extends MRT_RowData>(
   const id: MRT_DisplayColumnIds = 'mrt-row-numbers';
   if (order.includes(id) || tableOptions.enableRowNumbers)
     return {
-      Cell: ({ row }) => row.index + 1,
+      Cell: ({ row, staticRowIndex }) =>
+        ((tableOptions.rowNumberDisplayMode === 'static'
+          ? staticRowIndex
+          : row.index) ?? 0) + 1,
       Header: () => tableOptions.localization.rowNumber,
       ...defaultDisplayColumnProps(tableOptions, id, 'rowNumbers'),
     };

package/src/inputs/MRT_FilterTextField.tsx

@@ -465,6 +465,8 @@ export const MRT_FilterTextField = <TData extends MRT_RowData>({
         />
       ) : (
         <TextField
+          select={isSelectFilter || isMultiSelectFilter}
+          {...commonTextFieldProps}
           SelectProps={{
             displayEmpty: true,
             multiple: isMultiSelectFilter,
@@ -488,10 +490,9 @@ export const MRT_FilterTextField = <TData extends MRT_RowData>({
                     </Box>
                   )
               : undefined,
+            ...commonTextFieldProps.SelectProps,
           }}
           onChange={handleTextFieldChange}
-          select={isSelectFilter || isMultiSelectFilter}
-          {...commonTextFieldProps}
           value={filterValue ?? ''}
         >
           {(isSelectFilter || isMultiSelectFilter) && [

package/src/inputs/MRT_SelectCheckbox.tsx

@@ -1,4 +1,4 @@
-import { type MouseEvent } from 'react';
+import { type ChangeEvent, type MouseEvent } from 'react';
 import Checkbox, { type CheckboxProps } from '@mui/material/Checkbox';
 import Radio, { type RadioProps } from '@mui/material/Radio';
 import Tooltip from '@mui/material/Tooltip';
@@ -13,12 +13,14 @@ import {
 interface Props<TData extends MRT_RowData> extends CheckboxProps {
   row?: MRT_Row<TData>;
   selectAll?: boolean;
+  staticRowIndex?: number;
   table: MRT_TableInstance<TData>;
 }
 
 export const MRT_SelectCheckbox = <TData extends MRT_RowData>({
   row,
   selectAll,
+  staticRowIndex,
   table,
   ...rest
 }: Props<TData>) => {
@@ -39,18 +41,56 @@ export const MRT_SelectCheckbox = <TData extends MRT_RowData>({
   const checkboxProps = {
     ...(!row
       ? parseFromValuesOrFunc(muiSelectAllCheckboxProps, { table })
-      : parseFromValuesOrFunc(muiSelectCheckboxProps, { row, table })),
+      : parseFromValuesOrFunc(muiSelectCheckboxProps, {
+          row,
+          staticRowIndex,
+          table,
+        })),
     ...rest,
   };
 
+  const isStickySelection =
+    enableRowPinning && rowPinningDisplayMode?.includes('select');
+
   const allRowsSelected = selectAll
     ? selectAllMode === 'page'
       ? table.getIsAllPageRowsSelected()
       : table.getIsAllRowsSelected()
     : undefined;
 
+  const onSelectionChange = (
+    event: ChangeEvent<HTMLInputElement>,
+    row: MRT_Row<TData>,
+  ) => {
+    if (row.getIsAllSubRowsSelected()) {
+      row.subRows?.forEach((r) => r.toggleSelected(false));
+    }
+    row.getToggleSelectedHandler()(event);
+
+    if (isStickySelection) {
+      row.pin(
+        !row.getIsPinned() && event.target.checked
+          ? rowPinningDisplayMode?.includes('bottom')
+            ? 'bottom'
+            : 'top'
+          : false,
+      );
+    }
+  };
+
+  const onSelectAllChange = (event: ChangeEvent<HTMLInputElement>) => {
+    selectAllMode === 'all'
+      ? table.getToggleAllRowsSelectedHandler()(event)
+      : table.getToggleAllPageRowsSelectedHandler()(event);
+    if (isStickySelection) {
+      table.setRowPinning({ bottom: [], top: [] });
+    }
+  };
+
   const commonProps = {
-    checked: selectAll ? allRowsSelected : row?.getIsSelected(),
+    checked: selectAll
+      ? allRowsSelected
+      : row?.getIsSelected() || row?.getIsAllSubRowsSelected(),
     disabled:
       isLoading || (row && !row.getCanSelect()) || row?.id === 'mrt-row-create',
     inputProps: {
@@ -60,24 +100,7 @@ export const MRT_SelectCheckbox = <TData extends MRT_RowData>({
     },
     onChange: (event) => {
       event.stopPropagation();
-      row
-        ? row.getToggleSelectedHandler()(event)
-        : selectAllMode === 'all'
-          ? table.getToggleAllRowsSelectedHandler()(event)
-          : table.getToggleAllPageRowsSelectedHandler()(event);
-      if (enableRowPinning && rowPinningDisplayMode?.includes('select')) {
-        if (row) {
-          row.pin(
-            !row.getIsPinned() && event.target.checked
-              ? rowPinningDisplayMode?.includes('bottom')
-                ? 'bottom'
-                : 'top'
-              : false,
-          );
-        } else {
-          table.setRowPinning({ bottom: [], top: [] });
-        }
-      }
+      row ? onSelectionChange(event, row) : onSelectAllChange(event);
     },
     size: (density === 'compact' ? 'small' : 'medium') as 'medium' | 'small',
     ...checkboxProps,

package/src/menus/MRT_ShowHideColumnsMenuItems.tsx

@@ -89,8 +89,9 @@ export const MRT_ShowHideColumnsMenuItems = <TData extends MRT_RowData>({
     }
   };
 
-  if (!columnDef.header || columnDef.visibleInShowHideMenu === false)
+  if (!columnDef.header || columnDef.visibleInShowHideMenu === false) {
     return null;
+  }
 
   return (
     <>

package/src/toolbar/MRT_TopToolbar.tsx

@@ -36,11 +36,23 @@ export const MRT_TopToolbar = <TData extends MRT_RowData>({
   const { isFullScreen, showGlobalFilter } = getState();
 
   const isMobile = useMediaQuery('(max-width:720px)');
+  const isTablet = useMediaQuery('(max-width:1024px)');
 
   const toolbarProps = parseFromValuesOrFunc(muiTopToolbarProps, { table });
 
   const stackAlertBanner =
-    isMobile || !!renderTopToolbarCustomActions || showGlobalFilter;
+    isMobile ||
+    !!renderTopToolbarCustomActions ||
+    (showGlobalFilter && isTablet);
+
+  const globalFilterProps = {
+    sx: !isTablet
+      ? {
+          zIndex: 2,
+        }
+      : undefined,
+    table,
+  };
 
   return (
     <Box
@@ -83,7 +95,7 @@ export const MRT_TopToolbar = <TData extends MRT_RowData>({
         }}
       >
         {enableGlobalFilter && positionGlobalFilter === 'left' && (
-          <MRT_GlobalFilterTextField table={table} />
+          <MRT_GlobalFilterTextField {...globalFilterProps} />
         )}
         {renderTopToolbarCustomActions?.({ table }) ?? <span />}
         {enableToolbarInternalActions ? (
@@ -97,14 +109,14 @@ export const MRT_TopToolbar = <TData extends MRT_RowData>({
             }}
           >
             {enableGlobalFilter && positionGlobalFilter === 'right' && (
-              <MRT_GlobalFilterTextField table={table} />
+              <MRT_GlobalFilterTextField {...globalFilterProps} />
             )}
             <MRT_ToolbarInternalButtons table={table} />
           </Box>
         ) : (
           enableGlobalFilter &&
           positionGlobalFilter === 'right' && (
-            <MRT_GlobalFilterTextField table={table} />
+            <MRT_GlobalFilterTextField {...globalFilterProps} />
           )
         )}
       </Box>

package/src/types.ts

@@ -385,6 +385,7 @@ export type MRT_ColumnDef<TData extends MRT_RowData, TValue = unknown> = Omit<
     renderedCellValue: ReactNode;
     row: MRT_Row<TData>;
     rowRef?: RefObject<HTMLTableRowElement>;
+    staticRowIndex?: number;
     table: MRT_TableInstance<TData>;
   }) => ReactNode;
   Edit?: (props: {
@@ -674,10 +675,19 @@ export type MRT_HeaderGroup<TData extends MRT_RowData> = Omit<
 
 export type MRT_Row<TData extends MRT_RowData> = Omit<
   Row<TData>,
-  '_valuesCache' | 'getAllCells' | 'getVisibleCells' | 'subRows'
+  | '_valuesCache'
+  | 'getAllCells'
+  | 'getParentRow'
+  | 'getParentRows'
+  | 'getRow'
+  | 'getVisibleCells'
+  | 'subRows'
 > & {
   _valuesCache: Record<LiteralUnion<string & DeepKeys<TData>>, any>;
   getAllCells: () => MRT_Cell<TData>[];
+  getParentRow: () => MRT_Row<TData> | null;
+  getParentRows: () => MRT_Row<TData>[];
+  getRow: () => MRT_Row<TData>;
   getVisibleCells: () => MRT_Cell<TData>[];
   subRows?: MRT_Row<TData>[];
 };
@@ -996,6 +1006,7 @@ export type MRT_TableOptions<TData extends MRT_RowData> = Omit<
   muiSelectCheckboxProps?:
     | ((props: {
         row: MRT_Row<TData>;
+        staticRowIndex?: number;
         table: MRT_TableInstance<TData>;
       }) => CheckboxProps | RadioProps)
     | (CheckboxProps | RadioProps);