material-react-table 0.5.5 → 0.5.8

package/dist/menus/MRT_ColumnActionMenu.d.ts

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

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.5.5",
+  "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",
+    "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",
@@ -36,8 +36,7 @@
     "size": "size-limit",
     "start": "tsdx watch",
     "storybook": "start-storybook -p 6006",
-    "test": "tsdx test --passWithNoTests",
-    "upgrade": "ncu -u && npm i"
+    "test": "tsdx test --passWithNoTests"
   },
   "husky": {
     "hooks": {
@@ -60,9 +59,9 @@
     "@emotion/react": "^11.8.1",
     "@emotion/styled": "^11.8.1",
     "@etchteam/storybook-addon-status": "^4.2.0",
-    "@faker-js/faker": "^6.0.0-alpha.7",
-    "@mui/icons-material": "^5.4.4",
-    "@mui/material": "^5.4.4",
+    "@faker-js/faker": "^6.0.0-beta.0",
+    "@mui/icons-material": "^5.5.0",
+    "@mui/material": "^5.5.0",
     "@size-limit/preset-small-lib": "^7.0.8",
     "@storybook/addon-a11y": "^6.4.19",
     "@storybook/addon-actions": "^6.4.19",

package/src/MaterialReactTable.tsx

@@ -2,6 +2,8 @@ import React, { ChangeEvent, FC, MouseEvent, ReactNode } from 'react';
 import {
   AlertProps,
   IconButtonProps,
+  LinearProgressProps,
+  SkeletonProps,
   TableBodyProps,
   TableCellProps,
   TableContainerProps,
@@ -17,6 +19,7 @@ import {
   Cell,
   Column,
   ColumnInstance,
+  FilterType,
   // ColumnInterface,
   HeaderGroup,
   Row,
@@ -130,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);
@@ -181,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> &
@@ -244,6 +252,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     isFetching?: boolean;
     isLoading?: boolean;
     localization?: Partial<MRT_Localization>;
+    muiLinearProgressProps?:
+      | LinearProgressProps
+      | ((tableInstance: MRT_TableInstance) => LinearProgressProps);
     muiSearchTextFieldProps?: TextFieldProps;
     muiTableBodyCellEditTextFieldProps?:
       | TextFieldProps
@@ -251,6 +262,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     muiTableBodyCellProps?:
       | TableCellProps
       | ((cell?: MRT_Cell<D>) => TableCellProps);
+    muiTableBodyCellSkeletonProps?:
+      | SkeletonProps
+      | ((cell?: MRT_Cell<D>) => SkeletonProps);
     muiTableBodyProps?:
       | TableBodyProps
       | ((tableInstance: MRT_TableInstance<D>) => TableBodyProps);

package/src/body/MRT_TableBodyCell.tsx

@@ -1,5 +1,5 @@
 import React, { FC, MouseEvent } from 'react';
-import { TableCell, TableCellProps } from '@mui/material';
+import { Skeleton, TableCell, TableCellProps } from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_EditCellTextField } from '../inputs/MRT_EditCellTextField';
 import { MRT_Cell } from '..';
@@ -22,8 +22,10 @@ interface Props {
 
 export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
   const {
-    onCellClick,
+    isLoading,
     muiTableBodyCellProps,
+    muiTableBodyCellSkeletonProps,
+    onCellClick,
     tableInstance: {
       state: { currentEditingRow, densePadding },
     },
@@ -63,7 +65,14 @@ export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
         } as TableCellProps['sx']
       }
     >
-      {currentEditingRow?.id === cell.row.id ? (
+      {isLoading ? (
+        <Skeleton
+          animation="wave"
+          height={20}
+          width={Math.random() * (120 - 60) + 60}
+          {...muiTableBodyCellSkeletonProps}
+        />
+      ) : currentEditingRow?.id === cell.row.id ? (
         <MRT_EditCellTextField cell={cell} />
       ) : cell.isPlaceholder ? null : cell.isAggregated ? (
         cell.render('Aggregated')

package/src/buttons/MRT_ShowHideColumnsButton.tsx

@@ -7,7 +7,6 @@ import {
   Divider,
   IconButtonProps,
   Box,
-  MenuList,
 } from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_ShowHideColumnsMenu } from '../menus/MRT_ShowHideColumnsMenu';
@@ -44,39 +43,40 @@ export const MRT_ShowHideColumnsButton: FC<Props> = ({ ...rest }) => {
         anchorEl={anchorEl}
         open={!!anchorEl}
         onClose={() => setAnchorEl(null)}
+        MenuListProps={{
+          dense: tableInstance.state.densePadding,
+        }}
       >
-        <MenuList dense={tableInstance.state.densePadding} disablePadding>
-          <Box
-            sx={{
-              display: 'flex',
-              justifyContent: 'space-between',
-              p: '0 0.5rem 0.5rem 0.5rem',
-            }}
+        <Box
+          sx={{
+            display: 'flex',
+            justifyContent: 'space-between',
+            p: '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)}
           >
-            <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>
+            {localization.columnShowHideMenuShowAll}
+          </Button>
+        </Box>
+        <Divider />
+        {tableInstance.columns.map((column: MRT_ColumnInstance, index) => (
+          <MRT_ShowHideColumnsMenu
+            key={`${index}-${column.id}`}
+            column={column}
+          />
+        ))}
       </Menu>
     </>
   );

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),
@@ -88,30 +98,44 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
           disabled: !!filterChipLabel,
           sx: {
             textOverflow: 'ellipsis',
-            width: filterChipLabel ? 0 : 'auto',
+            width: filterChipLabel ? 0 : undefined,
+          },
+          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',