material-react-table 0.5.2 → 0.5.5

package/src/menus/MRT_FilterTypeMenu.tsx

@@ -0,0 +1,107 @@
+import React, { FC, useMemo } from 'react';
+import { Menu, MenuItem, MenuList } 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_FilterTypeMenu: 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 handleSelectFilterType = (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}
+      anchorOrigin={{ vertical: 'center', horizontal: 'right' }}
+      onClose={() => setAnchorEl(null)}
+      open={!!anchorEl}
+    >
+      <MenuList dense={tableInstance.state.densePadding} disablePadding>
+        {filterTypes.map(({ type, label, divider }) => (
+          <MenuItem
+            divider={divider}
+            key={type}
+            onClick={() => handleSelectFilterType(type)}
+            selected={type === filterType}
+            value={type}
+          >
+            {label}
+          </MenuItem>
+        ))}
+      </MenuList>
+    </Menu>
+  );
+};

package/src/menus/MRT_RowActionMenu.tsx

@@ -1,5 +1,11 @@
 import React, { FC } from 'react';
-import { Menu, MenuItem } from '@mui/material';
+import {
+  ListItemIcon,
+  ListItemText,
+  Menu,
+  MenuItem,
+  MenuList,
+} from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_Row } from '..';
 
@@ -30,14 +36,19 @@ export const MRT_RowActionMenu: FC<Props> = ({
       open={!!anchorEl}
       onClose={() => setAnchorEl(null)}
     >
-      {enableRowEditing && (
-        <MenuItem sx={{ display: 'flex', gap: '0.75rem' }} onClick={handleEdit}>
-          <EditIcon /> {localization.rowActionMenuItemEdit}
-        </MenuItem>
-      )}
-      {renderRowActionMenuItems?.(row, tableInstance, () =>
-        setAnchorEl(null),
-      ) ?? null}
+      <MenuList dense={tableInstance.state.densePadding} disablePadding>
+        {enableRowEditing && (
+          <MenuItem onClick={handleEdit}>
+            <ListItemIcon>
+              <EditIcon />
+            </ListItemIcon>
+            <ListItemText>{localization.rowActionMenuItemEdit}</ListItemText>
+          </MenuItem>
+        )}
+        {renderRowActionMenuItems?.(row, tableInstance, () =>
+          setAnchorEl(null),
+        ) ?? null}
+      </MenuList>
     </Menu>
   );
 };

package/src/menus/MRT_ShowHideColumnsMenu.tsx

@@ -8,7 +8,7 @@ interface Props {
 }
 
 export const MRT_ShowHideColumnsMenu: FC<Props> = ({ column }) => {
-  const isParentHeader = (column?.columns?.length ?? 0) > 0;
+  const isParentHeader = !!column?.columns?.length;
 
   const allChildColumnsVisible =
     isParentHeader &&

package/src/table/MRT_Table.tsx

@@ -11,12 +11,17 @@ export const MRT_Table: FC<Props> = () => {
   const { tableInstance, muiTableProps, hideTableHead, hideTableFooter } =
     useMRT();
 
+  const mTableProps =
+    muiTableProps instanceof Function
+      ? muiTableProps(tableInstance)
+      : muiTableProps;
+
   const tableProps = {
-    ...muiTableProps,
+    ...mTableProps,
     ...tableInstance.getTableProps(),
     style: {
       ...tableInstance.getTableProps().style,
-      ...muiTableProps?.style,
+      ...mTableProps?.style,
     },
   };
 

package/src/table/MRT_TableContainer.tsx

@@ -1,5 +1,11 @@
 import React, { FC, useEffect, useRef } from 'react';
-import { LinearProgress, Paper, TableContainer, Collapse } from '@mui/material';
+import {
+  LinearProgress,
+  Paper,
+  TableContainer,
+  Collapse,
+  Box,
+} from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_Table } from './MRT_Table';
 import { MRT_ToolbarTop } from '../toolbar/MRT_ToolbarTop';
@@ -63,7 +69,14 @@ export const MRT_TableContainer: FC<Props> = () => {
       <Collapse in={isFetching || isLoading} unmountOnExit>
         <LinearProgress />
       </Collapse>
-      <MRT_Table />
+      <Box
+        sx={{
+          maxWidth: '100%',
+          overflowX: 'auto',
+        }}
+      >
+        <MRT_Table />
+      </Box>
       {!hideToolbarBottom && <MRT_ToolbarBottom />}
     </TableContainer>
   );

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>>,
+  );