material-react-table 0.1.0 → 0.3.2

package/package.json

@@ -1,8 +1,8 @@
 {
-  "version": "0.1.0",
+  "version": "0.3.2",
   "license": "MIT",
   "name": "material-react-table",
-  "description": "A fully featured Material-UI implementation of react-table, inspired by material-table, written from the ground up in TypeScript.",
+  "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.",
   "author": "Kevin Vandy",
   "keywords": [
     "react-table",
@@ -13,7 +13,7 @@
     "type": "git",
     "url": "https://github.com/KevinVandy/material-react-table"
   },
-  "homepage": "https://github.com/KevinVandy/material-react-table#readme",
+  "homepage": "https://www.material-react-table.com/",
   "bugs": {
     "url": "https://github.com/KevinVandy/material-react-table/issues"
   },
@@ -24,18 +24,19 @@
     "src"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=12"
   },
   "scripts": {
     "start": "tsdx watch",
-    "build": "tsdx build",
+    "build": "tsdx build && size-limit",
     "test": "tsdx test --passWithNoTests",
     "lint": "tsdx lint",
     "prepare": "tsdx build",
     "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,21 +55,25 @@
     }
   ],
   "devDependencies": {
-    "@babel/core": "^7.16.7",
+    "@babel/core": "^7.17.0",
     "@emotion/react": "^11.7.1",
     "@emotion/styled": "^11.6.0",
-    "@faker-js/faker": "^6.0.0-alpha.2",
-    "@mui/icons-material": "^5.2.5",
-    "@mui/material": "^5.2.8",
+    "@etchteam/storybook-addon-status": "^4.2.0",
+    "@faker-js/faker": "^6.0.0-alpha.5",
+    "@mui/icons-material": "^5.3.1",
+    "@mui/material": "^5.4.0",
     "@size-limit/preset-small-lib": "^7.0.5",
-    "@storybook/addon-a11y": "^6.4.13",
-    "@storybook/addon-essentials": "^6.4.13",
+    "@storybook/addon-a11y": "^6.4.18",
+    "@storybook/addon-actions": "^6.4.18",
+    "@storybook/addon-console": "^1.2.3",
+    "@storybook/addon-essentials": "^6.4.18",
     "@storybook/addon-info": "^5.3.21",
-    "@storybook/addon-links": "^6.4.13",
-    "@storybook/addons": "^6.4.13",
-    "@storybook/react": "^6.4.13",
-    "@types/faker": "^5.5.9",
-    "@types/react": "^17.0.38",
+    "@storybook/addon-links": "^6.4.18",
+    "@storybook/addon-storysource": "^6.4.18",
+    "@storybook/addons": "^6.4.18",
+    "@storybook/react": "^6.4.18",
+    "@types/faker": "^6.6.8",
+    "@types/react": "^17.0.39",
     "@types/react-dom": "^17.0.11",
     "@types/react-table": "^7.7.9",
     "babel-loader": "^8.2.3",
@@ -79,17 +84,17 @@
     "react-is": "^17.0.2",
     "react-table": "^7.7.0",
     "size-limit": "^7.0.5",
-    "storybook-addon-material-ui": "^0.9.0-alpha.24",
+    "storybook-addon-performance": "^0.16.1",
+    "storybook-dark-mode": "^1.0.8",
     "tsdx": "^0.14.1",
     "tslib": "^2.3.1",
-    "typescript": "^4.5.4"
+    "typescript": "^4.5.5"
   },
   "peerDependencies": {
     "@emotion/react": ">=11",
-    "@emotion/styled": ">=11",
     "@mui/icons-material": ">=5",
     "@mui/material": ">=5",
-    "react": ">=17",
+    "react": ">=16.8",
     "react-table": ">=7"
   }
 }

package/src/@types/faker.d.ts

@@ -0,0 +1,4 @@
+declare module '@faker-js/faker' {
+  import faker from 'faker';
+  export default faker;
+}

package/src/@types/react-table-config.d.ts

@@ -0,0 +1,153 @@
+import { TableCellProps, TextFieldProps } from '@mui/material';
+import { ReactNode } from 'react';
+import {
+  UseColumnOrderInstanceProps,
+  UseColumnOrderState,
+  UseExpandedHooks,
+  UseExpandedInstanceProps,
+  UseExpandedOptions,
+  UseExpandedRowProps,
+  UseExpandedState,
+  UseFiltersColumnOptions,
+  UseFiltersColumnProps,
+  UseFiltersInstanceProps,
+  UseFiltersOptions,
+  UseFiltersState,
+  UseGlobalFiltersColumnOptions,
+  UseGlobalFiltersInstanceProps,
+  UseGlobalFiltersOptions,
+  UseGlobalFiltersState,
+  UseGroupByCellProps,
+  UseGroupByColumnOptions,
+  UseGroupByColumnProps,
+  UseGroupByHooks,
+  UseGroupByInstanceProps,
+  UseGroupByOptions,
+  UseGroupByRowProps,
+  UseGroupByState,
+  UsePaginationInstanceProps,
+  UsePaginationOptions,
+  UsePaginationState,
+  UseResizeColumnsColumnOptions,
+  UseResizeColumnsColumnProps,
+  UseResizeColumnsOptions,
+  UseResizeColumnsState,
+  UseRowSelectHooks,
+  UseRowSelectInstanceProps,
+  UseRowSelectOptions,
+  UseRowSelectRowProps,
+  UseRowSelectState,
+  UseRowStateCellProps,
+  UseRowStateInstanceProps,
+  UseRowStateOptions,
+  UseRowStateRowProps,
+  UseRowStateState,
+  UseSortByColumnOptions,
+  UseSortByColumnProps,
+  UseSortByHooks,
+  UseSortByInstanceProps,
+  UseSortByOptions,
+  UseSortByState,
+} from 'react-table';
+
+declare module 'react-table' {
+  export interface TableOptions<D extends Record<string, unknown>>
+    extends UseExpandedOptions<D>,
+      UseFiltersOptions<D>,
+      UseGlobalFiltersOptions<D>,
+      UseGroupByOptions<D>,
+      UsePaginationOptions<D>,
+      UseResizeColumnsOptions<D>,
+      UseRowSelectOptions<D>,
+      UseRowStateOptions<D>,
+      UseSortByOptions<D>,
+      Record<string, any> {}
+
+  export interface Hooks<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseExpandedHooks<D>,
+      UseGroupByHooks<D>,
+      UseRowSelectHooks<D>,
+      UseSortByHooks<D> {}
+
+  export interface TableInstance<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseColumnOrderInstanceProps<D>,
+      UseExpandedInstanceProps<D>,
+      UseFiltersInstanceProps<D>,
+      UseGlobalFiltersInstanceProps<D>,
+      UseGroupByInstanceProps<D>,
+      UsePaginationInstanceProps<D>,
+      UseRowSelectInstanceProps<D>,
+      UseRowStateInstanceProps<D>,
+      UseSortByInstanceProps<D> {}
+
+  export interface TableState<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseColumnOrderState<D>,
+      UseExpandedState<D>,
+      UseFiltersState<D>,
+      UseGlobalFiltersState<D>,
+      UseGroupByState<D>,
+      UsePaginationState<D>,
+      UseResizeColumnsState<D>,
+      UseRowSelectState<D>,
+      UseRowStateState<D>,
+      UseSortByState<D> {}
+
+  export interface ColumnInterface<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseFiltersColumnOptions<D>,
+      UseGlobalFiltersColumnOptions<D>,
+      UseGroupByColumnOptions<D>,
+      UseResizeColumnsColumnOptions<D>,
+      UseSortByColumnOptions<D> {
+    disableFilters?: boolean;
+    Filter?: ({ column }: { column: HeaderGroup<D> }) => ReactNode;
+    editable?: boolean;
+    Edit?: ({
+      cell,
+      onChange,
+    }: {
+      cell: Cell<D>;
+      onChange: (event: ChangeEvent<HTMLInputElement>) => void;
+    }) => ReactNode;
+    muiTableBodyCellProps?:
+      | TableCellProps
+      | ((cell?: Cell<D>) => TableCellProps);
+    muiTableHeadCellProps?:
+      | TableCellProps
+      | ((column: Column<D>) => TableCellProps);
+    muiTableFooterCellProps?:
+      | TableCellProps
+      | ((column: Column<D>) => TableCellProps);
+    muiTableBodyCellEditTextFieldProps?:
+      | TextFieldProps
+      | ((cell?: Cell<D>) => TextFieldProps);
+    muiTableHeadCellFilterTextFieldProps?:
+      | TextFieldProps
+      | ((column: Column<D>) => TextFieldProps);
+  }
+
+  export interface ColumnInstance<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseFiltersColumnProps<D>,
+      UseGroupByColumnProps<D>,
+      UseResizeColumnsColumnProps<D>,
+      UseSortByColumnProps<D> {}
+
+  export interface Cell<
+    D extends Record<string, unknown> = Record<string, unknown>,
+    V = any,
+  > extends UseGroupByCellProps<D>,
+      UseRowStateCellProps<D> {}
+
+  export interface Row<
+    D extends Record<string, unknown> = Record<string, unknown>,
+  > extends UseExpandedRowProps<D>,
+      UseGroupByRowProps<D>,
+      UseRowSelectRowProps<D>,
+      UseRowStateRowProps<D> {}
+}
+
+export module 'react-table';

package/src/MaterialReactTable.tsx

@@ -1,48 +1,162 @@
-import React, { FC } from 'react';
+import React, { ChangeEvent, MouseEvent, ReactNode } from 'react';
 import {
+  TableBodyProps,
+  TableCellProps,
   TableContainerProps,
   TableFooterProps,
   TableHeadProps,
   TablePaginationProps,
   TableProps,
+  TableRowProps,
+  TextFieldProps,
+  ToolbarProps,
+  TypographyProps,
 } from '@mui/material';
-import { Column } from 'react-table';
+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 './MRT_TableContainer';
-import { defaultOptions } from './defaults';
-
-export interface MaterialReactTableOptions {
-  enableFilters: boolean;
-  enablePagination: boolean | 'top' | 'bottom' | 'both' | 'none';
-  enableSearch: boolean;
-  enableSorting: boolean;
-  showFooter: boolean;
-  showHead: boolean;
-  showToolbar: boolean;
-}
-
-export interface MaterialReactTableOptionalProps {
-  options?: Partial<MaterialReactTableOptions>;
-  tableContainerProps?: TableContainerProps;
-  tableFooterProps?: TableFooterProps;
-  tableHeadProps?: TableHeadProps;
-  tablePaginationProps?: TablePaginationProps;
-  tableProps?: TableProps;
-  renderDetailPanel?: (rowData: any) => React.ReactNode;
-}
+import { MRT_TableContainer } from './table/MRT_TableContainer';
+import { defaultLocalization, MRT_Localization } from './utils/localization';
 
-export interface MaterialReactTableProps extends MaterialReactTableOptionalProps {
-  columns: Column[];
-  data: any[];
-}
+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;
+    muiTableBodyCellEditTextFieldProps?:
+      | TextFieldProps
+      | ((cell?: Cell<D>) => 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);
+    muiTableHeadCellFilterTextFieldProps?:
+      | TextFieldProps
+      | ((column: Column<D>) => TextFieldProps);
+    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';
+    renderDetailPanel?: (row: Row<D>) => ReactNode;
+    renderRowActionMenuItems?: (
+      rowData: Row<D>,
+      tableInstance: TableInstance<D>,
+      closeMenu: () => void,
+    ) => ReactNode[];
+    renderRowActions?: (
+      row: Row<D>,
+      tableInstance: TableInstance<D>,
+    ) => ReactNode;
+    title?: string | ReactNode;
+  };
 
-export const MaterialReactTable: FC<MaterialReactTableProps> = ({
-  options = defaultOptions,
+export default <D extends {}>({
+  defaultColumn = { minWidth: 50, maxWidth: 1000 },
+  localization = defaultLocalization,
+  positionActionsColumn = 'first',
+  positionPagination = 'bottom',
+  positionToolbarActions = 'top',
   ...rest
-}) => {
-  return (
-    <MaterialReactTableProvider options={options} {...rest}>
-      <MRT_TableContainer />
-    </MaterialReactTableProvider>
-  );
-};
+}: MaterialReactTableProps<D>) => (
+  <MaterialReactTableProvider
+    defaultColumn={defaultColumn}
+    localization={{ ...defaultLocalization, ...localization }}
+    positionPagination={positionPagination}
+    positionActionsColumn={positionActionsColumn}
+    positionToolbarActions={positionToolbarActions}
+    {...rest}
+  >
+    <MRT_TableContainer />
+  </MaterialReactTableProvider>
+);

package/src/body/MRT_TableBody.tsx

@@ -0,0 +1,35 @@
+import React, { FC } from 'react';
+import { styled, TableBody as MuiTableBody } from '@mui/material';
+import { MRT_TableBodyRow } from './MRT_TableBodyRow';
+import { useMaterialReactTable } from '../useMaterialReactTable';
+
+const TableBody = styled(MuiTableBody)({
+  overflowY: 'hidden',
+});
+
+interface Props {}
+
+export const MRT_TableBody: FC<Props> = () => {
+  const { tableInstance, muiTableBodyProps, manualPagination } =
+    useMaterialReactTable();
+
+  const rows = manualPagination ? tableInstance.rows : tableInstance.page;
+
+  const tableBodyProps = {
+    ...muiTableBodyProps,
+    ...tableInstance.getTableBodyProps(),
+    style: {
+      ...tableInstance.getTableBodyProps().style,
+      ...(muiTableBodyProps?.style ?? {}),
+    },
+  };
+
+  return (
+    <TableBody {...tableBodyProps}>
+      {rows.map((row) => {
+        tableInstance.prepareRow(row);
+        return <MRT_TableBodyRow key={row.getRowProps().key} row={row} />;
+      })}
+    </TableBody>
+  );
+};

package/src/body/MRT_TableBodyCell.tsx

@@ -0,0 +1,69 @@
+import React, { FC, MouseEvent } from 'react';
+import { styled, TableCell as MuiTableCell } from '@mui/material';
+import { Cell } from 'react-table';
+import { useMaterialReactTable } from '../useMaterialReactTable';
+import { MRT_EditCellTextfield } from '../inputs/MRT_EditCellTextfield';
+
+const TableCell = styled(MuiTableCell, {
+  shouldForwardProp: (prop) => prop !== 'densePadding',
+})<{ densePadding?: boolean }>(({ densePadding }) => ({
+  padding: densePadding ? '0.5rem' : '1rem',
+  transition: 'all 0.2s ease-in-out',
+}));
+
+interface Props {
+  cell: Cell;
+}
+
+export const MRT_TableBodyCell: FC<Props> = ({ cell }) => {
+  const {
+    onCellClick,
+    muiTableBodyCellProps,
+    densePadding,
+    currentEditingRow,
+  } = useMaterialReactTable();
+
+  const mTableCellBodyProps =
+    muiTableBodyCellProps instanceof Function
+      ? muiTableBodyCellProps(cell)
+      : muiTableBodyCellProps;
+
+  const mcTableCellBodyProps =
+    cell.column.muiTableBodyCellProps instanceof Function
+      ? cell.column.muiTableBodyCellProps(cell)
+      : cell.column.muiTableBodyCellProps;
+
+  const tableCellProps = {
+    ...mTableCellBodyProps,
+    ...mcTableCellBodyProps,
+    ...cell.getCellProps(),
+    style: {
+      ...cell.getCellProps().style,
+      ...(mTableCellBodyProps?.style ?? {}),
+      ...(mcTableCellBodyProps?.style ?? {}),
+    },
+  };
+
+  return (
+    <TableCell
+      densePadding={densePadding}
+      onClick={(event: MouseEvent<HTMLTableCellElement>) =>
+        onCellClick?.(event, cell)
+      }
+      {...tableCellProps}
+    >
+      {currentEditingRow?.id === cell.row.id ? (
+        <MRT_EditCellTextfield cell={cell} />
+      ) : cell.isPlaceholder ? null : cell.isAggregated ? (
+        cell.render('Aggregated')
+      ) : cell.isGrouped ? (
+        <span>
+          {cell.render('Cell')} ({cell.row.subRows.length})
+        </span>
+      ) : (
+        cell.render('Cell')
+      )}
+      {}
+    </TableCell>
+  );
+};

package/src/body/MRT_TableBodyRow.tsx

@@ -0,0 +1,84 @@
+import React, { FC, MouseEvent } from 'react';
+import {
+  alpha,
+  styled,
+  TableCell,
+  TableRow as MuiTableRow,
+} 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_ToggleRowActionMenuButton } from '../buttons/MRT_ToggleRowActionMenuButton';
+
+export const TableRow = styled(MuiTableRow, {
+  shouldForwardProp: (prop) => prop !== 'isSelected',
+})<{ isSelected?: boolean }>(({ isSelected, theme }) => ({
+  backgroundColor: isSelected
+    ? alpha(theme.palette.primary.light, 0.1)
+    : 'transparent',
+}));
+
+interface Props {
+  row: Row;
+}
+
+export const MRT_TableBodyRow: FC<Props> = ({ row }) => {
+  const {
+    anyRowsCanExpand,
+    enableRowActions,
+    enableSelection,
+    muiTableBodyRowProps,
+    onRowClick,
+    positionActionsColumn,
+    renderDetailPanel,
+  } = useMaterialReactTable();
+
+  const mTableBodyRowProps =
+    muiTableBodyRowProps instanceof Function
+      ? muiTableBodyRowProps(row)
+      : muiTableBodyRowProps;
+
+  const tableRowProps = {
+    ...mTableBodyRowProps,
+    ...row.getRowProps(),
+    style: {
+      ...row.getRowProps().style,
+      ...(mTableBodyRowProps?.style ?? {}),
+    },
+  };
+
+  return (
+    <>
+      <TableRow
+        isSelected={row.isSelected}
+        hover
+        onClick={(event: MouseEvent<HTMLTableRowElement>) =>
+          onRowClick?.(event, row)
+        }
+        {...tableRowProps}
+      >
+        {enableRowActions && positionActionsColumn === 'first' && (
+          <TableCell>
+            <MRT_ToggleRowActionMenuButton row={row} />
+          </TableCell>
+        )}
+        {(anyRowsCanExpand || renderDetailPanel) && (
+          <MRT_ExpandButton row={row} />
+        )}
+        {enableSelection && <MRT_SelectCheckbox row={row} />}
+        {row.cells.map((cell) => (
+          <MRT_TableBodyCell key={cell.getCellProps().key} cell={cell} />
+        ))}
+        {enableRowActions && positionActionsColumn === 'last' && (
+          <TableCell>
+            <MRT_ToggleRowActionMenuButton row={row} />
+          </TableCell>
+        )}
+      </TableRow>
+      {renderDetailPanel && <MRT_TableDetailPanel row={row} />}
+    </>
+  );
+};