material-react-table 0.5.7 → 0.5.8

package/dist/menus/MRT_ColumnActionMenu.d.ts

@@ -2,7 +2,14 @@ import { FC } from 'react';
 import { MRT_HeaderGroup } from '..';
 export declare const commonMenuItemStyles: {
     py: string;
-    my: string;
+    my: number;
+    justifyContent: string;
+    alignItems: string;
+};
+export declare const commonListItemStyles: {
+    display: string;
+    gap: string;
+    alignItems: string;
 };
 interface Props {
     anchorEl: HTMLElement | null;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.7",
+  "version": "0.5.8",
   "license": "MIT",
   "name": "material-react-table",
   "description": "A fully featured Material-UI implementation of react-table, inspired by material-table and the mui DataGrid, written from the ground up in TypeScript.",
@@ -28,7 +28,7 @@
   },
   "scripts": {
     "analyze": "size-limit --why",
-    "build": "tsdx build && size-limit && cp -r dist material-react-table-docs/node_modules/material-react-table/dist && cp -r src material-react-table-docs/node_modules/material-react-table/src && cp -r package.json material-react-table-docs/node_modules/material-react-table/package.json",
+    "build": "tsdx build && size-limit && rm -rf material-react-table-docs/node_modules/material-react-table/dist  && cp -r dist material-react-table-docs/node_modules/material-react-table/ && cp -r src material-react-table-docs/node_modules/material-react-table/ && cp -r package.json material-react-table-docs/node_modules/material-react-table/package.json",
     "build-storybook": "build-storybook",
     "format": "prettier -w .",
     "lint": "tsdx lint",

package/src/MaterialReactTable.tsx

@@ -19,6 +19,7 @@ import {
   Cell,
   Column,
   ColumnInstance,
+  FilterType,
   // ColumnInterface,
   HeaderGroup,
   Row,
@@ -132,6 +133,8 @@ export type MRT_ColumnInterface<D extends {} = {}> =
       Header?: string;
       disableFilters?: boolean;
       editable?: boolean;
+      filter?: MRT_FilterType | string | FilterType<D>;
+      filterSelectOptions?: (string | { text: string; value: string })[];
       muiTableBodyCellEditTextFieldProps?:
         | TextFieldProps
         | ((cell: MRT_Cell<D>) => TextFieldProps);
@@ -183,15 +186,18 @@ export type MRT_Cell<D extends {} = {}, _V = any> = Cell<D> &
   UseGroupByCellProps<D> &
   UseRowStateCellProps<D> & {};
 
-export type MRT_FilterType =
-  | 'contains'
-  | 'empty'
-  | 'endsWith'
-  | 'equals'
-  | 'fuzzy'
-  | 'notEmpty'
-  | 'notEquals'
-  | 'startsWith';
+export enum MRT_FILTER_TYPE {
+  CONTAINS = 'contains',
+  EMPTY = 'empty',
+  ENDS_WITH = 'endsWith',
+  EQUALS = 'equals',
+  FUZZY = 'fuzzy',
+  NOT_EMPTY = 'notEmpty',
+  NOT_EQUALS = 'notEquals',
+  STARTS_WITH = 'startsWith',
+}
+
+export type MRT_FilterType = MRT_FILTER_TYPE | Function;
 
 export type MRT_TableState<D extends {} = {}> = TableState<D> &
   UseColumnOrderState<D> &

package/src/buttons/MRT_ShowHideColumnsButton.tsx

@@ -11,7 +11,6 @@ import {
 import { useMRT } from '../useMRT';
 import { MRT_ShowHideColumnsMenu } from '../menus/MRT_ShowHideColumnsMenu';
 import { MRT_ColumnInstance } from '..';
-import { commonMenuItemStyles } from '../menus/MRT_ColumnActionMenu';
 
 interface Props extends IconButtonProps {}
 
@@ -46,9 +45,7 @@ export const MRT_ShowHideColumnsButton: FC<Props> = ({ ...rest }) => {
         onClose={() => setAnchorEl(null)}
         MenuListProps={{
           dense: tableInstance.state.densePadding,
-          disablePadding: true,
         }}
-        sx={commonMenuItemStyles}
       >
         <Box
           sx={{

package/src/filtersFNs.ts

@@ -1,6 +1,18 @@
 import { matchSorter } from 'match-sorter';
 import { MRT_Row } from '.';
 
+export const fuzzySearchFN = (
+  rows: MRT_Row[],
+  columnIds: string[],
+  filterValue: string | number,
+) =>
+  matchSorter(rows, filterValue.toString().trim(), {
+    keys: columnIds.map((c) => `values.${c}`),
+    sorter: (rankedItems) => rankedItems,
+  });
+
+fuzzySearchFN.autoRemove = (val: any) => !val;
+
 export const fuzzyFilterFN = (
   rows: MRT_Row[],
   id: string,

package/src/head/MRT_TableHeadCell.tsx

@@ -79,18 +79,7 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
   const filterTooltip = !!column.filterValue
     ? localization.filterApplied
         .replace('{column}', String(column.Header))
-        .replace(
-          '{filterType}',
-          // @ts-ignore
-          localization[
-            `filterMenuItem${
-              tableInstance.state.currentFilterTypes[column.id]
-                .charAt(0)
-                .toUpperCase() +
-              tableInstance.state.currentFilterTypes[column.id].slice(1)
-            }`
-          ],
-        )
+        .replace('{filterType}', column.filterValue)
     : localization.toggleFilterButtonTitle;
 
   const columnHeader = column.render('Header') as string;
@@ -127,7 +116,7 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
         >
           {column.render('Header')}
           {!isParentHeader && column.canSort && (
-            <Tooltip arrow title={sortTooltip}>
+            <Tooltip arrow placement="top" title={sortTooltip}>
               <TableSortLabel
                 aria-label={sortTooltip}
                 active={column.isSorted}
@@ -136,19 +125,21 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
             </Tooltip>
           )}
           {!isParentHeader && !!column.canFilter && (
-            <Tooltip arrow title={filterTooltip}>
+            <Tooltip arrow placement="top" title={filterTooltip}>
               <IconButton
+                disableRipple
                 onClick={(event) => {
                   event.stopPropagation();
                   setShowFilters(!tableInstance.state.showFilters);
                 }}
                 size="small"
                 sx={{
+                  m: 0,
                   opacity: !!column.filterValue ? 0.8 : 0,
                   p: '2px',
-                  m: 0,
                   transition: 'all 0.2s ease-in-out',
                   '&:hover': {
+                    backgroundColor: 'transparent',
                     opacity: 0.8,
                   },
                 }}

package/src/inputs/MRT_FilterTextField.tsx

@@ -3,13 +3,14 @@ import {
   Chip,
   IconButton,
   InputAdornment,
+  MenuItem,
   TextField,
   TextFieldProps,
   Tooltip,
 } from '@mui/material';
 import { useAsyncDebounce } from 'react-table';
 import { useMRT } from '../useMRT';
-import { MRT_HeaderGroup } from '..';
+import { MRT_FILTER_TYPE, MRT_HeaderGroup } from '..';
 import { MRT_FilterTypeMenu } from '../menus/MRT_FilterTypeMenu';
 
 interface Props {
@@ -65,7 +66,10 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
   const handleClearFilterChip = () => {
     setFilterValue('');
     column.setFilter(undefined);
-    setCurrentFilterTypes((prev) => ({ ...prev, [column.id]: 'fuzzy' }));
+    setCurrentFilterTypes((prev) => ({
+      ...prev,
+      [column.id]: MRT_FILTER_TYPE.FUZZY,
+    }));
   };
 
   if (column.Filter) {
@@ -73,7 +77,13 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
   }
 
   const filterType = tableInstance.state.currentFilterTypes[column.id];
-  const filterChipLabel = ['empty', 'notEmpty'].includes(filterType);
+  const isCustomFilterType = filterType instanceof Function;
+  const isSelectFilter = !!column.filterSelectOptions;
+  const filterChipLabel =
+    !isCustomFilterType &&
+    [MRT_FILTER_TYPE.EMPTY, MRT_FILTER_TYPE.NOT_EMPTY].includes(
+      filterType as MRT_FILTER_TYPE,
+    );
   const filterPlaceholder = localization.filterTextFieldPlaceholder?.replace(
     '{column}',
     String(column.Header),
@@ -92,26 +102,40 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
           },
           title: filterPlaceholder,
         }}
+        label={isSelectFilter && !filterValue ? filterPlaceholder : undefined}
+        InputLabelProps={{
+          shrink: false,
+          sx: {
+            maxWidth: 'calc(100% - 2.5rem)',
+          },
+          title: filterPlaceholder,
+        }}
         margin="none"
-        placeholder={filterChipLabel ? '' : filterPlaceholder}
+        placeholder={
+          filterChipLabel || isSelectFilter ? undefined : filterPlaceholder
+        }
         onChange={(e: ChangeEvent<HTMLInputElement>) => {
           setFilterValue(e.target.value);
           handleChange(e.target.value);
         }}
         onClick={(e) => e.stopPropagation()}
+        select={isSelectFilter}
         value={filterValue ?? ''}
         variant="standard"
         InputProps={{
-          startAdornment: (
+          startAdornment: !isSelectFilter && (
             <InputAdornment position="start">
-              <Tooltip arrow title="Change Filter Mode">
-                <IconButton
-                  onClick={handleFilterMenuOpen}
-                  size="small"
-                  sx={{ height: '1.75rem', width: '1.75rem' }}
-                >
-                  <FilterListIcon />
-                </IconButton>
+              <Tooltip arrow title={localization.changeFilterMode}>
+                <span>
+                  <IconButton
+                    disabled={isCustomFilterType}
+                    onClick={handleFilterMenuOpen}
+                    size="small"
+                    sx={{ height: '1.75rem', width: '1.75rem' }}
+                  >
+                    <FilterListIcon />
+                  </IconButton>
+                </span>
               </Tooltip>
               {filterChipLabel && (
                 <Chip onDelete={handleClearFilterChip} label={filterType} />
@@ -122,16 +146,20 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
             <InputAdornment position="end">
               <Tooltip
                 arrow
+                disableHoverListener={isSelectFilter}
                 placement="right"
                 title={localization.filterTextFieldClearButtonTitle ?? ''}
               >
                 <span>
                   <IconButton
                     aria-label={localization.filterTextFieldClearButtonTitle}
-                    disabled={filterValue?.length === 0}
+                    disabled={!filterValue?.length}
                     onClick={handleClear}
                     size="small"
-                    sx={{ height: '1.75rem', width: '1.75rem' }}
+                    sx={{
+                      height: '1.75rem',
+                      width: '1.75rem',
+                    }}
                   >
                     <CloseIcon fontSize="small" />
                   </IconButton>
@@ -145,9 +173,35 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
           m: '0 -0.25rem',
           minWidth: !filterChipLabel ? '5rem' : 'auto',
           width: 'calc(100% + 0.5rem)',
+          mt: isSelectFilter && !filterValue ? '-1rem' : undefined,
+          '&	.MuiSelect-icon': {
+            mr: '1.5rem',
+          },
           ...textFieldProps?.sx,
         }}
-      />
+      >
+        {isSelectFilter && (
+          <MenuItem divider disabled={!filterValue} value="">
+            {localization.filterTextFieldClearButtonTitle}
+          </MenuItem>
+        )}
+        {column?.filterSelectOptions?.map((option) => {
+          let value;
+          let text;
+          if (typeof option === 'string') {
+            value = option;
+            text = option;
+          } else if (typeof option === 'object') {
+            value = option.value;
+            text = option.text;
+          }
+          return (
+            <MenuItem key={value} value={value}>
+              {text}
+            </MenuItem>
+          );
+        })}
+      </TextField>
       <MRT_FilterTypeMenu
         anchorEl={anchorEl}
         column={column}

package/src/localization.ts

@@ -26,6 +26,7 @@ export interface MRT_Localization {
   filterTextFieldChipLabelNotEmpty: string;
   filterTextFieldClearButtonTitle: string;
   filterTextFieldPlaceholder: string;
+  changeFilterMode: string;
   rowActionButtonCancel: string;
   rowActionButtonSave: string;
   rowActionMenuButtonTitle: string;
@@ -63,6 +64,7 @@ export const MRT_DefaultLocalization_EN: MRT_Localization = {
   filterMenuItemEmpty: 'Empty',
   filterMenuItemEndsWith: 'Ends With',
   filterMenuItemEquals: 'Equals',
+  changeFilterMode: 'Change filter mode',
   filterMenuItemFuzzy: 'Fuzzy Match (Default)',
   filterMenuItemNotEmpty: 'Not Empty',
   filterMenuItemNotEquals: 'Not Equals',

package/src/menus/MRT_ColumnActionMenu.tsx

@@ -1,18 +1,20 @@
 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 { MRT_FilterTypeMenu } from './MRT_FilterTypeMenu';
 
 export const commonMenuItemStyles = {
-  py: '0 !important',
-  my: '0 !important',
+  py: '6px',
+  my: 0,
+  justifyContent: 'space-between',
+  alignItems: 'center',
+};
+
+export const commonListItemStyles = {
+  display: 'flex',
+  gap: '0.75rem',
+  alignItems: 'center',
 };
 
 interface Props {
@@ -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 sx={commonMenuItemStyles}>
               {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 sx={commonMenuItemStyles}>
               {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 sx={commonMenuItemStyles}>
               {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 sx={commonMenuItemStyles}>
               {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 sx={commonMenuItemStyles}>
               {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 sx={commonMenuItemStyles}>
             {localization.columnActionMenuItemHideColumn?.replace(
               '{column}',
               String(column.Header),
             )}
-          </ListItemText>
+          </Box>
         </MenuItem>,
       ]}
     </Menu>

package/src/menus/MRT_FilterTypeMenu.tsx

@@ -1,9 +1,13 @@
 import React, { FC, useMemo } from 'react';
 import { Menu, MenuItem } from '@mui/material';
 import { useMRT } from '../useMRT';
-import { MRT_FilterType, MRT_HeaderGroup } from '..';
-import { commonMenuItemStyles } from './MRT_ColumnActionMenu';
+import { MRT_FilterType, MRT_FILTER_TYPE, MRT_HeaderGroup } from '..';
 
+const commonMenuItemStyles = {
+  py: '6px',
+  my: 0,
+  alignItems: 'center',
+};
 
 interface Props {
   anchorEl: HTMLElement | null;
@@ -21,48 +25,48 @@ export const MRT_FilterTypeMenu: FC<Props> = ({
   const { localization, setCurrentFilterTypes, tableInstance } = useMRT();
 
   const filterTypes: {
-    type: MRT_FilterType;
+    type: MRT_FILTER_TYPE;
     label: string;
     divider: boolean;
   }[] = useMemo(
     () => [
       {
-        type: 'fuzzy',
+        type: MRT_FILTER_TYPE.FUZZY,
         label: localization.filterMenuItemFuzzy,
         divider: false,
       },
       {
-        type: 'contains',
+        type: MRT_FILTER_TYPE.CONTAINS,
         label: localization.filterMenuItemContains,
         divider: true,
       },
       {
-        type: 'startsWith',
+        type: MRT_FILTER_TYPE.STARTS_WITH,
         label: localization.filterMenuItemStartsWith,
         divider: false,
       },
       {
-        type: 'endsWith',
+        type: MRT_FILTER_TYPE.ENDS_WITH,
         label: localization.filterMenuItemEndsWith,
         divider: true,
       },
       {
-        type: 'equals',
+        type: MRT_FILTER_TYPE.EQUALS,
         label: localization.filterMenuItemEquals,
         divider: false,
       },
       {
-        type: 'notEquals',
+        type: MRT_FILTER_TYPE.NOT_EQUALS,
         label: localization.filterMenuItemNotEquals,
         divider: true,
       },
       {
-        type: 'empty',
+        type: MRT_FILTER_TYPE.EMPTY,
         label: localization.filterMenuItemEmpty,
         divider: false,
       },
       {
-        type: 'notEmpty',
+        type: MRT_FILTER_TYPE.NOT_EMPTY,
         label: localization.filterMenuItemNotEmpty,
         divider: false,
       },
@@ -70,13 +74,13 @@ export const MRT_FilterTypeMenu: FC<Props> = ({
     [],
   );
 
-  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?.();
@@ -92,17 +96,16 @@ 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 }, index) => (
         <MenuItem
           divider={divider}
-          key={type}
+          key={index}
           onClick={() => handleSelectFilterType(type)}
           selected={type === filterType}
-          value={type}
           sx={commonMenuItemStyles}
+          value={type}
         >
           {label}
         </MenuItem>

package/src/menus/MRT_RowActionMenu.tsx

@@ -1,10 +1,9 @@
 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 { commonMenuItemStyles } from './MRT_ColumnActionMenu';
 
-
 interface Props {
   anchorEl: HTMLElement | null;
   row: MRT_Row;
@@ -33,17 +32,12 @@ export const MRT_RowActionMenu: FC<Props> = ({
       onClose={() => setAnchorEl(null)}
       MenuListProps={{
         dense: tableInstance.state.densePadding,
-        disablePadding: true,
       }}
     >
       {enableRowEditing && (
         <MenuItem onClick={handleEdit} sx={commonMenuItemStyles}>
-          <ListItemIcon>
-            <EditIcon />
-          </ListItemIcon>
-          <ListItemText sx={commonMenuItemStyles}>
-            {localization.rowActionMenuItemEdit}
-          </ListItemText>
+          <EditIcon />
+          {localization.rowActionMenuItemEdit}
         </MenuItem>
       )}
       {renderRowActionMenuItems?.(row, tableInstance, () =>