material-react-table 0.5.2 → 0.5.5

package/dist/menus/MRT_FilterTypeMenu.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_FilterTypeMenu: 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.2",
+  "version": "0.5.5",
   "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>;
@@ -239,18 +251,22 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     muiTableBodyCellProps?:
       | TableCellProps
       | ((cell?: MRT_Cell<D>) => TableCellProps);
-    muiTableBodyProps?: TableBodyProps;
+    muiTableBodyProps?:
+      | TableBodyProps
+      | ((tableInstance: MRT_TableInstance<D>) => TableBodyProps);
     muiTableBodyRowProps?: TableRowProps | ((row: Row<D>) => TableRowProps);
     muiTableContainerProps?:
       | TableContainerProps
-      | ((table: MRT_TableInstance<D>) => TableContainerProps);
+      | ((tableInstance: MRT_TableInstance<D>) => TableContainerProps);
     muiTableDetailPanelProps?:
       | TableCellProps
       | ((row: Row<D>) => TableCellProps);
     muiTableFooterCellProps?:
       | TableCellProps
       | ((column: Column<D>) => TableCellProps);
-    muiTableFooterProps?: TableFooterProps;
+    muiTableFooterProps?:
+      | TableFooterProps
+      | ((tableInstance: MRT_TableInstance<D>) => TableFooterProps);
     muiTableFooterRowProps?:
       | TableRowProps
       | ((footerGroup: MRT_HeaderGroup<D>) => TableRowProps);
@@ -260,7 +276,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     muiTableHeadCellProps?:
       | TableCellProps
       | ((column: Column<D>) => TableCellProps);
-    muiTableHeadProps?: TableHeadProps;
+    muiTableHeadProps?:
+      | TableHeadProps
+      | ((tableInstance: MRT_TableInstance<D>) => TableHeadProps);
     muiTableHeadRowProps?:
       | TableRowProps
       | ((row: MRT_HeaderGroup<D>) => TableRowProps);
@@ -269,7 +287,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
       | ((
           tableInstance: MRT_TableInstance<D>,
         ) => Partial<TablePaginationProps>);
-    muiTableProps?: TableProps;
+    muiTableProps?:
+      | TableProps
+      | ((tableInstance: MRT_TableInstance<D>) => TableProps);
     muiTableToolbarAlertBannerProps?:
       | AlertProps
       | ((tableInstance: MRT_TableInstance<D>) => AlertProps);

package/src/body/MRT_TableBody.tsx

@@ -11,12 +11,17 @@ export const MRT_TableBody: FC<Props> = () => {
 
   const rows = manualPagination ? tableInstance.rows : tableInstance.page;
 
+  const mTableBodyProps =
+    muiTableBodyProps instanceof Function
+      ? muiTableBodyProps(tableInstance)
+      : muiTableBodyProps;
+
   const tableBodyProps = {
-    ...muiTableBodyProps,
+    ...mTableBodyProps,
     ...tableInstance.getTableBodyProps(),
     style: {
       ...tableInstance.getTableBodyProps().style,
-      ...muiTableBodyProps?.style,
+      ...mTableBodyProps?.style,
     },
   };
 

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_ShowHideColumnsButton.tsx

@@ -7,6 +7,7 @@ import {
   Divider,
   IconButtonProps,
   Box,
+  MenuList,
 } from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_ShowHideColumnsMenu } from '../menus/MRT_ShowHideColumnsMenu';
@@ -16,9 +17,9 @@ interface Props extends IconButtonProps {}
 
 export const MRT_ShowHideColumnsButton: FC<Props> = ({ ...rest }) => {
   const {
-    tableInstance,
-    localization,
     icons: { ViewColumnIcon },
+    localization,
+    tableInstance,
   } = useMRT();
 
   const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
@@ -44,36 +45,38 @@ export const MRT_ShowHideColumnsButton: FC<Props> = ({ ...rest }) => {
         open={!!anchorEl}
         onClose={() => setAnchorEl(null)}
       >
-        <Box
-          sx={{
-            display: 'flex',
-            justifyContent: 'space-between',
-            p: '0 0.5rem 0.5rem 0.5rem',
-          }}
-        >
-          <Button
-            disabled={
-              !tableInstance.getToggleHideAllColumnsProps().checked &&
-              !tableInstance.getToggleHideAllColumnsProps().indeterminate
-            }
-            onClick={() => tableInstance.toggleHideAllColumns(true)}
-          >
-            {localization.columnShowHideMenuHideAll}
-          </Button>
-          <Button
-            disabled={tableInstance.getToggleHideAllColumnsProps().checked}
-            onClick={() => tableInstance.toggleHideAllColumns(false)}
+        <MenuList dense={tableInstance.state.densePadding} disablePadding>
+          <Box
+            sx={{
+              display: 'flex',
+              justifyContent: 'space-between',
+              p: '0 0.5rem 0.5rem 0.5rem',
+            }}
           >
-            {localization.columnShowHideMenuShowAll}
-          </Button>
-        </Box>
-        <Divider />
-        {tableInstance.columns.map((column: MRT_ColumnInstance, index) => (
-          <MRT_ShowHideColumnsMenu
-            key={`${index}-${column.id}`}
-            column={column}
-          />
-        ))}
+            <Button
+              disabled={
+                !tableInstance.getToggleHideAllColumnsProps().checked &&
+                !tableInstance.getToggleHideAllColumnsProps().indeterminate
+              }
+              onClick={() => tableInstance.toggleHideAllColumns(true)}
+            >
+              {localization.columnShowHideMenuHideAll}
+            </Button>
+            <Button
+              disabled={tableInstance.getToggleHideAllColumnsProps().checked}
+              onClick={() => tableInstance.toggleHideAllColumns(false)}
+            >
+              {localization.columnShowHideMenuShowAll}
+            </Button>
+          </Box>
+          <Divider />
+          {tableInstance.columns.map((column: MRT_ColumnInstance, index) => (
+            <MRT_ShowHideColumnsMenu
+              key={`${index}-${column.id}`}
+              column={column}
+            />
+          ))}
+        </MenuList>
       </Menu>
     </>
   );

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/footer/MRT_TableFooter.tsx

@@ -9,8 +9,13 @@ interface Props {}
 export const MRT_TableFooter: FC<Props> = () => {
   const { muiTableFooterProps, tableInstance } = useMRT();
 
+  const tableFooterProps =
+    muiTableFooterProps instanceof Function
+      ? muiTableFooterProps(tableInstance)
+      : muiTableFooterProps;
+
   return (
-    <TableFooter {...muiTableFooterProps}>
+    <TableFooter {...tableFooterProps}>
       {tableInstance.footerGroups.map((footerGroup: MRT_HeaderGroup) => (
         <MRT_TableFooterRow
           key={footerGroup.getFooterGroupProps().key}

package/src/footer/MRT_TableFooterCell.tsx

@@ -16,7 +16,7 @@ export const MRT_TableFooterCell: FC<Props> = ({ column }) => {
     },
   } = useMRT();
 
-  const isParentHeader = (column?.columns?.length ?? 0) > 0;
+  const isParentHeader = !!column?.columns?.length;
 
   const mTableFooterCellProps =
     muiTableFooterCellProps instanceof Function

package/src/head/MRT_TableHeadCell.tsx

@@ -6,6 +6,7 @@ import {
   Collapse,
   Tooltip,
   Box,
+  IconButton,
 } from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_FilterTextField } from '../inputs/MRT_FilterTextField';
@@ -33,12 +34,14 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
     disableColumnActions,
     disableFilters,
     enableColumnResizing,
+    icons: { FilterAltIcon, FilterAltOff },
     localization,
     muiTableHeadCellProps,
+    setShowFilters,
     tableInstance,
   } = useMRT();
 
-  const isParentHeader = (column?.columns?.length ?? 0) > 0;
+  const isParentHeader = !!column?.columns?.length;
 
   const mTableHeadCellProps =
     muiTableHeadCellProps instanceof Function
@@ -73,6 +76,25 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
         column.Header as string,
       );
 
+  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)
+            }`
+          ],
+        )
+    : localization.toggleFilterButtonTitle;
+
+  const columnHeader = column.render('Header') as string;
+
   return (
     <TableCell
       align={isParentHeader ? 'center' : 'left'}
@@ -86,59 +108,84 @@ 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()}
+          {column.render('Header')}
+          {!isParentHeader && column.canSort && (
+            <Tooltip arrow title={sortTooltip}>
+              <TableSortLabel
+                aria-label={sortTooltip}
+                active={column.isSorted}
+                direction={column.isSortedDesc ? 'desc' : 'asc'}
+              />
+            </Tooltip>
+          )}
+          {!isParentHeader && !!column.canFilter && (
+            <Tooltip arrow title={filterTooltip}>
+              <IconButton
+                onClick={(event) => {
+                  event.stopPropagation();
+                  setShowFilters(!tableInstance.state.showFilters);
+                }}
+                size="small"
                 sx={{
-                  borderRightWidth: '2px',
-                  borderRadius: '2px',
-                  maxHeight: '2rem',
+                  opacity: !!column.filterValue ? 0.8 : 0,
+                  p: '2px',
+                  m: 0,
+                  transition: 'all 0.2s ease-in-out',
+                  '&:hover': {
+                    opacity: 0.8,
+                  },
                 }}
-              />
-            )}
-          </Box>
+              >
+                {tableInstance.state.showFilters && !column.filterValue ? (
+                  <FilterAltOff fontSize="small" />
+                ) : (
+                  <FilterAltIcon fontSize="small" />
+                )}
+              </IconButton>
+            </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>
   );
 };