material-react-table 0.9.1 → 0.9.2

package/dist/table/MRT_Table.d.ts

@@ -1,6 +1,7 @@
-import { FC } from 'react';
+import { FC, RefObject } from 'react';
 import { MRT_TableInstance } from '..';
 interface Props {
+    tableContainerRef: RefObject<HTMLDivElement>;
     tableInstance: MRT_TableInstance;
 }
 export declare const MRT_Table: FC<Props>;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.9.1",
+  "version": "0.9.2",
   "license": "MIT",
   "name": "material-react-table",
   "description": "A fully featured Material UI implementation of TanStack React Table, inspired by material-table and the MUI X DataGrid, written from the ground up in TypeScript.",
@@ -100,6 +100,7 @@
     "@tanstack/match-sorter-utils": "^8.0.0-alpha.83",
     "@tanstack/react-table": "^8.0.0-beta.8",
     "react-dnd": "^16.0.1",
-    "react-dnd-html5-backend": "^16.0.1"
+    "react-dnd-html5-backend": "^16.0.1",
+    "react-virtual": "^2.10.4"
   }
 }

package/src/MaterialReactTable.tsx

@@ -352,6 +352,7 @@ export type MaterialReactTableProps<D extends Record<string, any> = {}> =
     enablePersistentState?: boolean;
     enableRowActions?: boolean;
     enableRowNumbers?: boolean;
+    enableRowVirtualization?: boolean;
     enableSelectAll?: boolean;
     enableStickyHeader?: boolean;
     enableTableFooter?: boolean;

package/src/body/MRT_TableBody.tsx

@@ -1,37 +1,76 @@
-import React, { FC } from 'react';
+import React, { FC, RefObject } from 'react';
 import { TableBody } from '@mui/material';
 import { MRT_TableBodyRow } from './MRT_TableBodyRow';
-import { MRT_TableInstance } from '..';
+import { MRT_Row, MRT_TableInstance } from '..';
+import { useVirtual } from 'react-virtual';
 
 interface Props {
   tableInstance: MRT_TableInstance;
+  tableContainerRef: RefObject<HTMLDivElement>;
 }
 
-export const MRT_TableBody: FC<Props> = ({ tableInstance }) => {
+export const MRT_TableBody: FC<Props> = ({
+  tableInstance,
+  tableContainerRef,
+}) => {
   const {
     getPaginationRowModel,
     getPrePaginationRowModel,
-    options: { enablePagination, muiTableBodyProps },
+    getState,
+    options: { enablePagination, enableRowVirtualization, muiTableBodyProps },
   } = tableInstance;
 
-  const rows = enablePagination
-    ? getPaginationRowModel().rows
-    : getPrePaginationRowModel().rows;
+  const { isDensePadding } = getState();
 
   const tableBodyProps =
     muiTableBodyProps instanceof Function
       ? muiTableBodyProps({ tableInstance })
       : muiTableBodyProps;
 
+  const rows = enablePagination
+    ? getPaginationRowModel().rows
+    : getPrePaginationRowModel().rows;
+
+  const rowVirtualizer = useVirtual({
+    overscan: isDensePadding ? 15 : 5,
+    size: rows.length,
+    parentRef: tableContainerRef,
+  });
+
+  const { virtualItems: virtualRows } = rowVirtualizer;
+  const paddingTop = virtualRows.length > 0 ? virtualRows[0].start : 0;
+  const paddingBottom =
+    virtualRows.length > 0
+      ? rowVirtualizer.totalSize - virtualRows[virtualRows.length - 1].end
+      : 0;
+
   return (
     <TableBody {...tableBodyProps}>
-      {rows.map((row) => (
-        <MRT_TableBodyRow
-          key={row.id}
-          row={row}
-          tableInstance={tableInstance}
-        />
-      ))}
+      {enableRowVirtualization && paddingTop > 0 && (
+        <tr>
+          <td style={{ height: `${paddingTop}px` }} />
+        </tr>
+      )}
+      {/* @ts-ignore */}
+      {(enableRowVirtualization ? virtualRows : rows).map(
+        (rowOrVirtualRow: any) => {
+          const row = enableRowVirtualization
+            ? (rows[rowOrVirtualRow.index] as MRT_Row)
+            : (rowOrVirtualRow as MRT_Row);
+          return (
+            <MRT_TableBodyRow
+              key={row.id}
+              row={row}
+              tableInstance={tableInstance}
+            />
+          );
+        },
+      )}
+      {enableRowVirtualization && paddingBottom > 0 && (
+        <tr>
+          <td style={{ height: `${paddingBottom}px` }} />
+        </tr>
+      )}
     </TableBody>
   );
 };

package/src/table/MRT_Table.tsx

@@ -1,4 +1,4 @@
-import React, { FC } from 'react';
+import React, { FC, RefObject } from 'react';
 import { Table } from '@mui/material';
 import { MRT_TableHead } from '../head/MRT_TableHead';
 import { MRT_TableBody } from '../body/MRT_TableBody';
@@ -6,10 +6,14 @@ import { MRT_TableFooter } from '../footer/MRT_TableFooter';
 import { MRT_TableInstance } from '..';
 
 interface Props {
+  tableContainerRef: RefObject<HTMLDivElement>;
   tableInstance: MRT_TableInstance;
 }
 
-export const MRT_Table: FC<Props> = ({ tableInstance }) => {
+export const MRT_Table: FC<Props> = ({
+  tableContainerRef,
+  tableInstance
+}) => {
   const {
     options: {
       enableStickyHeader,
@@ -27,7 +31,10 @@ export const MRT_Table: FC<Props> = ({ tableInstance }) => {
   return (
     <Table stickyHeader={enableStickyHeader} {...tableProps}>
       {enableTableHead && <MRT_TableHead tableInstance={tableInstance} />}
-      <MRT_TableBody tableInstance={tableInstance} />
+      <MRT_TableBody
+        tableContainerRef={tableContainerRef}
+        tableInstance={tableInstance}
+      />
       {enableTableFooter && <MRT_TableFooter tableInstance={tableInstance} />}
     </Table>
   );

package/src/table/MRT_TableContainer.tsx

@@ -13,7 +13,7 @@ interface Props {
 export const MRT_TableContainer: FC<Props> = ({ tableInstance }) => {
   const {
     getState,
-    options: { enableStickyHeader, tableId, muiTableContainerProps },
+    options: { enableStickyHeader, muiTableContainerProps, tableId },
   } = tableInstance;
 
   const { isFullScreen } = getState();
@@ -41,9 +41,12 @@ export const MRT_TableContainer: FC<Props> = ({ tableInstance }) => {
     setTotalToolbarHeight(topToolbarHeight + bottomToolbarHeight);
   });
 
+  const tableContainerRef = React.useRef<HTMLDivElement>(null);
+
   return (
     <TableContainer
       {...tableContainerProps}
+      ref={tableContainerRef}
       sx={{
         maxWidth: '100%',
         maxHeight: enableStickyHeader
@@ -58,7 +61,10 @@ export const MRT_TableContainer: FC<Props> = ({ tableInstance }) => {
           : undefined,
       }}
     >
-      <MRT_Table tableInstance={tableInstance} />
+      <MRT_Table
+        tableContainerRef={tableContainerRef}
+        tableInstance={tableInstance}
+      />
     </TableContainer>
   );
 };