material-react-table 0.3.0 → 0.3.1

package/dist/menus/MRT_RowActionMenu.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+import { Row } from 'react-table';
+interface Props {
+    anchorEl: HTMLElement | null;
+    row: Row;
+    setAnchorEl: (anchorEl: HTMLElement | null) => void;
+}
+export declare const MRT_RowActionMenu: FC<Props>;
+export {};

package/dist/toolbar/MRT_ToolbarBottom.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+interface Props {
+}
+export declare const MRT_ToolbarBottom: FC<Props>;
+export {};

package/dist/toolbar/MRT_ToolbarButtons.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+interface Props {
+}
+export declare const MRT_ToolbarButtons: FC<Props>;
+export {};

package/dist/toolbar/{MRT_Toolbar.d.ts → MRT_ToolbarTop.d.ts}

@@ -1,5 +1,5 @@
 import { FC } from 'react';
 interface Props {
 }
-export declare const MRT_Toolbar: FC<Props>;
+export declare const MRT_ToolbarTop: FC<Props>;
 export {};

package/dist/useMaterialReactTable.d.ts

@@ -3,7 +3,13 @@ import { TableInstance } from 'react-table';
 import { MaterialReactTableProps } from './MaterialReactTable';
 import { UseMRTCalcs } from './utils/useMRTCalcs';
 export interface UseMaterialReactTable<D extends {}> extends MaterialReactTableProps<D>, UseMRTCalcs {
+    currentEditingRowId: string | null;
+    densePadding: boolean;
+    setCurrentEditingRowId: (currentRowEditingId: string | null) => void;
+    setDensePadding: (densePadding: boolean) => void;
+    setShowFilters: (showFilters: boolean) => void;
+    showFilters: boolean;
     tableInstance: TableInstance<D>;
 }
-export declare const MaterialReactTableProvider: <D extends {}>({ children, columns, data, defaultColumn, getRowId, getSubRows, initialState, stateReducer, surpressoverrideWarnings, ...rest }: React.PropsWithChildren<MaterialReactTableProps<D>>) => JSX.Element;
+export declare const MaterialReactTableProvider: <D extends {}>(props: React.PropsWithChildren<MaterialReactTableProps<D>>) => JSX.Element;
 export declare const useMaterialReactTable: <D extends {}>() => UseMaterialReactTable<D>;

package/dist/utils/localization.d.ts

@@ -1,17 +1,25 @@
 export interface MRT_Localization {
-    columnActionMenuButtonTitle?: string;
-    columnActionMenuItemHideColumn?: string;
-    columnActionMenuItemSortAsc?: string;
-    columnActionMenuItemClearSort?: string;
-    columnActionMenuItemSortDesc?: string;
-    columnActionMenuItemGroupBy?: string;
-    columnActionMenuItemUnGroupBy?: string;
-    expandAllButtonTitle?: string;
-    expandButtonTitle?: string;
-    filterTextFieldClearButtonTitle?: string;
-    filterTextFieldPlaceholder?: string;
-    searchTextFieldClearButtonTitle?: string;
-    searchTextFieldPlaceholder?: string;
-    showHideColumnsButtonTitle?: string;
+    actionsHeadColumnTitle: string;
+    columnActionMenuButtonTitle: string;
+    columnActionMenuItemClearSort: string;
+    columnActionMenuItemGroupBy: string;
+    columnActionMenuItemHideColumn: string;
+    columnActionMenuItemSortAsc: string;
+    columnActionMenuItemSortDesc: string;
+    columnActionMenuItemUnGroupBy: string;
+    expandAllButtonTitle: string;
+    expandButtonTitle: string;
+    filterTextFieldClearButtonTitle: string;
+    filterTextFieldPlaceholder: string;
+    rowActionMenuButtonTitle: string;
+    rowActionsColumnTitle: string;
+    rowActionButtonSave: string;
+    rowActionButtonCancel: string;
+    rowActionMenuItemEdit: string;
+    searchTextFieldClearButtonTitle: string;
+    searchTextFieldPlaceholder: string;
+    showHideColumnsButtonTitle: string;
+    toggleDensePaddingSwitchTitle: string;
+    toggleFilterButtonTitle: string;
 }
 export declare const defaultLocalization: MRT_Localization;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.0",
+  "version": "0.3.1",
   "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.",
@@ -35,7 +35,8 @@
     "size": "size-limit",
     "analyze": "size-limit --why",
     "storybook": "start-storybook -p 6006",
-    "build-storybook": "build-storybook"
+    "build-storybook": "build-storybook",
+    "upgrade": "ncu -u && npm i"
   },
   "husky": {
     "hooks": {
@@ -54,22 +55,22 @@
     }
   ],
   "devDependencies": {
-    "@babel/core": "^7.16.10",
+    "@babel/core": "^7.16.12",
     "@emotion/react": "^11.7.1",
     "@emotion/styled": "^11.6.0",
-    "@faker-js/faker": "^6.0.0-alpha.3",
-    "@mui/icons-material": "^5.3.0",
-    "@mui/material": "^5.3.0",
+    "@faker-js/faker": "^6.0.0-alpha.5",
+    "@mui/icons-material": "^5.3.1",
+    "@mui/material": "^5.3.1",
     "@size-limit/preset-small-lib": "^7.0.5",
-    "@storybook/addon-a11y": "^6.4.13",
-    "@storybook/addon-actions": "^6.4.13",
+    "@storybook/addon-a11y": "^6.4.16",
+    "@storybook/addon-actions": "^6.4.16",
     "@storybook/addon-console": "^1.2.3",
-    "@storybook/addon-essentials": "^6.4.13",
+    "@storybook/addon-essentials": "^6.4.16",
     "@storybook/addon-info": "^5.3.21",
-    "@storybook/addon-links": "^6.4.13",
-    "@storybook/addon-storysource": "^6.4.13",
-    "@storybook/addons": "^6.4.13",
-    "@storybook/react": "^6.4.13",
+    "@storybook/addon-links": "^6.4.16",
+    "@storybook/addon-storysource": "^6.4.16",
+    "@storybook/addons": "^6.4.16",
+    "@storybook/react": "^6.4.16",
     "@types/faker": "^6.6.8",
     "@types/react": "^17.0.38",
     "@types/react-dom": "^17.0.11",
@@ -83,6 +84,7 @@
     "react-table": "^7.7.0",
     "size-limit": "^7.0.5",
     "storybook-addon-performance": "^0.16.1",
+    "storybook-dark-mode": "^1.0.8",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
     "typescript": "^4.5.5"

package/src/MaterialReactTable.tsx

@@ -7,131 +7,148 @@ import {
   TableHeadProps,
   TablePaginationProps,
   TableProps,
+  TableRowProps,
   TextFieldProps,
   ToolbarProps,
   TypographyProps,
 } from '@mui/material';
 import {
   Cell,
+  Column,
   HeaderGroup,
   Row,
   TableInstance,
   TableOptions,
+  UseExpandedOptions,
+  UseFiltersOptions,
+  UseGlobalFiltersOptions,
+  UseGroupByOptions,
+  UsePaginationOptions,
+  UseResizeColumnsOptions,
+  UseRowSelectOptions,
+  UseRowStateOptions,
+  UseSortByOptions,
 } from 'react-table';
 import { MaterialReactTableProvider } from './useMaterialReactTable';
 import { MRT_TableContainer } from './table/MRT_TableContainer';
 import { defaultLocalization, MRT_Localization } from './utils/localization';
 
-export interface MaterialReactTableProps<D extends {} = {}>
-  extends TableOptions<D> {
-  enableColumnActions?: boolean;
-  enableColumnGrouping?: boolean;
-  enableColumnHiding?: boolean;
-  enableColumnReordering?: boolean;
-  enableColumnResizing?: boolean;
-  enableExpandAll?: boolean;
-  enableFiltering?: boolean;
-  enablePagination?: boolean;
-  enableSearch?: boolean;
-  enableSelectAll?: boolean;
-  enableSelection?: boolean;
-  enableSorting?: boolean;
-  enableSubRowTree?: boolean;
-  isFetching?: boolean;
-  isLoading?: boolean;
-  localization?: Partial<MRT_Localization>;
-  onCellClick?: (
-    event: MouseEvent<HTMLTableCellElement>,
-    cell: Cell<D>,
-  ) => void;
-  onRowClick?: (event: MouseEvent<HTMLTableRowElement>, row: Row<D>) => void;
-  onRowExpandChange?: (
-    event: MouseEvent<HTMLButtonElement>,
-    row: Row<D>,
-  ) => void;
-  onRowSelectChange?: (
-    event: ChangeEvent,
-    row: Row<D>,
-    selectedRows: Row<D>[],
-  ) => void;
-  onSearchChange?: (event: ChangeEvent<HTMLInputElement>) => void;
-  overrideTableBodyCellComponent?(
-    cell: Cell<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableBodyComponent?(tableInstance: TableInstance<D>): ReactNode;
-  overrideTableBodyRowComponent?(
-    row: Row<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableDetailPanelComponent?(
-    row: Row<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableFooterCellComponent?(
-    column: HeaderGroup<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableFooterComponent?(tableInstance: TableInstance<D>): ReactNode;
-  overrideTableFooterRowComponent?(
-    footerGroup: HeaderGroup<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableHeadCellComponent?(
-    column: HeaderGroup<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTableHeadComponent?(tableInstance: TableInstance<D>): ReactNode;
-  overrideTableHeadRowComponent?(
-    headerGroup: HeaderGroup<D>,
-    tableInstance: TableInstance<D>,
-  ): ReactNode;
-  overrideTablePaginationComponent?(tableInstance: TableInstance<D>): ReactNode;
-  overrideTableToolbarComponent?(tableInstance: TableInstance<D>): ReactNode;
-  positionPagination?: 'bottom' | 'top' | 'both';
-  renderDetailPanel?: (rowData: Row<D>) => ReactNode;
-  showFiltersInColumnHead?: boolean;
-  showFooter?: boolean;
-  showHead?: boolean;
-  showToolbar?: boolean;
-  surpressoverrideWarnings?: boolean;
-  tableBodyProps?: TableBodyProps;
-  tableContainerProps?: TableContainerProps;
-  tableDetailPanelProps?: TableCellProps;
-  tableFooterProps?: TableFooterProps;
-  tableHeadProps?: TableHeadProps;
-  tablePaginationProps?: TablePaginationProps;
-  tableProps?: TableProps;
-  tableSearchTextfieldProps?: TextFieldProps;
-  tableTitleProps?: TypographyProps;
-  tableToolbarProps?: ToolbarProps;
-  title?: string | ReactNode;
-}
+export type MaterialReactTableProps<D extends {} = {}> = TableOptions<D> &
+  UseExpandedOptions<D> &
+  UseFiltersOptions<D> &
+  UseGlobalFiltersOptions<D> &
+  UseGroupByOptions<D> &
+  UsePaginationOptions<D> &
+  UseResizeColumnsOptions<D> &
+  UseRowSelectOptions<D> &
+  UseRowStateOptions<D> &
+  UseSortByOptions<D> & {
+    defaultDensePadding?: boolean;
+    defaultShowFilters?: boolean;
+    disableColumnActions?: boolean;
+    disableColumnHiding?: boolean;
+    disableDensePaddingToggle?: boolean;
+    disableExpandAll?: boolean;
+    disableSelectAll?: boolean;
+    disableSubRowTree?: boolean;
+    enableColumnGrouping?: boolean;
+    enableColumnResizing?: boolean;
+    enableRowActions?: boolean;
+    enableRowEditing?: boolean;
+    enableSelection?: boolean;
+    hideTableFooter?: boolean;
+    hideTableHead?: boolean;
+    hideToolbarActions?: boolean;
+    hideToolbarBottom?: boolean;
+    hideToolbarTop?: boolean;
+    isFetching?: boolean;
+    isLoading?: boolean;
+    localization?: Partial<MRT_Localization>;
+    muiSearchTextFieldProps?: TextFieldProps;
+    muiTableBodyCellProps?:
+      | TableCellProps
+      | ((cell?: Cell<D>) => TableCellProps);
+    muiTableBodyProps?: TableBodyProps;
+    muiTableBodyRowProps?: TableRowProps | ((row: Row<D>) => TableRowProps);
+    muiTableContainerProps?: TableContainerProps;
+    muiTableDetailPanelProps?:
+      | TableCellProps
+      | ((row: Row<D>) => TableCellProps);
+    muiTableFooterCellProps?:
+      | TableCellProps
+      | ((column: Column<D>) => TableCellProps);
+    muiTableFooterProps?: TableFooterProps;
+    muiTableFooterRowProps?:
+      | TableRowProps
+      | ((footerGroup: HeaderGroup<D>) => TableRowProps);
+    muiTableHeadCellProps?:
+      | TableCellProps
+      | ((column: Column<D>) => TableCellProps);
+    muiTableHeadProps?: TableHeadProps;
+    muiTableHeadRowProps?:
+      | TableRowProps
+      | ((row: HeaderGroup<D>) => TableRowProps);
+    muiTablePaginationProps?:
+      | Partial<TablePaginationProps>
+      | ((tableInstance: TableInstance<D>) => Partial<TablePaginationProps>);
+    muiTableProps?: TableProps;
+    muiTableTitleProps?: TypographyProps;
+    muiTableToolbarBottomProps?:
+      | ToolbarProps
+      | ((tableInstance: TableInstance<D>) => ToolbarProps);
+    muiTableToolbarTopProps?:
+      | ToolbarProps
+      | ((tableInstance: TableInstance<D>) => ToolbarProps);
+    onCellClick?: (
+      event: MouseEvent<HTMLTableCellElement>,
+      cell: Cell<D>,
+    ) => void;
+    onDetailPanelClick?: (
+      event: MouseEvent<HTMLTableCellElement>,
+      row: Row<D>,
+    ) => void;
+    onGlobalFilterChange?: (event: ChangeEvent<HTMLInputElement>) => void;
+    onRowClick?: (event: MouseEvent<HTMLTableRowElement>, row: Row<D>) => void;
+    onRowEditSubmit?: (row: Row<D>) => Promise<void> | void;
+    onRowExpandChange?: (
+      event: MouseEvent<HTMLButtonElement>,
+      row: Row<D>,
+    ) => void;
+    onRowSelectChange?: (
+      event: ChangeEvent,
+      row: Row<D>,
+      selectedRows: Row<D>[],
+    ) => void;
+    positionActionsColumn?: 'first' | 'last';
+    positionPagination?: 'bottom' | 'top' | 'both';
+    positionToolbarActions?: 'bottom' | 'top';
+    renderRowActions?: (
+      row: Row<D>,
+      tableInstance: TableInstance<D>,
+    ) => ReactNode;
+    renderDetailPanel?: (row: Row<D>) => ReactNode;
+    renderRowActionMenuItems?: (
+      rowData: Row<D>,
+      tableInstance: TableInstance<D>,
+      closeMenu: () => void,
+    ) => ReactNode[];
+    title?: string | ReactNode;
+  };
 
-export const MaterialReactTable = <D extends {}>({
+export default <D extends {}>({
   defaultColumn = { minWidth: 50, maxWidth: 1000 },
-  enablePagination = true,
-  enableSorting = true,
-  enableSubRowTree = true,
   localization = defaultLocalization,
+  positionActionsColumn = 'first',
   positionPagination = 'bottom',
-  showFiltersInColumnHead = true,
-  showFooter = true,
-  showHead = true,
-  showToolbar = true,
+  positionToolbarActions = 'top',
   ...rest
 }: MaterialReactTableProps<D>) => (
   <MaterialReactTableProvider
     defaultColumn={defaultColumn}
-    enablePagination={enablePagination}
-    enableSorting={enableSorting}
-    enableSubRowTree={enableSubRowTree}
     localization={{ ...defaultLocalization, ...localization }}
     positionPagination={positionPagination}
-    showFiltersInColumnHead={showFiltersInColumnHead}
-    showFooter={showFooter}
-    showHead={showHead}
-    showToolbar={showToolbar}
+    positionActionsColumn={positionActionsColumn}
+    positionToolbarActions={positionToolbarActions}
     {...rest}
   >
     <MRT_TableContainer />

package/src/body/MRT_TableBody.tsx

@@ -1,5 +1,6 @@
 import React, { FC } from 'react';
 import {
+  alpha,
   CircularProgress,
   styled,
   TableBody as MuiTableBody,
@@ -11,8 +12,8 @@ const TableBody = styled(MuiTableBody)({
   overflowY: 'hidden',
 });
 
-const CircularProgressWrapper = styled('div')({
-  backgroundColor: 'rgba(255, 255, 255, 0.5)',
+const CircularProgressWrapper = styled('div')(({ theme }) => ({
+  backgroundColor: alpha(theme.palette.background.paper, 0.5),
   display: 'grid',
   height: '100%',
   justifyContent: 'center',
@@ -20,38 +21,36 @@ const CircularProgressWrapper = styled('div')({
   paddingTop: '5rem',
   position: 'fixed',
   width: 'calc(100% - 2rem)',
-});
+}));
 
 interface Props {}
 
 export const MRT_TableBody: FC<Props> = () => {
-  const {
-    tableInstance,
-    tableBodyProps,
-    isLoading,
-    enablePagination,
-    overrideTableBodyComponent,
-  } = useMaterialReactTable();
+  const { tableInstance, muiTableBodyProps, isLoading, manualPagination } =
+    useMaterialReactTable();
 
-  if (overrideTableBodyComponent) {
-    return <>{overrideTableBodyComponent(tableInstance)}</>;
-  }
+  const rows = manualPagination ? tableInstance.rows : tableInstance.page;
 
-  const rows = enablePagination ? tableInstance.page : tableInstance.rows;
+  const tableBodyProps = {
+    ...muiTableBodyProps,
+    ...tableInstance.getTableBodyProps(),
+    style: {
+      ...tableInstance.getTableBodyProps().style,
+      ...(muiTableBodyProps?.style ?? {}),
+    },
+  };
 
   return (
-    <>
-      <TableBody {...tableBodyProps} {...tableInstance.getTableBodyProps()}>
-        {isLoading && (
-          <CircularProgressWrapper>
-            <CircularProgress />
-          </CircularProgressWrapper>
-        )}
-        {rows.map((row, index) => {
-          tableInstance.prepareRow(row);
-          return <MRT_TableBodyRow key={`${index}-${row.id}`} row={row} />;
-        })}
-      </TableBody>
-    </>
+    <TableBody {...tableBodyProps}>
+      {isLoading && (
+        <CircularProgressWrapper>
+          <CircularProgress />
+        </CircularProgressWrapper>
+      )}
+      {rows.map((row) => {
+        tableInstance.prepareRow(row);
+        return <MRT_TableBodyRow key={row.getRowProps().key} row={row} />;
+      })}
+    </TableBody>
   );
 };

package/src/body/MRT_TableBodyCell.tsx

@@ -8,20 +8,31 @@ interface Props {
 }
 
 export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
-  const { tableInstance, overrideTableBodyCellComponent, onCellClick } =
+  const { onCellClick, muiTableBodyCellProps, densePadding } =
     useMaterialReactTable();
 
-  if (overrideTableBodyCellComponent) {
-    return <>{overrideTableBodyCellComponent(cell, tableInstance)}</>;
-  }
+  const mTableCellBodyProps =
+    muiTableBodyCellProps instanceof Function
+      ? muiTableBodyCellProps(cell)
+      : muiTableBodyCellProps;
+
+  const tableCellProps = {
+    ...mTableCellBodyProps,
+    ...cell.getCellProps(),
+    style: {
+      padding: densePadding ? '0.5rem' : '1rem',
+      transition: 'all 0.2s ease-in-out',
+      ...cell.getCellProps().style,
+      ...(mTableCellBodyProps?.style ?? {}),
+    },
+  };
 
   return (
     <TableCell
       onClick={(event: MouseEvent<HTMLTableCellElement>) =>
         onCellClick?.(event, cell)
       }
-      variant="body"
-      {...cell.getCellProps()}
+      {...tableCellProps}
     >
       {cell.isPlaceholder ? null : cell.isAggregated ? (
         cell.render('Aggregated')

package/src/body/MRT_TableBodyRow.tsx

@@ -1,12 +1,12 @@
 import React, { FC, MouseEvent } from 'react';
-import { TableRow } from '@mui/material';
+import { alpha, TableCell, TableRow, useTheme } from '@mui/material';
 import { Row } from 'react-table';
 import { MRT_TableBodyCell } from './MRT_TableBodyCell';
 import { useMaterialReactTable } from '../useMaterialReactTable';
 import { MRT_TableDetailPanel } from './MRT_TableDetailPanel';
 import { MRT_ExpandButton } from '../buttons/MRT_ExpandButton';
 import { MRT_SelectCheckbox } from '../inputs/MRT_SelectCheckbox';
-import { MRT_TableSpacerCell } from '../table/MRT_TableSpacerCell';
+import { MRT_ToggleRowActionMenuButton } from '../buttons/MRT_ToggleRowActionMenuButton';
 
 interface Props {
   row: Row;
@@ -14,43 +14,59 @@ interface Props {
 
 export const MRT_TableBodyRow: FC<Props> = ({ row }) => {
   const {
-    overrideTableBodyRowComponent,
     anyRowsCanExpand,
+    enableRowActions,
     enableSelection,
-    enableSubRowTree,
-    enableColumnHiding,
+    muiTableBodyRowProps,
     onRowClick,
+    positionActionsColumn,
     renderDetailPanel,
-    tableInstance,
   } = useMaterialReactTable();
+  const theme = useTheme();
 
-  if (overrideTableBodyRowComponent) {
-    return <>{overrideTableBodyRowComponent(row, tableInstance)}</>;
-  }
+  const mTableBodyRowProps =
+    muiTableBodyRowProps instanceof Function
+      ? muiTableBodyRowProps(row)
+      : muiTableBodyRowProps;
+
+  const tableRowProps = {
+    ...mTableBodyRowProps,
+    ...row.getRowProps(),
+    style: {
+      backgroundColor: row.isSelected
+        ? alpha(theme.palette.primary.light, 0.1)
+        : 'transparent',
+      ...row.getRowProps().style,
+      ...(mTableBodyRowProps?.style ?? {}),
+    },
+  };
 
   return (
     <>
       <TableRow
+        hover
         onClick={(event: MouseEvent<HTMLTableRowElement>) =>
           onRowClick?.(event, row)
         }
-        {...row.getRowProps()}
+        {...tableRowProps}
       >
-        {((enableSubRowTree && anyRowsCanExpand) || renderDetailPanel) &&
-          (row.canExpand || renderDetailPanel ? (
-            <MRT_ExpandButton row={row} />
-          ) : (
-            <MRT_TableSpacerCell
-              width={`${
-                renderDetailPanel ? 2 : tableInstance.expandedDepth + 0.5
-              }rem`}
-            />
-          ))}
+        {enableRowActions && positionActionsColumn === 'first' && (
+          <TableCell>
+            <MRT_ToggleRowActionMenuButton row={row} />
+          </TableCell>
+        )}
+        {(anyRowsCanExpand || renderDetailPanel) && (
+          <MRT_ExpandButton row={row} />
+        )}
         {enableSelection && <MRT_SelectCheckbox row={row} />}
-        {row.cells.map((cell, index) => (
-          <MRT_TableBodyCell key={`${index}-${cell.value}`} cell={cell} />
+        {row.cells.map((cell) => (
+          <MRT_TableBodyCell key={cell.getCellProps().key} cell={cell} />
         ))}
-        {enableColumnHiding && <MRT_TableSpacerCell />}
+        {enableRowActions && positionActionsColumn === 'last' && (
+          <TableCell>
+            <MRT_ToggleRowActionMenuButton row={row} />
+          </TableCell>
+        )}
       </TableRow>
       {renderDetailPanel && <MRT_TableDetailPanel row={row} />}
     </>