material-react-table 0.5.3 → 0.5.4

package/dist/menus/MRT_FilterMenu.d.ts

@@ -0,0 +1,10 @@
+import { FC } from 'react';
+import { MRT_HeaderGroup } from '..';
+interface Props {
+    anchorEl: HTMLElement | null;
+    column: MRT_HeaderGroup;
+    setAnchorEl: (anchorEl: HTMLElement | null) => void;
+    onSelect?: () => void;
+}
+export declare const MRT_FilterMenu: FC<Props>;
+export {};

package/dist/useMRT.d.ts

@@ -1,5 +1,5 @@
-import React, { PropsWithChildren } from 'react';
-import { MRT_Row, MRT_TableInstance } from '.';
+import React, { PropsWithChildren, Dispatch, SetStateAction } from 'react';
+import { MRT_FilterType, MRT_Row, MRT_TableInstance } from '.';
 import { MRT_Icons } from './icons';
 import { MRT_Localization } from './localization';
 import { MaterialReactTableProps } from './MaterialReactTable';
@@ -7,13 +7,17 @@ export declare 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>;
 };
-export declare const MaterialReactTableProvider: <D extends {}>(props: React.PropsWithChildren<MaterialReactTableProps<D>>) => JSX.Element;
-export declare const useMRT: <D extends {}>() => UseMRT<D>;
+export declare const MaterialReactTableProvider: <D extends {} = {}>(props: React.PropsWithChildren<MaterialReactTableProps<D>>) => JSX.Element;
+export declare const useMRT: <D extends {} = {}>() => UseMRT<D>;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.3",
+  "version": "0.5.4",
   "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.",
@@ -75,7 +75,7 @@
     "@storybook/react": "^6.4.19",
     "@types/faker": "^6.6.8",
     "@types/react": "^17.0.39",
-    "@types/react-dom": "^17.0.11",
+    "@types/react-dom": "^17.0.13",
     "@types/react-table": "^7.7.9",
     "babel-loader": "^8.2.3",
     "husky": "^7.0.4",
@@ -93,9 +93,13 @@
   },
   "peerDependencies": {
     "@emotion/react": ">=11",
+    "@emotion/styled": ">=11",
     "@mui/icons-material": ">=5",
     "@mui/material": ">=5",
     "react": ">=16.8",
     "react-table": ">=7"
+  },
+  "dependencies": {
+    "match-sorter": "^6.3.1"
   }
 }

package/src/MaterialReactTable.tsx

@@ -181,6 +181,16 @@ 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 type MRT_TableState<D extends {} = {}> = TableState<D> &
   UseColumnOrderState<D> &
   UseExpandedState<D> &
@@ -193,6 +203,7 @@ export type MRT_TableState<D extends {} = {}> = TableState<D> &
   UseRowStateState<D> &
   UseSortByState<D> & {
     currentEditingRow: MRT_Row<D> | null;
+    currentFilterTypes: { [key: string]: MRT_FilterType };
     densePadding: boolean;
     fullScreen: boolean;
     showFilters: boolean;
@@ -229,6 +240,7 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     hideToolbarInternalActions?: boolean;
     hideToolbarTop?: boolean;
     icons?: Partial<MRT_Icons>;
+    idPrefix?: string;
     isFetching?: boolean;
     isLoading?: boolean;
     localization?: Partial<MRT_Localization>;
@@ -275,7 +287,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
       | ((
           tableInstance: MRT_TableInstance<D>,
         ) => Partial<TablePaginationProps>);
-    muiTableProps?: TableProps | ((tableInstance: MRT_TableInstance<D>) => TableProps);
+    muiTableProps?:
+      | TableProps
+      | ((tableInstance: MRT_TableInstance<D>) => TableProps);
     muiTableToolbarAlertBannerProps?:
       | AlertProps
       | ((tableInstance: MRT_TableInstance<D>) => AlertProps);

package/src/buttons/MRT_EditActionButtons.tsx

@@ -13,7 +13,9 @@ export const MRT_EditActionButtons: FC<Props> = ({ row }) => {
     localization,
     onRowEditSubmit,
     setCurrentEditingRow,
-    tableInstance: { state: { currentEditingRow } },
+    tableInstance: {
+      state: { currentEditingRow },
+    },
   } = useMRT();
 
   const handleCancel = () => {

package/src/buttons/MRT_ToggleColumnActionMenuButton.tsx

@@ -35,11 +35,12 @@ export const MRT_ToggleColumnActionMenuButton: FC<Props> = ({ column }) => {
           onClick={handleClick}
           size="small"
           sx={{
+            height: '2rem',
+            mr: '2px',
+            mt: '-0.2rem',
             opacity: 0.5,
             transition: 'opacity 0.2s',
-            marginRight: '2px',
-            height: '1.6rem',
-            width: '1.6rem',
+            width: '2rem',
             '&:hover': {
               opacity: 1,
             },

package/src/buttons/MRT_ToggleFiltersButton.tsx

@@ -9,7 +9,9 @@ export const MRT_ToggleFiltersButton: FC<Props> = ({ ...rest }) => {
     icons: { FilterListIcon, FilterListOffIcon },
     localization,
     setShowFilters,
-    tableInstance: { state: { showFilters } },
+    tableInstance: {
+      state: { showFilters },
+    },
   } = useMRT();
 
   return (

package/src/buttons/MRT_ToggleSearchButton.tsx

@@ -7,10 +7,13 @@ interface Props extends IconButtonProps {}
 export const MRT_ToggleSearchButton: FC<Props> = ({ ...rest }) => {
   const {
     icons: { SearchIcon, SearchOffIcon },
+    idPrefix,
     localization,
     muiSearchTextFieldProps,
     setShowSearch,
-    tableInstance: { state: { showSearch } },
+    tableInstance: {
+      state: { showSearch },
+    },
   } = useMRT();
 
   const handleToggleSearch = () => {
@@ -19,7 +22,7 @@ export const MRT_ToggleSearchButton: FC<Props> = ({ ...rest }) => {
       () =>
         document
           .getElementById(
-            muiSearchTextFieldProps?.id ?? `global-search-text-field`,
+            muiSearchTextFieldProps?.id ?? `mrt-${idPrefix}-search-text-field`,
           )
           ?.focus(),
       200,

package/src/filtersFNs.ts

@@ -0,0 +1,112 @@
+import { matchSorter } from 'match-sorter';
+import { MRT_Row } from '.';
+
+export const fuzzyFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  matchSorter(rows, filterValue.toString().trim(), {
+    keys: [`values.${id}`],
+    sorter: (rankedItems) => rankedItems,
+  });
+
+fuzzyFilterFN.autoRemove = (val: any) => !val;
+
+export const containsFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  rows.filter((row) =>
+    row.values[id]
+      .toString()
+      .toLowerCase()
+      .trim()
+      .includes(filterValue.toString().toLowerCase().trim()),
+  );
+
+containsFilterFN.autoRemove = (val: any) => !val;
+
+export const startsWithFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  rows.filter((row) =>
+    row.values[id]
+      .toString()
+      .toLowerCase()
+      .trim()
+      .startsWith(filterValue.toString().toLowerCase().trim()),
+  );
+
+startsWithFilterFN.autoRemove = (val: any) => !val;
+
+export const endsWithFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  rows.filter((row) =>
+    row.values[id]
+      .toString()
+      .toLowerCase()
+      .trim()
+      .endsWith(filterValue.toString().toLowerCase().trim()),
+  );
+
+endsWithFilterFN.autoRemove = (val: any) => !val;
+
+export const equalsFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  rows.filter(
+    (row) =>
+      row.values[id].toString().toLowerCase().trim() ===
+      filterValue.toString().toLowerCase().trim(),
+  );
+
+equalsFilterFN.autoRemove = (val: any) => !val;
+
+export const notEqualsFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  filterValue: string | number,
+) =>
+  rows.filter(
+    (row) =>
+      row.values[id].toString().toLowerCase().trim() !==
+      filterValue.toString().toLowerCase().trim(),
+  );
+
+notEqualsFilterFN.autoRemove = (val: any) => !val;
+
+export const emptyFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  _filterValue: string | number,
+) => rows.filter((row) => !row.values[id].toString().toLowerCase().trim());
+
+emptyFilterFN.autoRemove = (val: any) => !val;
+
+export const notEmptyFilterFN = (
+  rows: MRT_Row[],
+  id: string,
+  _filterValue: string | number,
+) => rows.filter((row) => !!row.values[id].toString().toLowerCase().trim());
+
+notEmptyFilterFN.autoRemove = (val: any) => !val;
+
+export const defaultFilterFNs = {
+  contains: containsFilterFN,
+  empty: emptyFilterFN,
+  endsWith: endsWithFilterFN,
+  equals: equalsFilterFN,
+  fuzzy: fuzzyFilterFN,
+  notEmpty: notEmptyFilterFN,
+  notEquals: notEqualsFilterFN,
+  startsWith: startsWithFilterFN,
+};

package/src/head/MRT_TableHeadCell.tsx

@@ -73,6 +73,8 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
         column.Header as string,
       );
 
+  const columnHeader = column.render('Header') as string;
+
   return (
     <TableCell
       align={isParentHeader ? 'center' : 'left'}
@@ -86,59 +88,58 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
       }}
     >
       <Box
-        sx={{ alignContent: 'space-between', display: 'grid', height: '100%' }}
+        sx={{
+          alignItems: 'flex-start',
+          display: 'flex',
+          justifyContent: isParentHeader ? 'center' : 'space-between',
+          width: '100%',
+        }}
       >
         <Box
+          {...column.getSortByToggleProps()}
           sx={{
-            alignItems: 'flex-start',
+            alignItems: 'center',
             display: 'flex',
-            justifyContent: isParentHeader ? 'center' : 'space-between',
-            width: '100%',
+            flexWrap: 'nowrap',
+            whiteSpace: columnHeader.length < 15 ? 'nowrap' : 'normal',
           }}
+          title={undefined}
         >
-          <Box
-            {...column.getSortByToggleProps()}
-            sx={{ alignItems: 'center', display: 'flex', flexWrap: 'nowrap' }}
-            title={undefined}
-          >
-            {column.render('Header')}
-            {!isParentHeader && column.canSort && (
-              <Tooltip arrow title={sortTooltip}>
-                <TableSortLabel
-                  aria-label={sortTooltip}
-                  active={column.isSorted}
-                  direction={column.isSortedDesc ? 'desc' : 'asc'}
-                />
-              </Tooltip>
-            )}
-          </Box>
-          <Box
-            sx={{ alignItems: 'center', display: 'flex', flexWrap: 'nowrap' }}
-          >
-            {!disableColumnActions && !isParentHeader && (
-              <MRT_ToggleColumnActionMenuButton column={column} />
-            )}
-            {enableColumnResizing && !isParentHeader && (
-              <Divider
-                flexItem
-                orientation="vertical"
-                onDoubleClick={() => tableInstance.resetResizing()}
-                {...column.getResizerProps()}
-                sx={{
-                  borderRightWidth: '2px',
-                  borderRadius: '2px',
-                  maxHeight: '2rem',
-                }}
+          {column.render('Header')}
+          {!isParentHeader && column.canSort && (
+            <Tooltip arrow title={sortTooltip}>
+              <TableSortLabel
+                aria-label={sortTooltip}
+                active={column.isSorted}
+                direction={column.isSortedDesc ? 'desc' : 'asc'}
               />
-            )}
-          </Box>
+            </Tooltip>
+          )}
+        </Box>
+        <Box sx={{ alignItems: 'center', display: 'flex', flexWrap: 'nowrap' }}>
+          {!disableColumnActions && !isParentHeader && (
+            <MRT_ToggleColumnActionMenuButton column={column} />
+          )}
+          {enableColumnResizing && !isParentHeader && (
+            <Divider
+              flexItem
+              orientation="vertical"
+              onDoubleClick={() => tableInstance.resetResizing()}
+              {...column.getResizerProps()}
+              sx={{
+                borderRightWidth: '2px',
+                borderRadius: '2px',
+                maxHeight: '2rem',
+              }}
+            />
+          )}
         </Box>
-        {!disableFilters && column.canFilter && (
-          <Collapse in={tableInstance.state.showFilters}>
-            <MRT_FilterTextField column={column} />
-          </Collapse>
-        )}
       </Box>
+      {!disableFilters && column.canFilter && (
+        <Collapse in={tableInstance.state.showFilters}>
+          <MRT_FilterTextField column={column} />
+        </Collapse>
+      )}
     </TableCell>
   );
 };

package/src/index.tsx

@@ -1,5 +1,3 @@
 import MaterialReactTable from './MaterialReactTable';
 export default MaterialReactTable;
 export * from './MaterialReactTable';
-
-

package/src/inputs/MRT_FilterTextField.tsx

@@ -1,8 +1,16 @@
-import React, { ChangeEvent, FC, useState } from 'react';
-import { IconButton, InputAdornment, TextField, Tooltip } from '@mui/material';
+import React, { ChangeEvent, FC, MouseEvent, useState } from 'react';
+import {
+  Chip,
+  IconButton,
+  InputAdornment,
+  TextField,
+  TextFieldProps,
+  Tooltip,
+} from '@mui/material';
 import { useAsyncDebounce } from 'react-table';
 import { useMRT } from '../useMRT';
 import { MRT_HeaderGroup } from '..';
+import { MRT_FilterMenu } from '../menus/MRT_FilterMenu';
 
 interface Props {
   column: MRT_HeaderGroup;
@@ -11,79 +19,136 @@ interface Props {
 export const MRT_FilterTextField: FC<Props> = ({ column }) => {
   const {
     icons: { FilterListIcon, CloseIcon },
+    idPrefix,
     localization,
+    muiTableHeadCellFilterTextFieldProps,
+    setCurrentFilterTypes,
+    tableInstance,
   } = useMRT();
 
+  const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
+
+  const mTableHeadCellFilterTextFieldProps =
+    muiTableHeadCellFilterTextFieldProps instanceof Function
+      ? muiTableHeadCellFilterTextFieldProps(column)
+      : muiTableHeadCellFilterTextFieldProps;
+
+  const mcTableHeadCellFilterTextFieldProps =
+    column.muiTableHeadCellFilterTextFieldProps instanceof Function
+      ? column.muiTableHeadCellFilterTextFieldProps(column)
+      : column.muiTableHeadCellFilterTextFieldProps;
+
+  const textFieldProps = {
+    ...mTableHeadCellFilterTextFieldProps,
+    ...mcTableHeadCellFilterTextFieldProps,
+    style: {
+      ...mTableHeadCellFilterTextFieldProps?.style,
+      ...mcTableHeadCellFilterTextFieldProps?.style,
+    },
+  } as TextFieldProps;
+
   const [filterValue, setFilterValue] = useState('');
 
   const handleChange = useAsyncDebounce((value) => {
     column.setFilter(value ?? undefined);
   }, 150);
 
+  const handleFilterMenuOpen = (event: MouseEvent<HTMLElement>) => {
+    setAnchorEl(event.currentTarget);
+  };
+
   const handleClear = () => {
     setFilterValue('');
     column.setFilter(undefined);
   };
 
+  const handleClearFilterChip = () => {
+    setFilterValue('');
+    column.setFilter(undefined);
+    setCurrentFilterTypes((prev) => ({ ...prev, [column.id]: 'fuzzy' }));
+  };
+
   if (column.Filter) {
     return <>{column.Filter?.({ column })}</>;
   }
 
+  const filterType = tableInstance.state.currentFilterTypes[column.id];
+  const showFilterChip = ['empty', 'notEmpty'].includes(filterType);
+  const filterPlaceholder = localization.filterTextFieldPlaceholder?.replace(
+    '{column}',
+    String(column.Header),
+  );
+
   return (
-    <TextField
-      fullWidth
-      id={`filter-${column.id}-column`}
-      inputProps={{
-        style: {
-          textOverflow: 'ellipsis',
-        },
-      }}
-      margin="dense"
-      placeholder={localization.filterTextFieldPlaceholder?.replace(
-        '{column}',
-        String(column.Header),
-      )}
-      onChange={(e: ChangeEvent<HTMLInputElement>) => {
-        setFilterValue(e.target.value);
-        handleChange(e.target.value);
-      }}
-      onClick={(e) => e.stopPropagation()}
-      value={filterValue ?? ''}
-      variant="standard"
-      InputProps={{
-        startAdornment: (
-          <Tooltip
-            arrow
-            title={localization.filterTextFieldPlaceholder?.replace(
-              '{column}',
-              String(column.Header),
-            )}
-          >
+    <>
+      <TextField
+        fullWidth
+        id={`mrt-${idPrefix}-${column.id}-filter-text-field`}
+        inputProps={{
+          sx: {
+            textOverflow: 'ellipsis',
+          },
+          title: filterPlaceholder,
+        }}
+        margin="none"
+        placeholder={showFilterChip ? '' : filterPlaceholder}
+        onChange={(e: ChangeEvent<HTMLInputElement>) => {
+          setFilterValue(e.target.value);
+          handleChange(e.target.value);
+        }}
+        onClick={(e) => e.stopPropagation()}
+        value={filterValue ?? ''}
+        variant="standard"
+        InputProps={{
+          startAdornment: (
             <InputAdornment position="start">
-              <FilterListIcon />
-            </InputAdornment>
-          </Tooltip>
-        ),
-        endAdornment: (
-          <InputAdornment position="end">
-            <Tooltip
-              arrow
-              title={localization.filterTextFieldClearButtonTitle ?? ''}
-            >
-              <span>
+              <Tooltip arrow title="Change Filter Mode">
                 <IconButton
-                  aria-label={localization.filterTextFieldClearButtonTitle}
-                  disabled={filterValue?.length === 0}
-                  onClick={handleClear}
+                  onClick={handleFilterMenuOpen}
                   size="small"
+                  sx={{ height: '1.75rem', width: '1.75rem' }}
                 >
-                  <CloseIcon fontSize="small" />
+                  <FilterListIcon />
                 </IconButton>
-              </span>
-            </Tooltip>
-          </InputAdornment>
-        ),
-      }}
-    />
+              </Tooltip>
+              {showFilterChip && (
+                <Chip onDelete={handleClearFilterChip} label={filterType} />
+              )}
+            </InputAdornment>
+          ),
+          endAdornment: !showFilterChip && (
+            <InputAdornment position="end">
+              <Tooltip
+                arrow
+                placement="right"
+                title={localization.filterTextFieldClearButtonTitle ?? ''}
+              >
+                <span>
+                  <IconButton
+                    aria-label={localization.filterTextFieldClearButtonTitle}
+                    disabled={filterValue?.length === 0}
+                    onClick={handleClear}
+                    size="small"
+                    sx={{ height: '1.75rem', width: '1.75rem' }}
+                  >
+                    <CloseIcon fontSize="small" />
+                  </IconButton>
+                </span>
+              </Tooltip>
+            </InputAdornment>
+          ),
+        }}
+        {...textFieldProps}
+        sx={{
+          minWidth: '6rem',
+          ...textFieldProps?.sx,
+        }}
+      />
+      <MRT_FilterMenu
+        anchorEl={anchorEl}
+        column={column}
+        setAnchorEl={setAnchorEl}
+      />
+    </>
   );
 };

package/src/inputs/MRT_SearchTextField.tsx

@@ -8,6 +8,7 @@ interface Props {}
 export const MRT_SearchTextField: FC<Props> = () => {
   const {
     icons: { SearchIcon, CloseIcon },
+    idPrefix,
     localization,
     muiSearchTextFieldProps,
     onGlobalFilterChange,
@@ -32,7 +33,7 @@ export const MRT_SearchTextField: FC<Props> = () => {
   return (
     <Collapse in={tableInstance.state.showSearch} orientation="horizontal">
       <TextField
-        id="global-search-text-field"
+        id={`mrt-${idPrefix}-search-text-field`}
         placeholder={localization.searchTextFieldPlaceholder}
         onChange={(event: ChangeEvent<HTMLInputElement>) => {
           setSearchValue(event.target.value);

package/src/inputs/MRT_SelectCheckbox.tsx

@@ -10,12 +10,8 @@ interface Props {
 }
 
 export const MRT_SelectCheckbox: FC<Props> = ({ row, selectAll }) => {
-  const {
-    localization,
-    onRowSelectChange,
-    onSelectAllChange,
-    tableInstance,
-  } = useMRT();
+  const { localization, onRowSelectChange, onSelectAllChange, tableInstance } =
+    useMRT();
 
   const onSelectChange = (event: ChangeEvent<HTMLInputElement>) => {
     if (selectAll) {
@@ -32,7 +28,9 @@ export const MRT_SelectCheckbox: FC<Props> = ({ row, selectAll }) => {
     : row?.getToggleRowSelectedProps();
 
   return (
-    <TableCell sx={commonTableBodyButtonCellStyles(tableInstance.state.densePadding)} >
+    <TableCell
+      sx={commonTableBodyButtonCellStyles(tableInstance.state.densePadding)}
+    >
       <Tooltip
         arrow
         enterDelay={1000}