material-react-table 0.6.5 → 0.6.8

package/dist/utils.d.ts

@@ -1,2 +1,2 @@
-import { MRT_ColumnInterface } from '.';
-export declare const findLowestLevelCols: (columns: MRT_ColumnInterface[]) => MRT_ColumnInterface<{}>[];
+import { MRT_ColumnInstance, MRT_ColumnInterface } from '.';
+export declare const findLowestLevelCols: (columns: MRT_ColumnInterface[] | MRT_ColumnInstance[]) => MRT_ColumnInterface<{}>[];

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.6.5",
+  "version": "0.6.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.",
@@ -55,13 +55,13 @@
     }
   ],
   "devDependencies": {
-    "@babel/core": "^7.17.5",
+    "@babel/core": "^7.17.7",
     "@emotion/react": "^11.8.2",
     "@emotion/styled": "^11.8.1",
     "@etchteam/storybook-addon-status": "^4.2.0",
-    "@faker-js/faker": "^6.0.0-beta.0",
-    "@mui/icons-material": "^5.5.0",
-    "@mui/material": "^5.5.0",
+    "@faker-js/faker": "^6.0.0",
+    "@mui/icons-material": "^5.5.1",
+    "@mui/material": "^5.5.1",
     "@size-limit/preset-small-lib": "^7.0.8",
     "@storybook/addon-a11y": "^6.4.19",
     "@storybook/addon-actions": "^6.4.19",
@@ -75,10 +75,10 @@
     "@types/faker": "^6.6.8",
     "@types/react": "^17.0.40",
     "@types/react-dom": "^17.0.13",
-    "@types/react-table": "^7.7.9",
+    "@types/react-table": "^7.7.10",
     "babel-loader": "^8.2.3",
     "husky": "^7.0.4",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-is": "^17.0.2",

package/src/MaterialReactTable.tsx

@@ -134,6 +134,9 @@ export type MRT_ColumnInterface<D extends {} = {}> = ColumnInterface<D> &
     Header?: string;
     accessor?: string;
     columns?: MRT_ColumnInterface<D>[];
+    disableClickToCopy?: boolean;
+    disableColumnActions?: boolean;
+    disableColumnHiding?: boolean;
     disableEditing?: boolean;
     disableFilters?: boolean;
     filter?: MRT_FilterType | string | FilterType<D>;
@@ -151,6 +154,9 @@ export type MRT_ColumnInterface<D extends {} = {}> = ColumnInterface<D> &
     muiTableHeadCellFilterTextFieldProps?:
       | TextFieldProps
       | ((column: Column<D>) => TextFieldProps);
+    muiTableHeadCellColumnActionsButtonProps?:
+      | IconButtonProps
+      | ((column: Column<D>) => IconButtonProps);
     muiTableHeadCellProps?:
       | TableCellProps
       | ((column: Column<D>) => TableCellProps);
@@ -232,6 +238,7 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     disableFullScreenToggle?: boolean;
     disableSelectAll?: boolean;
     disableSubRowTree?: boolean;
+    enableClickToCopy?: boolean;
     enableColumnGrouping?: boolean;
     enableColumnResizing?: boolean;
     enableRowActions?: boolean;
@@ -275,6 +282,9 @@ export type MaterialReactTableProps<D extends {} = {}> = UseTableOptions<D> &
     muiTableFooterCellProps?:
       | TableCellProps
       | ((column: Column<D>) => TableCellProps);
+    muiTableHeadCellColumnActionsButtonProps?:
+      | IconButtonProps
+      | ((column: Column<D>) => IconButtonProps);
     muiTableFooterProps?:
       | TableFooterProps
       | ((tableInstance: MRT_TableInstance<D>) => TableFooterProps);

package/src/body/MRT_TableBodyCell.tsx

@@ -3,6 +3,7 @@ import { Skeleton, TableCell, TableCellProps } from '@mui/material';
 import { useMRT } from '../useMRT';
 import { MRT_EditCellTextField } from '../inputs/MRT_EditCellTextField';
 import type { MRT_Cell } from '..';
+import { MRT_CopyButton } from '../buttons/MRT_CopyButton';
 
 export const commonTableBodyCellStyles = (densePadding: boolean) => ({
   p: densePadding ? '0.5rem' : '1rem',
@@ -22,6 +23,7 @@ interface Props {
 
 export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
   const {
+    enableClickToCopy,
     isLoading,
     muiTableBodyCellProps,
     muiTableBodyCellSkeletonProps,
@@ -81,6 +83,8 @@ export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
         <span>
           {cell.render('Cell')} ({cell.row.subRows.length})
         </span>
+      ) : enableClickToCopy && !cell.column.disableClickToCopy ? (
+        <MRT_CopyButton cell={cell} />
       ) : (
         cell.render('Cell')
       )}

package/src/buttons/MRT_CopyButton.tsx

@@ -0,0 +1,50 @@
+import React, { FC, useState } from 'react';
+import { Button, Tooltip } from '@mui/material';
+import { useMRT } from '../useMRT';
+import { MRT_Cell } from '..';
+
+interface Props {
+  cell: MRT_Cell;
+}
+
+export const MRT_CopyButton: FC<Props> = ({ cell }) => {
+  const { localization } = useMRT();
+
+  const [copied, setCopied] = useState(false);
+
+  const handleCopy = (text: string) => {
+    navigator.clipboard.writeText(text);
+    setCopied(true);
+    setTimeout(() => setCopied(false), 4000);
+  };
+
+  return (
+    <Tooltip
+      arrow
+      enterDelay={1000}
+      enterNextDelay={1000}
+      placement="top"
+      title={copied ? localization.copiedToClipboard : localization.clickToCopy}
+    >
+      <Button
+        aria-label={localization.clickToCopy}
+        onClick={() => handleCopy(cell.value)}
+        size="small"
+        sx={{
+          backgroundColor: 'transparent',
+          color: 'inherit',
+          letterSpacing: 'inherit',
+          fontFamily: 'inherit',
+          fontSize: 'inherit',
+          m: '-0.25rem',
+          textTransform: 'inherit',
+          textAlign: 'inherit',
+          minWidth: 'unset',
+        }}
+        variant="text"
+      >
+        {cell.render('Cell')}
+      </Button>
+    </Tooltip>
+  );
+};

package/src/buttons/MRT_ToggleColumnActionMenuButton.tsx

@@ -10,8 +10,9 @@ interface Props {
 
 export const MRT_ToggleColumnActionMenuButton: FC<Props> = ({ column }) => {
   const {
-    localization,
     icons: { MoreVertIcon },
+    localization,
+    muiTableHeadCellColumnActionsButtonProps,
   } = useMRT();
 
   const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
@@ -22,6 +23,21 @@ export const MRT_ToggleColumnActionMenuButton: FC<Props> = ({ column }) => {
     setAnchorEl(event.currentTarget);
   };
 
+  const mTableHeadCellColumnActionsButtonProps =
+    muiTableHeadCellColumnActionsButtonProps instanceof Function
+      ? muiTableHeadCellColumnActionsButtonProps(column)
+      : muiTableHeadCellColumnActionsButtonProps;
+
+  const mcTableHeadCellColumnActionsButtonProps =
+    column.muiTableHeadCellColumnActionsButtonProps instanceof Function
+      ? column.muiTableHeadCellColumnActionsButtonProps(column)
+      : column.muiTableHeadCellColumnActionsButtonProps;
+
+  const iconButtonProps = {
+    ...mTableHeadCellColumnActionsButtonProps,
+    ...mcTableHeadCellColumnActionsButtonProps,
+  };
+
   return (
     <>
       <Tooltip
@@ -35,6 +51,7 @@ export const MRT_ToggleColumnActionMenuButton: FC<Props> = ({ column }) => {
           aria-label={localization.columnActions}
           onClick={handleClick}
           size="small"
+          {...iconButtonProps}
           sx={{
             height: '2rem',
             mr: '2px',
@@ -45,6 +62,7 @@ export const MRT_ToggleColumnActionMenuButton: FC<Props> = ({ column }) => {
             '&:hover': {
               opacity: 1,
             },
+            ...iconButtonProps.sx,
           }}
         >
           <MoreVertIcon />

package/src/head/MRT_TableHeadCell.tsx

@@ -1,4 +1,4 @@
-import React, { FC } from 'react';
+import React, { CSSProperties, FC } from 'react';
 import {
   TableCell,
   TableSortLabel,
@@ -16,6 +16,11 @@ import type { MRT_HeaderGroup } from '..';
 export const commonTableHeadCellStyles = (
   densePadding: boolean,
   enableColumnResizing?: boolean,
+  widths?: {
+    maxWidth?: CSSProperties['maxWidth'];
+    minWidth?: CSSProperties['minWidth'];
+    width?: CSSProperties['width'];
+  },
 ) => ({
   fontWeight: 'bold',
   height: '100%',
@@ -23,6 +28,7 @@ export const commonTableHeadCellStyles = (
   pt: densePadding ? '0.75rem' : '1.25rem',
   transition: `all ${enableColumnResizing ? '10ms' : '0.2s'} ease-in-out`,
   verticalAlign: 'text-top',
+  ...widths,
 });
 
 interface Props {
@@ -105,6 +111,11 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
         ...commonTableHeadCellStyles(
           tableInstance.state.densePadding,
           enableColumnResizing,
+          {
+            maxWidth: column.maxWidth,
+            minWidth: column.minWidth,
+            width: column.width,
+          },
         ),
         ...tableCellProps?.sx,
       }}
@@ -167,9 +178,11 @@ export const MRT_TableHeadCell: FC<Props> = ({ column }) => {
           )}
         </Box>
         <Box sx={{ alignItems: 'center', display: 'flex', flexWrap: 'nowrap' }}>
-          {!disableColumnActions && !isParentHeader && (
-            <MRT_ToggleColumnActionMenuButton column={column} />
-          )}
+          {!disableColumnActions &&
+            !column.disableColumnActions &&
+            !isParentHeader && (
+              <MRT_ToggleColumnActionMenuButton column={column} />
+            )}
           {enableColumnResizing && !isParentHeader && (
             <Divider
               flexItem

package/src/head/MRT_TableHeadCellActions.tsx

@@ -16,7 +16,12 @@ export const MRT_TableHeadCellActions: FC<Props> = () => {
   return (
     <TableCell
       style={{ textAlign: 'center' }}
-      sx={{ ...commonTableHeadCellStyles(densePadding), textAlign: 'center' }}
+      sx={{
+        ...commonTableHeadCellStyles(densePadding),
+        textAlign: 'center',
+        maxWidth: '4rem',
+        width: '4rem',
+      }}
     >
       {localization.actions}
     </TableCell>

package/src/head/MRT_TableHeadRow.tsx

@@ -19,6 +19,7 @@ export const MRT_TableHeadRow: FC<Props> = ({ headerGroup }) => {
   const {
     anyRowsCanExpand,
     disableExpandAll,
+    disableSelectAll,
     enableRowActions,
     enableRowEditing,
     enableRowNumbers,
@@ -81,7 +82,7 @@ export const MRT_TableHeadRow: FC<Props> = ({ headerGroup }) => {
         )
       ) : null}
       {enableSelection ? (
-        !isParentHeader ? (
+        !isParentHeader && !disableSelectAll ? (
           <MRT_SelectCheckbox selectAll />
         ) : (
           <MRT_TableSpacerCell width="1rem" />

package/src/icons.ts

@@ -1,7 +1,9 @@
 import ArrowRightIcon from '@mui/icons-material/ArrowRight';
 import CancelIcon from '@mui/icons-material/Cancel';
+import CheckBoxIcon from '@mui/icons-material/CheckBox';
 import ClearAllIcon from '@mui/icons-material/ClearAll';
 import CloseIcon from '@mui/icons-material/Close';
+import ContentCopyIcon from '@mui/icons-material/ContentCopy';
 import DensityMediumIcon from '@mui/icons-material/DensityMedium';
 import DensitySmallIcon from '@mui/icons-material/DensitySmall';
 import DoubleArrowDownIcon from '@mui/icons-material/KeyboardDoubleArrowDown';
@@ -27,8 +29,10 @@ import VisibilityOffIcon from '@mui/icons-material/VisibilityOff';
 export interface MRT_Icons {
   ArrowRightIcon: any;
   CancelIcon: any;
+  CheckBoxIcon: any;
   ClearAllIcon: any;
   CloseIcon: any;
+  ContentCopyIcon: any;
   DensityMediumIcon: any;
   DensitySmallIcon: any;
   DoubleArrowDownIcon: any;
@@ -55,8 +59,10 @@ export interface MRT_Icons {
 export const MRT_Default_Icons: MRT_Icons = {
   ArrowRightIcon,
   CancelIcon,
+  CheckBoxIcon,
   ClearAllIcon,
   CloseIcon,
+  ContentCopyIcon,
   DensityMediumIcon,
   DensitySmallIcon,
   DoubleArrowDownIcon,

package/src/inputs/MRT_EditCellTextField.tsx

@@ -39,12 +39,6 @@ export const MRT_EditCellTextField: FC<Props> = ({ cell }) => {
   const textFieldProps = {
     ...mTableBodyCellEditTextFieldProps,
     ...mcTableBodyCellEditTextFieldProps,
-    style: {
-      //@ts-ignore
-      ...muiTableBodyCellEditTextFieldProps?.style,
-      //@ts-ignore
-      ...cell.column.muiTableBodyCellEditTextFieldProps?.style,
-    },
   };
 
   if (!cell.column.disableEditing && cell.column.Edit) {

package/src/inputs/MRT_FilterTextField.tsx

@@ -43,10 +43,6 @@ export const MRT_FilterTextField: FC<Props> = ({ column }) => {
   const textFieldProps = {
     ...mTableHeadCellFilterTextFieldProps,
     ...mcTableHeadCellFilterTextFieldProps,
-    style: {
-      ...mTableHeadCellFilterTextFieldProps?.style,
-      ...mcTableHeadCellFilterTextFieldProps?.style,
-    },
   } as TextFieldProps;
 
   const [filterValue, setFilterValue] = useState('');

package/src/inputs/MRT_SelectCheckbox.tsx

@@ -29,7 +29,11 @@ export const MRT_SelectCheckbox: FC<Props> = ({ row, selectAll }) => {
 
   return (
     <TableCell
-      sx={commonTableBodyButtonCellStyles(tableInstance.state.densePadding)}
+      sx={{
+        ...commonTableBodyButtonCellStyles(tableInstance.state.densePadding),
+        maxWidth: '2rem',
+        width: '2rem',
+      }}
     >
       <Tooltip
         arrow

package/src/localization.ts

@@ -5,7 +5,9 @@ export interface MRT_Localization {
   clearFilter: string;
   clearSearch: string;
   clearSort: string;
+  clickToCopy: string;
   columnActions: string;
+  copiedToClipboard: string;
   edit: string;
   expand: string;
   expandAll: string;
@@ -52,7 +54,9 @@ export const MRT_DefaultLocalization_EN: MRT_Localization = {
   clearFilter: 'Clear filter',
   clearSearch: 'Clear search',
   clearSort: 'Clear sort',
+  clickToCopy: 'Click to copy',
   columnActions: 'Column Actions',
+  copiedToClipboard: 'Copied to clipboard',
   edit: 'Edit',
   expand: 'Expand',
   expandAll: 'Expand all',

package/src/menus/MRT_ColumnActionMenu.tsx

@@ -246,7 +246,12 @@ export const MRT_ColumnActionMenu: FC<Props> = ({
           </MenuItem>,
         ]}
       {!disableColumnHiding && [
-        <MenuItem key={0} onClick={handleHideColumn} sx={commonMenuItemStyles}>
+        <MenuItem
+          disabled={column.disableColumnHiding}
+          key={0}
+          onClick={handleHideColumn}
+          sx={commonMenuItemStyles}
+        >
           <Box sx={commonListItemStyles}>
             <ListItemIcon>
               <VisibilityOffIcon />

package/src/menus/MRT_FilterTypeMenu.tsx

@@ -43,68 +43,72 @@ export const MRT_FilterTypeMenu: FC<Props> = ({
     divider: boolean;
     fn: Function;
   }[] = useMemo(
-    () => [
-      {
-        type: MRT_FILTER_TYPE.FUZZY,
-        label: localization.filterFuzzy,
-        divider: false,
-        fn: fuzzy,
-      },
-      {
-        type: MRT_FILTER_TYPE.CONTAINS,
-        label: localization.filterContains,
-        divider: true,
-        fn: contains,
-      },
-      {
-        type: MRT_FILTER_TYPE.STARTS_WITH,
-        label: localization.filterStartsWith,
-        divider: false,
-        fn: startsWith,
-      },
-      {
-        type: MRT_FILTER_TYPE.ENDS_WITH,
-        label: localization.filterEndsWith,
-        divider: true,
-        fn: endsWith,
-      },
-      {
-        type: MRT_FILTER_TYPE.EQUALS,
-        label: localization.filterEquals,
-        divider: false,
-        fn: equals,
-      },
-      {
-        type: MRT_FILTER_TYPE.NOT_EQUALS,
-        label: localization.filterNotEquals,
-        divider: true,
-        fn: notEquals,
-      },
-      {
-        type: MRT_FILTER_TYPE.GREATER_THAN,
-        label: localization.filterGreaterThan,
-        divider: false,
-        fn: greaterThan,
-      },
-      {
-        type: MRT_FILTER_TYPE.LESS_THAN,
-        label: localization.filterLessThan,
-        divider: true,
-        fn: lessThan,
-      },
-      {
-        type: MRT_FILTER_TYPE.EMPTY,
-        label: localization.filterEmpty,
-        divider: false,
-        fn: empty,
-      },
-      {
-        type: MRT_FILTER_TYPE.NOT_EMPTY,
-        label: localization.filterNotEmpty,
-        divider: false,
-        fn: notEmpty,
-      },
-    ],
+    () =>
+      [
+        {
+          type: MRT_FILTER_TYPE.FUZZY,
+          label: localization.filterFuzzy,
+          divider: false,
+          fn: fuzzy,
+        },
+        {
+          type: MRT_FILTER_TYPE.CONTAINS,
+          label: localization.filterContains,
+          divider: true,
+          fn: contains,
+        },
+        {
+          type: MRT_FILTER_TYPE.STARTS_WITH,
+          label: localization.filterStartsWith,
+          divider: false,
+          fn: startsWith,
+        },
+        {
+          type: MRT_FILTER_TYPE.ENDS_WITH,
+          label: localization.filterEndsWith,
+          divider: true,
+          fn: endsWith,
+        },
+        {
+          type: MRT_FILTER_TYPE.EQUALS,
+          label: localization.filterEquals,
+          divider: false,
+          fn: equals,
+        },
+        {
+          type: MRT_FILTER_TYPE.NOT_EQUALS,
+          label: localization.filterNotEquals,
+          divider: true,
+          fn: notEquals,
+        },
+        {
+          type: MRT_FILTER_TYPE.GREATER_THAN,
+          label: localization.filterGreaterThan,
+          divider: false,
+          fn: greaterThan,
+        },
+        {
+          type: MRT_FILTER_TYPE.LESS_THAN,
+          label: localization.filterLessThan,
+          divider: true,
+          fn: lessThan,
+        },
+        {
+          type: MRT_FILTER_TYPE.EMPTY,
+          label: localization.filterEmpty,
+          divider: false,
+          fn: empty,
+        },
+        {
+          type: MRT_FILTER_TYPE.NOT_EMPTY,
+          label: localization.filterNotEmpty,
+          divider: false,
+          fn: notEmpty,
+        },
+      ].filter(
+        (filterType) =>
+          !column.filterTypes || column.filterTypes.includes(filterType.type),
+      ),
     [],
   );
 

package/src/menus/MRT_ShowHideColumnsMenu.tsx

@@ -3,6 +3,7 @@ import { Button, Menu, Divider, Box } from '@mui/material';
 import type { MRT_ColumnInstance } from '..';
 import { useMRT } from '../useMRT';
 import { MRT_ShowHideColumnsMenuItems } from './MRT_ShowHideColumnsMenuItems';
+import { findLowestLevelCols } from '../utils';
 
 interface Props {
   anchorEl: HTMLElement | null;
@@ -17,6 +18,16 @@ export const MRT_ShowHideColumnsMenu: FC<Props> = ({
 }) => {
   const { localization, tableInstance } = useMRT();
 
+  const hideAllColumns = () => {
+    (
+      findLowestLevelCols(
+        tableInstance.columns as MRT_ColumnInstance[],
+      ) as MRT_ColumnInstance[]
+    )
+      .filter((col: MRT_ColumnInstance) => !col.disableColumnHiding)
+      .forEach((col: MRT_ColumnInstance) => col.toggleHidden(true));
+  };
+
   return (
     <Menu
       anchorEl={anchorEl}
@@ -40,7 +51,7 @@ export const MRT_ShowHideColumnsMenu: FC<Props> = ({
               !tableInstance.getToggleHideAllColumnsProps().checked &&
               !tableInstance.getToggleHideAllColumnsProps().indeterminate
             }
-            onClick={() => tableInstance.toggleHideAllColumns(true)}
+            onClick={hideAllColumns}
           >
             {localization.hideAll}
           </Button>

package/src/menus/MRT_ShowHideColumnsMenuItems.tsx

@@ -43,7 +43,7 @@ export const MRT_ShowHideColumnsMenuItems: FC<Props> = ({
           componentsProps={{ typography: { sx: { marginBottom: 0 } } }}
           checked={switchChecked}
           control={<Switch />}
-          disabled={isSubMenu && switchChecked}
+          disabled={(isSubMenu && switchChecked) || column.disableColumnHiding}
           label={column.Header as string}
           onChange={() => handleToggleColumnHidden(column)}
         />

package/src/table/MRT_TableSpacerCell.tsx

@@ -9,18 +9,11 @@ interface Props {
 export const MRT_TableSpacerCell: FC<Props> = ({ width }) => {
   const { muiTableBodyCellProps } = useMRT();
 
-  const mTableBodyCellrops =
+  const tableCellProps =
     muiTableBodyCellProps instanceof Function
       ? muiTableBodyCellProps()
       : muiTableBodyCellProps;
 
-  const tableCellProps = {
-    ...mTableBodyCellrops,
-    style: {
-      ...mTableBodyCellrops?.style,
-    },
-  };
-
   return (
     <TableCell {...tableCellProps} sx={{ width, ...tableCellProps?.sx }} />
   );

package/src/utils.ts

@@ -1,8 +1,12 @@
-import { MRT_ColumnInterface } from '.';
+import { MRT_ColumnInstance, MRT_ColumnInterface } from '.';
 
-export const findLowestLevelCols = (columns: MRT_ColumnInterface[]) => {
-  let lowestLevelColumns: MRT_ColumnInterface[] = columns;
-  let currentCols: MRT_ColumnInterface[] | undefined = columns;
+export const findLowestLevelCols = (
+  columns: MRT_ColumnInterface[] | MRT_ColumnInstance[],
+) => {
+  let lowestLevelColumns: MRT_ColumnInterface[] | MRT_ColumnInstance[] =
+    columns;
+  let currentCols: MRT_ColumnInterface[] | MRT_ColumnInstance[] | undefined =
+    columns;
   while (!!currentCols?.length && currentCols.some((col) => col.columns)) {
     const nextCols: MRT_ColumnInterface[] = currentCols
       .filter((col) => !!col.columns)