material-react-table 0.5.6 → 0.5.9

package/src/menus/MRT_ColumnActionMenu.tsx

@@ -1,17 +1,19 @@
 import React, { FC, useState } from 'react';
-import {
-  IconButton,
-  ListItemIcon,
-  ListItemText,
-  Menu,
-  MenuItem,
-} from '@mui/material';
+import { Box, IconButton, Menu, MenuItem } from '@mui/material';
 import { useMRT } from '../useMRT';
-import { MRT_HeaderGroup } from '..';
+import type { MRT_HeaderGroup } from '..';
 import { MRT_FilterTypeMenu } from './MRT_FilterTypeMenu';
 
-const commonMenuItemStyles = {
+export const commonMenuItemStyles = {
+  py: '6px',
+  my: 0,
+  justifyContent: 'space-between',
+  alignItems: 'center',
+};
+
+export const commonListItemStyles = {
   display: 'flex',
+  gap: '0.75rem',
   alignItems: 'center',
 };
 
@@ -36,6 +38,7 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
       ClearAllIcon,
       DynamicFeedIcon,
       FilterListIcon,
+      FilterListOffIcon,
       SortIcon,
       VisibilityOffIcon,
     },
@@ -73,6 +76,11 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
     setAnchorEl(null);
   };
 
+  const handleClearFilter = () => {
+    column.setFilter('');
+    setAnchorEl(null);
+  };
+
   const handleFilterByColumn = () => {
     setShowFilters(true);
     setTimeout(
@@ -101,23 +109,20 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
       onClose={() => setAnchorEl(null)}
       MenuListProps={{
         dense: tableInstance.state.densePadding,
-        disablePadding: true,
       }}
     >
       {!disableSortBy &&
         column.canSort && [
           <MenuItem
-            key={1}
             disabled={!column.isSorted}
+            key={1}
             onClick={handleClearSort}
             sx={commonMenuItemStyles}
           >
-            <ListItemIcon>
+            <Box sx={commonListItemStyles}>
               <ClearAllIcon />
-            </ListItemIcon>
-            <ListItemText>
               {localization.columnActionMenuItemClearSort}
-            </ListItemText>
+            </Box>
           </MenuItem>,
           <MenuItem
             disabled={column.isSorted && !column.isSortedDesc}
@@ -125,15 +130,13 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
             onClick={handleSortAsc}
             sx={commonMenuItemStyles}
           >
-            <ListItemIcon>
+            <Box sx={commonListItemStyles}>
               <SortIcon />
-            </ListItemIcon>
-            <ListItemText>
               {localization.columnActionMenuItemSortAsc?.replace(
                 '{column}',
                 String(column.Header),
               )}
-            </ListItemText>
+            </Box>
           </MenuItem>,
           <MenuItem
             divider={
@@ -144,42 +147,51 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
             onClick={handleSortDesc}
             sx={commonMenuItemStyles}
           >
-            <ListItemIcon>
+            <Box sx={commonListItemStyles}>
               <SortIcon style={{ transform: 'rotate(180deg) scaleX(-1)' }} />
-            </ListItemIcon>
-            <ListItemText>
               {localization.columnActionMenuItemSortDesc?.replace(
                 '{column}',
                 String(column.Header),
               )}
-            </ListItemText>
+            </Box>
           </MenuItem>,
         ]}
       {!disableFilters &&
         column.canFilter && [
+          <MenuItem
+            disabled={!column.filterValue}
+            key={0}
+            onClick={handleClearFilter}
+            sx={commonMenuItemStyles}
+          >
+            <Box sx={commonListItemStyles}>
+              <FilterListOffIcon />
+              {localization.filterTextFieldClearButtonTitle}
+            </Box>
+          </MenuItem>,
           <MenuItem
             divider={enableColumnGrouping || !disableColumnHiding}
             key={1}
             onClick={handleFilterByColumn}
             sx={commonMenuItemStyles}
           >
-            <ListItemIcon>
+            <Box sx={commonListItemStyles}>
               <FilterListIcon />
-            </ListItemIcon>
-            <ListItemText>
               {localization.filterTextFieldPlaceholder?.replace(
                 '{column}',
                 String(column.Header),
               )}
-            </ListItemText>
-            <IconButton
-              onClick={handleOpenFilterModeMenu}
-              onMouseEnter={handleOpenFilterModeMenu}
-              size="small"
-              sx={{ p: 0 }}
-            >
-              <ArrowRightIcon />
-            </IconButton>
+            </Box>
+            {!column.filterSelectOptions && (
+              <IconButton
+                onClick={handleOpenFilterModeMenu}
+                onMouseEnter={handleOpenFilterModeMenu}
+                size="small"
+                sx={{ p: 0 }}
+              >
+                <ArrowRightIcon />
+              </IconButton>
+            )}
           </MenuItem>,
           <MRT_FilterTypeMenu
             anchorEl={filterMenuAnchorEl}
@@ -197,29 +209,25 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
             onClick={handleGroupByColumn}
             sx={commonMenuItemStyles}
           >
-            <ListItemIcon>
+            <Box sx={commonListItemStyles}>
               <DynamicFeedIcon />
-            </ListItemIcon>
-            <ListItemText>
               {localization[
                 column.isGrouped
                   ? 'columnActionMenuItemUnGroupBy'
                   : 'columnActionMenuItemGroupBy'
               ]?.replace('{column}', String(column.Header))}
-            </ListItemText>
+            </Box>
           </MenuItem>,
         ]}
       {!disableColumnHiding && [
         <MenuItem key={1} onClick={handleHideColumn} sx={commonMenuItemStyles}>
-          <ListItemIcon>
+          <Box sx={commonListItemStyles}>
             <VisibilityOffIcon />
-          </ListItemIcon>
-          <ListItemText>
             {localization.columnActionMenuItemHideColumn?.replace(
               '{column}',
               String(column.Header),
             )}
-          </ListItemText>
+          </Box>
         </MenuItem>,
       ]}
     </Menu>

package/src/menus/MRT_FilterTypeMenu.tsx

@@ -1,7 +1,26 @@
 import React, { FC, useMemo } from 'react';
 import { Menu, MenuItem } from '@mui/material';
 import { useMRT } from '../useMRT';
-import { MRT_FilterType, MRT_HeaderGroup } from '..';
+import type { MRT_FilterType, MRT_HeaderGroup } from '..';
+import { MRT_FILTER_TYPE } from '../enums';
+import {
+  containsFilterFN,
+  emptyFilterFN,
+  endsWithFilterFN,
+  equalsFilterFN,
+  fuzzyFilterFN,
+  greaterThanFilterFN,
+  lessThanFilterFN,
+  notEmptyFilterFN,
+  notEqualsFilterFN,
+  startsWithFilterFN,
+} from '../filtersFNs';
+
+const commonMenuItemStyles = {
+  py: '6px',
+  my: 0,
+  alignItems: 'center',
+};
 
 interface Props {
   anchorEl: HTMLElement | null;
@@ -19,62 +38,83 @@ export const MRT_FilterTypeMenu: FC<Props> = ({
   const { localization, setCurrentFilterTypes, tableInstance } = useMRT();
 
   const filterTypes: {
-    type: MRT_FilterType;
+    type: MRT_FILTER_TYPE;
     label: string;
     divider: boolean;
+    fn: Function;
   }[] = useMemo(
     () => [
       {
-        type: 'fuzzy',
+        type: MRT_FILTER_TYPE.FUZZY,
         label: localization.filterMenuItemFuzzy,
         divider: false,
+        fn: fuzzyFilterFN,
       },
       {
-        type: 'contains',
+        type: MRT_FILTER_TYPE.CONTAINS,
         label: localization.filterMenuItemContains,
         divider: true,
+        fn: containsFilterFN,
       },
       {
-        type: 'startsWith',
+        type: MRT_FILTER_TYPE.STARTS_WITH,
         label: localization.filterMenuItemStartsWith,
         divider: false,
+        fn: startsWithFilterFN,
       },
       {
-        type: 'endsWith',
+        type: MRT_FILTER_TYPE.ENDS_WITH,
         label: localization.filterMenuItemEndsWith,
         divider: true,
+        fn: endsWithFilterFN,
       },
       {
-        type: 'equals',
+        type: MRT_FILTER_TYPE.EQUALS,
         label: localization.filterMenuItemEquals,
         divider: false,
+        fn: equalsFilterFN,
       },
       {
-        type: 'notEquals',
+        type: MRT_FILTER_TYPE.NOT_EQUALS,
         label: localization.filterMenuItemNotEquals,
         divider: true,
+        fn: notEqualsFilterFN,
+      },
+      {
+        type: MRT_FILTER_TYPE.GREATER_THAN,
+        label: localization.filterMenuItemGreaterThan,
+        divider: false,
+        fn: greaterThanFilterFN,
+      },
+      {
+        type: MRT_FILTER_TYPE.LESS_THAN,
+        label: localization.filterMenuItemLessThan,
+        divider: true,
+        fn: lessThanFilterFN,
       },
       {
-        type: 'empty',
+        type: MRT_FILTER_TYPE.EMPTY,
         label: localization.filterMenuItemEmpty,
         divider: false,
+        fn: emptyFilterFN,
       },
       {
-        type: 'notEmpty',
+        type: MRT_FILTER_TYPE.NOT_EMPTY,
         label: localization.filterMenuItemNotEmpty,
         divider: false,
+        fn: notEmptyFilterFN,
       },
     ],
     [],
   );
 
-  const handleSelectFilterType = (value: MRT_FilterType) => {
+  const handleSelectFilterType = (value: MRT_FILTER_TYPE) => {
     setAnchorEl(null);
     setCurrentFilterTypes((prev: { [key: string]: MRT_FilterType }) => ({
       ...prev,
       [column.id]: value,
     }));
-    if (['empty', 'notEmpty'].includes(value)) {
+    if ([MRT_FILTER_TYPE.EMPTY, MRT_FILTER_TYPE.NOT_EMPTY].includes(value)) {
       column.setFilter(' ');
     }
     onSelect?.();
@@ -90,15 +130,15 @@ export const MRT_FilterTypeMenu: FC<Props> = ({
       open={!!anchorEl}
       MenuListProps={{
         dense: tableInstance.state.densePadding,
-        disablePadding: true,
       }}
     >
-      {filterTypes.map(({ type, label, divider }) => (
+      {filterTypes.map(({ type, label, divider, fn }, index) => (
         <MenuItem
           divider={divider}
-          key={type}
+          key={index}
           onClick={() => handleSelectFilterType(type)}
-          selected={type === filterType}
+          selected={type === filterType || fn === filterType}
+          sx={commonMenuItemStyles}
           value={type}
         >
           {label}

package/src/menus/MRT_RowActionMenu.tsx

@@ -1,7 +1,8 @@
 import React, { FC } from 'react';
-import { ListItemIcon, ListItemText, Menu, MenuItem } from '@mui/material';
+import { Menu, MenuItem } from '@mui/material';
 import { useMRT } from '../useMRT';
-import { MRT_Row } from '..';
+import type { MRT_Row } from '..';
+import { commonMenuItemStyles } from './MRT_ColumnActionMenu';
 
 interface Props {
   anchorEl: HTMLElement | null;
@@ -31,15 +32,12 @@ export const MRT_RowActionMenu: FC<Props> = ({
       onClose={() => setAnchorEl(null)}
       MenuListProps={{
         dense: tableInstance.state.densePadding,
-        disablePadding: true,
       }}
     >
       {enableRowEditing && (
-        <MenuItem onClick={handleEdit}>
-          <ListItemIcon>
-            <EditIcon />
-          </ListItemIcon>
-          <ListItemText>{localization.rowActionMenuItemEdit}</ListItemText>
+        <MenuItem onClick={handleEdit} sx={commonMenuItemStyles}>
+          <EditIcon />
+          {localization.rowActionMenuItemEdit}
         </MenuItem>
       )}
       {renderRowActionMenuItems?.(row, tableInstance, () =>

package/src/menus/MRT_ShowHideColumnsMenu.tsx

@@ -1,7 +1,8 @@
 import React, { FC } from 'react';
 import { FormControlLabel, MenuItem, Switch } from '@mui/material';
 import { ColumnInstance } from 'react-table';
-import { MRT_ColumnInstance } from '..';
+import type { MRT_ColumnInstance } from '..';
+import { commonMenuItemStyles } from './MRT_ColumnActionMenu';
 
 interface Props {
   column: MRT_ColumnInstance;
@@ -28,8 +29,11 @@ export const MRT_ShowHideColumnsMenu: FC<Props> = ({ column }) => {
 
   return (
     <>
-      <MenuItem sx={{ pl: `${(column.depth + 0.5) * 2}rem` }}>
+      <MenuItem
+        sx={{ ...commonMenuItemStyles, pl: `${(column.depth + 0.5) * 2}rem` }}
+      >
         <FormControlLabel
+          componentsProps={{ typography: { sx: { marginBottom: 0 } } }}
           checked={switchChecked}
           control={<Switch />}
           label={column.Header as string}

package/src/useMRT.tsx

@@ -21,7 +21,8 @@ import {
   useSortBy,
   useTable,
 } from 'react-table';
-import { MRT_FilterType, MRT_Row, MRT_TableInstance } from '.';
+import type { MRT_FilterType, MRT_Row, MRT_TableInstance } from '.';
+import { MRT_FILTER_TYPE } from './enums';
 import { defaultFilterFNs } from './filtersFNs';
 import { MRT_Icons } from './icons';
 import { MRT_Localization } from './localization';
@@ -81,7 +82,9 @@ export const MaterialReactTableProvider = <D extends {} = {}>(
     props.initialState?.showSearch ?? false,
   );
 
-  const filterTypes = useMemo<Partial<{ [key in MRT_FilterType]: any }>>(
+  const filterTypes = useMemo<{
+    [key in MRT_FILTER_TYPE]: any;
+  }>(
     () => ({
       ...defaultFilterFNs,
       ...props.filterTypes,
@@ -89,25 +92,43 @@ export const MaterialReactTableProvider = <D extends {} = {}>(
     [props.filterTypes],
   );
 
+  const getInitialFilterTypeState = () => {
+    let lowestLevelColumns: any[] = props.columns;
+    let currentCols: any[] = props.columns;
+    while (!!currentCols.length && currentCols.some((col) => col.columns)) {
+      const nextCols = currentCols
+        .filter((col) => !!col.columns)
+        .map((col) => col.columns)
+        .flat();
+      if (nextCols.every((col) => !col.columns)) {
+        lowestLevelColumns = [...lowestLevelColumns, ...nextCols];
+      }
+      currentCols = nextCols;
+    }
+    lowestLevelColumns = lowestLevelColumns.filter((col) => !col.columns);
+
+    return Object.assign(
+      {},
+      ...lowestLevelColumns.map((c) => ({
+        [c.accessor as string]:
+          c.filter ??
+          props?.initialState?.filters?.[c.accessor as any] ??
+          (!!c.filterSelectOptions ? 'equals' : 'fuzzy'),
+      })),
+    );
+  };
+
   const [currentFilterTypes, setCurrentFilterTypes] = useState<{
     [key: string]: MRT_FilterType;
-  }>(() =>
-    Object.assign(
-      {},
-      ...props.columns
-        .map((c) => c.accessor?.toString() as string)
-        .map((accessor) => ({
-          [accessor]:
-            props?.initialState?.filters?.[accessor as any] ?? 'fuzzy',
-        })),
-    ),
-  );
+  }>(() => getInitialFilterTypeState());
 
   const columns = useMemo(
     () =>
       props.columns.map((column) => {
         column.filter =
-          filterTypes[currentFilterTypes[column.accessor as string]];
+          filterTypes[
+            currentFilterTypes[column.accessor as string] as MRT_FILTER_TYPE
+          ];
         return column;
       }),
     [props.columns, filterTypes, currentFilterTypes],
@@ -119,6 +140,7 @@ export const MaterialReactTableProvider = <D extends {} = {}>(
       columns,
       // @ts-ignore
       filterTypes,
+      globalFilterValue: 'fuzzy',
       useControlledState: (state) =>
         useMemo(
           () => ({