material-react-table 0.5.3 → 0.5.4

package/src/localization.ts

@@ -11,6 +11,15 @@ export interface MRT_Localization {
   columnShowHideMenuShowAll: string;
   expandAllButtonTitle: string;
   expandButtonTitle: string;
+  filterMenuItemContains: string;
+  filterMenuItemEmpty: string;
+  filterMenuItemEndsWith: string;
+  filterMenuItemEquals: string;
+  filterMenuItemFuzzy: string;
+  filterMenuItemNotEmpty: string;
+  filterMenuItemNotEquals: string;
+  filterMenuItemStartsWith: string;
+  filterMenuTitle: string;
   filterTextFieldClearButtonTitle: string;
   filterTextFieldPlaceholder: string;
   rowActionButtonCancel: string;
@@ -27,9 +36,9 @@ export interface MRT_Localization {
   toggleFilterButtonTitle: string;
   toggleFullScreenButtonTitle: string;
   toggleSearchButtonTitle: string;
-  toolbarAlertSelectionMessage: string;
   toolbarAlertGroupedByMessage: string;
   toolbarAlertGroupedThenByMessage: string;
+  toolbarAlertSelectionMessage: string;
 }
 
 export const MRT_DefaultLocalization_EN: MRT_Localization = {
@@ -45,6 +54,15 @@ export const MRT_DefaultLocalization_EN: MRT_Localization = {
   columnShowHideMenuShowAll: 'Show all',
   expandAllButtonTitle: 'Expand all',
   expandButtonTitle: 'Expand',
+  filterMenuItemContains: 'Contains Exact',
+  filterMenuItemEmpty: 'Empty',
+  filterMenuItemEndsWith: 'Ends With',
+  filterMenuItemEquals: 'Equals',
+  filterMenuItemFuzzy: 'Fuzzy Match',
+  filterMenuItemNotEmpty: 'Not Empty',
+  filterMenuItemNotEquals: 'Not Equals',
+  filterMenuItemStartsWith: 'Starts With',
+  filterMenuTitle: 'Filter Mode',
   filterTextFieldClearButtonTitle: 'Clear filter',
   filterTextFieldPlaceholder: 'Filter by {column}',
   rowActionButtonCancel: 'Cancel',
@@ -61,7 +79,7 @@ export const MRT_DefaultLocalization_EN: MRT_Localization = {
   toggleFilterButtonTitle: 'Toggle filters',
   toggleFullScreenButtonTitle: 'Toggle full screen',
   toggleSearchButtonTitle: 'Toggle search',
-  toolbarAlertSelectionMessage: '{selectedCount} of {rowCount} row(s) selected',
   toolbarAlertGroupedByMessage: 'Grouped by ',
   toolbarAlertGroupedThenByMessage: ', then by ',
+  toolbarAlertSelectionMessage: '{selectedCount} of {rowCount} row(s) selected',
 };

package/src/menus/MRT_ColumnActionMenu.tsx

@@ -1,12 +1,17 @@
-import React, { FC } from 'react';
-import { Divider, Menu, MenuItem } from '@mui/material';
+import React, { FC, useState } from 'react';
+import {
+  Divider,
+  IconButton,
+  ListItemIcon,
+  ListItemText,
+  Menu,
+  MenuItem,
+  MenuList,
+} from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_HeaderGroup } from '..';
-
-const commonMenuItemStyles = {
-  display: 'flex',
-  gap: '0.75rem',
-};
+import { MRT_FilterMenu } from './MRT_FilterMenu';
+import ArrowRightIcon from '@mui/icons-material/ArrowRight';
 
 interface Props {
   anchorEl: HTMLElement | null;
@@ -24,17 +29,21 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
     disableFilters,
     disableSortBy,
     enableColumnGrouping,
-    localization,
-    setShowFilters,
     icons: {
-      FilterListIcon,
-      SortIcon,
       ClearAllIcon,
       DynamicFeedIcon,
+      FilterListIcon,
+      SortIcon,
       VisibilityOffIcon,
     },
+    idPrefix,
+    localization,
+    setShowFilters,
   } = useMRT();
 
+  const [filterMenuAnchorEl, setFilterMenuAnchorEl] =
+    useState<null | HTMLElement>(null);
+
   const handleClearSort = () => {
     column.clearSortBy();
     setAnchorEl(null);
@@ -68,7 +77,7 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
           .getElementById(
             // @ts-ignore
             column.muiTableHeadCellFilterTextFieldProps?.id ??
-              `filter-${column.id}-column`,
+              `mrt-${idPrefix}-${column.id}-filter-text-field`,
           )
           ?.focus(),
       200,
@@ -76,88 +85,119 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
     setAnchorEl(null);
   };
 
+  const handleOpenFilterModeMenu = (event: React.MouseEvent<HTMLElement>) => {
+    event.stopPropagation();
+    setFilterMenuAnchorEl(event.currentTarget);
+  };
+
   return (
     <Menu
       anchorEl={anchorEl}
       open={!!anchorEl}
       onClose={() => setAnchorEl(null)}
     >
-      {!disableSortBy &&
-        column.canSort && [
-          <MenuItem
-            key={1}
-            disabled={!column.isSorted}
-            onClick={handleClearSort}
-            sx={commonMenuItemStyles}
-          >
-            <ClearAllIcon /> {localization.columnActionMenuItemClearSort}
-          </MenuItem>,
-          <MenuItem
-            key={2}
-            disabled={column.isSorted && !column.isSortedDesc}
-            onClick={handleSortAsc}
-            sx={commonMenuItemStyles}
-          >
-            <SortIcon />{' '}
-            {localization.columnActionMenuItemSortAsc?.replace(
-              '{column}',
-              String(column.Header),
-            )}
-          </MenuItem>,
-          <MenuItem
-            key={3}
-            disabled={column.isSorted && column.isSortedDesc}
-            onClick={handleSortDesc}
-            sx={commonMenuItemStyles}
-          >
-            <SortIcon style={{ transform: 'rotate(180deg) scaleX(-1)' }} />{' '}
-            {localization.columnActionMenuItemSortDesc?.replace(
-              '{column}',
-              String(column.Header),
-            )}
-          </MenuItem>,
-        ]}
-      {!disableFilters &&
-        column.canFilter && [
+      <MenuList>
+        {!disableSortBy &&
+          column.canSort && [
+            <MenuItem
+              key={1}
+              disabled={!column.isSorted}
+              onClick={handleClearSort}
+            >
+              <ListItemIcon>
+                <ClearAllIcon />
+              </ListItemIcon>
+              <ListItemText>
+                {localization.columnActionMenuItemClearSort}
+              </ListItemText>
+            </MenuItem>,
+            <MenuItem
+              key={2}
+              disabled={column.isSorted && !column.isSortedDesc}
+              onClick={handleSortAsc}
+            >
+              <ListItemIcon>
+                <SortIcon />
+              </ListItemIcon>
+              <ListItemText>
+                {localization.columnActionMenuItemSortAsc?.replace(
+                  '{column}',
+                  String(column.Header),
+                )}
+              </ListItemText>
+            </MenuItem>,
+            <MenuItem
+              key={3}
+              disabled={column.isSorted && column.isSortedDesc}
+              onClick={handleSortDesc}
+            >
+              <ListItemIcon>
+                <SortIcon style={{ transform: 'rotate(180deg) scaleX(-1)' }} />
+              </ListItemIcon>
+              <ListItemText>
+                {localization.columnActionMenuItemSortDesc?.replace(
+                  '{column}',
+                  String(column.Header),
+                )}
+              </ListItemText>
+            </MenuItem>,
+          ]}
+        {!disableFilters &&
+          column.canFilter && [
+            <Divider key={0} />,
+            <MenuItem key={1} onClick={handleFilterByColumn}>
+              <ListItemIcon>
+                <FilterListIcon />
+              </ListItemIcon>
+              <ListItemText>
+                {localization.filterTextFieldPlaceholder?.replace(
+                  '{column}',
+                  String(column.Header),
+                )}
+              </ListItemText>
+              <IconButton size="small" onMouseEnter={handleOpenFilterModeMenu}>
+                <ArrowRightIcon />
+              </IconButton>
+            </MenuItem>,
+            <MRT_FilterMenu
+              anchorEl={filterMenuAnchorEl}
+              column={column}
+              key={2}
+              setAnchorEl={setFilterMenuAnchorEl}
+              onSelect={handleFilterByColumn}
+            />,
+          ]}
+        {enableColumnGrouping &&
+          column.canGroupBy && [
+            <Divider key={1} />,
+            <MenuItem key={2} onClick={handleGroupByColumn}>
+              <ListItemIcon>
+                <DynamicFeedIcon />
+              </ListItemIcon>
+              <ListItemText>
+                {localization[
+                  column.isGrouped
+                    ? 'columnActionMenuItemUnGroupBy'
+                    : 'columnActionMenuItemGroupBy'
+                ]?.replace('{column}', String(column.Header))}
+              </ListItemText>
+            </MenuItem>,
+          ]}
+        {!disableColumnHiding && [
           <Divider key={0} />,
-          <MenuItem
-            key={1}
-            onClick={handleFilterByColumn}
-            sx={commonMenuItemStyles}
-          >
-            <FilterListIcon />{' '}
-            {localization.filterTextFieldPlaceholder?.replace(
-              '{column}',
-              String(column.Header),
-            )}
-          </MenuItem>,
-        ]}
-      {enableColumnGrouping &&
-        column.canGroupBy && [
-          <Divider key={1} />,
-          <MenuItem
-            key={2}
-            onClick={handleGroupByColumn}
-            sx={commonMenuItemStyles}
-          >
-            <DynamicFeedIcon />{' '}
-            {localization[
-              column.isGrouped
-                ? 'columnActionMenuItemUnGroupBy'
-                : 'columnActionMenuItemGroupBy'
-            ]?.replace('{column}', String(column.Header))}
+          <MenuItem key={1} onClick={handleHideColumn}>
+            <ListItemIcon>
+              <VisibilityOffIcon />
+            </ListItemIcon>
+            <ListItemText>
+              {localization.columnActionMenuItemHideColumn?.replace(
+                '{column}',
+                String(column.Header),
+              )}
+            </ListItemText>
           </MenuItem>,
         ]}
-      {!disableColumnHiding && [
-        <Divider key={0} />,
-        <MenuItem key={1} onClick={handleHideColumn} sx={commonMenuItemStyles}>
-          <VisibilityOffIcon />{' '}
-          {localization.columnActionMenuItemHideColumn?.replace(
-            '{column}',
-            String(column.Header),
-          )}
-        </MenuItem>,
-      ]}
+      </MenuList>
     </Menu>
   );
 };

package/src/menus/MRT_FilterMenu.tsx

@@ -0,0 +1,109 @@
+import React, { FC, useMemo } from 'react';
+import { Divider, Menu, MenuItem, Typography } from '@mui/material';
+import { useMRT } from '../useMRT';
+import { MRT_FilterType, MRT_HeaderGroup } from '..';
+
+interface Props {
+  anchorEl: HTMLElement | null;
+  column: MRT_HeaderGroup;
+  setAnchorEl: (anchorEl: HTMLElement | null) => void;
+  onSelect?: () => void;
+}
+
+export const MRT_FilterMenu: FC<Props> = ({
+  anchorEl,
+  column,
+  onSelect,
+  setAnchorEl,
+}) => {
+  const { localization, setCurrentFilterTypes, tableInstance } = useMRT();
+
+  const filterTypes: {
+    type: MRT_FilterType;
+    label: string;
+    divider: boolean;
+  }[] = useMemo(
+    () => [
+      {
+        type: 'fuzzy',
+        label: localization.filterMenuItemFuzzy,
+        divider: false,
+      },
+      {
+        type: 'contains',
+        label: localization.filterMenuItemContains,
+        divider: true,
+      },
+      {
+        type: 'startsWith',
+        label: localization.filterMenuItemStartsWith,
+        divider: false,
+      },
+      {
+        type: 'endsWith',
+        label: localization.filterMenuItemEndsWith,
+        divider: true,
+      },
+      {
+        type: 'equals',
+        label: localization.filterMenuItemEquals,
+        divider: false,
+      },
+      {
+        type: 'notEquals',
+        label: localization.filterMenuItemNotEquals,
+        divider: true,
+      },
+      {
+        type: 'empty',
+        label: localization.filterMenuItemEmpty,
+        divider: false,
+      },
+      {
+        type: 'notEmpty',
+        label: localization.filterMenuItemNotEmpty,
+        divider: false,
+      },
+    ],
+    [],
+  );
+
+  const handleSelectMenuItem = (value: MRT_FilterType) => {
+    setAnchorEl(null);
+    setCurrentFilterTypes((prev: { [key: string]: MRT_FilterType }) => ({
+      ...prev,
+      [column.id]: value,
+    }));
+    if (['empty', 'notEmpty'].includes(value)) {
+      column.setFilter(' ');
+    }
+    onSelect?.();
+  };
+
+  const filterType = tableInstance.state.currentFilterTypes[column.id];
+
+  return (
+    <Menu
+      anchorEl={anchorEl}
+      open={!!anchorEl}
+      anchorOrigin={{ vertical: 'center', horizontal: 'right' }}
+      onClose={() => setAnchorEl(null)}
+    >
+      <Typography sx={{ fontWeight: 'bold', p: '1rem', fontSize: '1.1rem' }}>
+        {localization.filterMenuTitle}
+      </Typography>
+      <Divider />
+      {filterTypes.map(({ type, label, divider }) => (
+        <MenuItem
+          divider={divider}
+          key={type}
+          onClick={() => handleSelectMenuItem(type)}
+          selected={type === filterType}
+          value={type}
+        >
+          {label}
+        </MenuItem>
+      ))}
+    </Menu>
+  );
+};

package/src/useMRT.tsx

@@ -5,6 +5,8 @@ import React, {
   useContext,
   useMemo,
   useState,
+  Dispatch,
+  SetStateAction,
 } from 'react';
 import {
   PluginHook,
@@ -19,7 +21,8 @@ import {
   useSortBy,
   useTable,
 } from 'react-table';
-import { MRT_Row, MRT_TableInstance } from '.';
+import { MRT_FilterType, MRT_Row, MRT_TableInstance } from '.';
+import { defaultFilterFNs } from './filtersFNs';
 import { MRT_Icons } from './icons';
 import { MRT_Localization } from './localization';
 import { MaterialReactTableProps } from './MaterialReactTable';
@@ -28,19 +31,25 @@ export type UseMRT<D extends {} = {}> = MaterialReactTableProps<D> & {
   anyRowsCanExpand: boolean;
   anyRowsExpanded: boolean;
   icons: MRT_Icons;
+  idPrefix: string;
   localization: MRT_Localization;
-  setCurrentEditingRow: (currentRowEditingId: MRT_Row<D> | null) => void;
-  setDensePadding: (densePadding: boolean) => void;
-  setFullScreen: (fullScreen: boolean) => void;
-  setShowFilters: (showFilters: boolean) => void;
-  setShowSearch: (showSearch: boolean) => void;
+  setCurrentEditingRow: Dispatch<SetStateAction<MRT_Row<D> | null>>;
+  setCurrentFilterTypes: Dispatch<
+    SetStateAction<{
+      [key: string]: MRT_FilterType;
+    }>
+  >;
+  setDensePadding: Dispatch<SetStateAction<boolean>>;
+  setFullScreen: Dispatch<SetStateAction<boolean>>;
+  setShowFilters: Dispatch<SetStateAction<boolean>>;
+  setShowSearch: Dispatch<SetStateAction<boolean>>;
   tableInstance: MRT_TableInstance<D>;
 };
 
-const MaterialReactTableContext = (<D extends {}>() =>
+const MaterialReactTableContext = (<D extends {} = {}>() =>
   createContext<UseMRT<D>>({} as UseMRT<D>) as Context<UseMRT<D>>)();
 
-export const MaterialReactTableProvider = <D extends {}>(
+export const MaterialReactTableProvider = <D extends {} = {}>(
   props: PropsWithChildren<MaterialReactTableProps<D>>,
 ) => {
   const hooks: PluginHook<D>[] = [
@@ -56,7 +65,7 @@ export const MaterialReactTableProvider = <D extends {}>(
   if (props.enableColumnResizing)
     hooks.unshift(useResizeColumns, useFlexLayout);
 
-  const [currentEditingRow, setCurrentEditingRow] = useState<MRT_Row | null>(
+  const [currentEditingRow, setCurrentEditingRow] = useState<MRT_Row<D> | null>(
     null,
   );
   const [densePadding, setDensePadding] = useState(
@@ -72,14 +81,50 @@ export const MaterialReactTableProvider = <D extends {}>(
     props.initialState?.showSearch ?? false,
   );
 
-  const tableInstance = useTable<D>(
+  const filterTypes = useMemo<Partial<{ [key in MRT_FilterType]: any }>>(
+    () => ({
+      ...defaultFilterFNs,
+      ...props.filterTypes,
+    }),
+    [props.filterTypes],
+  );
+
+  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',
+        })),
+    ),
+  );
+
+  const columns = useMemo(
+    () =>
+      props.columns.map((column) => {
+        column.filter =
+          filterTypes[currentFilterTypes[column.accessor as string]];
+        return column;
+      }),
+    [props.columns, filterTypes, currentFilterTypes],
+  );
+
+  const tableInstance = useTable(
     {
       ...props,
+      columns,
+      // @ts-ignore
+      filterTypes,
       useControlledState: (state) =>
         useMemo(
           () => ({
             ...state,
             currentEditingRow,
+            currentFilterTypes,
             densePadding,
             fullScreen,
             showFilters,
@@ -89,6 +134,7 @@ export const MaterialReactTableProvider = <D extends {}>(
           }),
           [
             currentEditingRow,
+            currentFilterTypes,
             densePadding,
             fullScreen,
             showFilters,
@@ -100,6 +146,10 @@ export const MaterialReactTableProvider = <D extends {}>(
     ...hooks,
   ) as MRT_TableInstance<D>;
 
+  const idPrefix = useMemo(
+    () => props.idPrefix ?? Math.random().toString(36).substring(2, 9),
+    [props.idPrefix],
+  );
   const anyRowsCanExpand = useMemo(
     () => tableInstance.rows.some((row) => row.canExpand),
     [tableInstance.rows],
@@ -115,7 +165,10 @@ export const MaterialReactTableProvider = <D extends {}>(
         ...props,
         anyRowsCanExpand,
         anyRowsExpanded,
+        idPrefix,
+        //@ts-ignore
         setCurrentEditingRow,
+        setCurrentFilterTypes,
         setDensePadding,
         setFullScreen,
         setShowFilters,
@@ -129,6 +182,7 @@ export const MaterialReactTableProvider = <D extends {}>(
   );
 };
 
-export const useMRT = <D extends {}>(): UseMRT<D> =>
-  // @ts-ignore
-  useContext<UseMRT<D>>(MaterialReactTableContext);
+export const useMRT = <D extends {} = {}>(): UseMRT<D> =>
+  useContext<UseMRT<D>>(
+    MaterialReactTableContext as unknown as Context<UseMRT<D>>,
+  );