@etsoo/materialui 1.5.70 → 1.5.72

package/src/DataGridEx.tsx

@@ -11,7 +11,6 @@ import {
   GridLoaderStates,
   ScrollerGrid,
   ScrollerGridForwardRef,
-  ScrollerGridItemRendererProps,
   ScrollerGridProps,
   useCombinedRefs
 } from "@etsoo/react";
@@ -24,6 +23,8 @@ import Box, { BoxProps } from "@mui/material/Box";
 import TableSortLabel from "@mui/material/TableSortLabel";
 import Checkbox from "@mui/material/Checkbox";
 import Paper from "@mui/material/Paper";
+import { GridUtils } from "./GridUtils";
+import { useGridCacheInitLoad } from "./uses/useGridCacheInitLoad";
 
 /**
  * Footer item renderer props
@@ -44,7 +45,13 @@ export type DataGridExProps<
   P extends GridJsonData = GridLoadDataProps
 > = Omit<
   ScrollerGridProps<T, P>,
-  "itemRenderer" | "columnCount" | "columnWidth" | "width"
+  | "cellComponent"
+  | "columnCount"
+  | "columnWidth"
+  | "onClick"
+  | "onDoubleClick"
+  | "onInitLoad"
+  | "width"
 > & {
   /**
    * Alternating colors for odd/even rows
@@ -117,6 +124,14 @@ export type DataGridExProps<
    */
   onClick?: MouseEventWithDataHandler<T>;
 
+  /**
+   * Data change handler
+   * @param rows Rows
+   * @param rowIndex Row index
+   * @param columnIndex Column index
+   */
+  onDataChange?: (rows: T[], rowIndex: number, columnIndex: number) => void;
+
   /**
    * Selectable to support hover over and out effect and row clickable
    * @default true
@@ -355,6 +370,8 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
     alternatingColors = [theme.palette.grey[100], undefined],
     borderRowsCount,
     bottomHeight = 53,
+    cacheKey,
+    cacheMinutes = 15,
     checkable = false,
     className,
     columns,
@@ -369,7 +386,9 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
     idField = "id" as DataTypes.Keys<T>,
     mRef = React.createRef(),
     onClick,
+    onDataChange,
     onDoubleClick,
+    onUpdateRows,
     selectable = true,
     selectedColor = "#edf4fb",
     width,
@@ -433,6 +452,9 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
     }
   }
 
+  // Init handler
+  const initHandler = useGridCacheInitLoad<T>(cacheKey, cacheMinutes);
+
   const refs = React.useRef<{ ref?: ScrollerGridForwardRef<T> }>({});
 
   const mRefLocal = useCombinedRefs(mRef, (ref: ScrollerGridForwardRef<T>) => {
@@ -501,107 +523,6 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
     });
   };
 
-  /**
-   * Item renderer
-   */
-  const itemRenderer = ({
-    columnIndex,
-    rowIndex,
-    style,
-    data,
-    selectedItems,
-    setItems
-  }: ScrollerGridItemRendererProps<T>) => {
-    // Column
-    const {
-      align,
-      cellRenderer = DataGridRenderers.defaultCellRenderer,
-      cellBoxStyle,
-      field,
-      type,
-      valueFormatter,
-      renderProps
-    } = columns[columnIndex];
-
-    // Props
-    const formatProps: GridCellFormatterProps<T> = {
-      data,
-      field,
-      rowIndex,
-      columnIndex
-    };
-
-    let rowClass = `DataGridEx-Cell${rowIndex % 2}`;
-    if (
-      borderRowsCount != null &&
-      borderRowsCount > 0 &&
-      (rowIndex + 1) % borderRowsCount === 0
-    ) {
-      rowClass += ` DataGridEx-Cell-Border`;
-    }
-
-    // Selected
-    const selected =
-      data != null &&
-      (selectedRowIndex.current === rowIndex ||
-        selectedItems.some(
-          (selectedItem) =>
-            selectedItem != null && selectedItem[idField] === data[idField]
-        ));
-
-    if (selected) {
-      rowClass += ` DataGridEx-Selected`;
-    }
-
-    // Box style
-    const boxStyle =
-      data == null || cellBoxStyle == null
-        ? undefined
-        : typeof cellBoxStyle === "function"
-        ? cellBoxStyle(data)
-        : cellBoxStyle;
-
-    const cellProps: BoxProps = {
-      className: "DataGridEx-Cell",
-      textAlign: GridAlignGet(align, type),
-      sx: { ...boxStyle }
-    };
-
-    const child = cellRenderer({
-      data,
-      field,
-      formattedValue: valueFormatter ? valueFormatter(formatProps) : undefined,
-      selected,
-      type,
-      rowIndex,
-      columnIndex,
-      cellProps,
-      renderProps:
-        typeof renderProps === "function" ? renderProps(data) : renderProps,
-      setItems
-    });
-
-    return (
-      <div
-        className={rowClass}
-        style={style}
-        data-row={rowIndex}
-        data-column={columnIndex}
-        onMouseDown={selectable && !checkable ? handleMouseDown : undefined}
-        onMouseOver={selectable ? handleMouseOver : undefined}
-        onMouseOut={selectable ? handleMouseOut : undefined}
-        onClick={(event) => onClick && data != null && onClick(event, data)}
-        onDoubleClick={(event) =>
-          onDoubleClick && data != null && onDoubleClick(event, data)
-        }
-      >
-        <Box {...cellProps} onMouseEnter={handleMouseEnter}>
-          {child}
-        </Box>
-      </div>
-    );
-  };
-
   // Column width calculator
   const widthCalculator = React.useMemo(
     () => DataGridExCalColumns(columns),
@@ -630,6 +551,14 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
     [columns, width]
   );
 
+  const onUpdateRowsHandler = React.useCallback(
+    (rows: T[], state: GridLoaderStates<T>) => {
+      GridUtils.getUpdateRowsHandler<T>(cacheKey)?.(rows, state);
+      onUpdateRows?.(rows, state);
+    },
+    [onUpdateRows, cacheKey]
+  );
+
   // Table
   const table = React.useMemo(() => {
     return (
@@ -640,18 +569,132 @@ export function DataGridEx<T extends object>(props: DataGridExProps<T>) {
           className,
           createGridStyle(alternatingColors, selectedColor, hoverColor)
         )}
+        onCellsRendered={
+          cacheKey
+            ? (visibleCells) =>
+                sessionStorage.setItem(
+                  `${cacheKey}-scroll`,
+                  JSON.stringify(visibleCells)
+                )
+            : undefined
+        }
+        onInitLoad={initHandler}
+        onUpdateRows={onUpdateRowsHandler}
+        cellComponent={({ rowIndex, columnIndex, style, rows, states }) => {
+          // Column
+          const {
+            align,
+            cellRenderer = DataGridRenderers.defaultCellRenderer,
+            cellBoxStyle,
+            field,
+            type,
+            valueFormatter,
+            renderProps
+          } = columns[columnIndex];
+
+          // Data
+          const data = rows[rowIndex];
+
+          // Props
+          const formatProps: GridCellFormatterProps<T> = {
+            data,
+            field,
+            rowIndex,
+            columnIndex
+          };
+
+          let rowClass = `DataGridEx-Cell${rowIndex % 2}`;
+          if (
+            borderRowsCount != null &&
+            borderRowsCount > 0 &&
+            (rowIndex + 1) % borderRowsCount === 0
+          ) {
+            rowClass += ` DataGridEx-Cell-Border`;
+          }
+
+          // Selected
+          const selected =
+            data != null &&
+            (selectedRowIndex.current === rowIndex ||
+              states.selectedItems.some(
+                (selectedItem) =>
+                  selectedItem != null &&
+                  selectedItem[idField] === data[idField]
+              ));
+
+          if (selected) {
+            rowClass += ` DataGridEx-Selected`;
+          }
+
+          // Box style
+          const boxStyle =
+            data == null || cellBoxStyle == null
+              ? undefined
+              : typeof cellBoxStyle === "function"
+              ? cellBoxStyle(data)
+              : cellBoxStyle;
+
+          const cellProps: BoxProps = {
+            className: "DataGridEx-Cell",
+            textAlign: GridAlignGet(align, type),
+            sx: { ...boxStyle }
+          };
+
+          const child = cellRenderer({
+            data,
+            field,
+            formattedValue: valueFormatter
+              ? valueFormatter(formatProps)
+              : undefined,
+            selected,
+            type,
+            rowIndex,
+            columnIndex,
+            cellProps,
+            renderProps:
+              typeof renderProps === "function"
+                ? renderProps(data)
+                : renderProps,
+            triggerChange: () => onDataChange?.(rows, rowIndex, columnIndex)
+          });
+
+          return (
+            <div
+              className={rowClass}
+              style={style}
+              data-row={rowIndex}
+              data-column={columnIndex}
+              onMouseDown={
+                selectable && !checkable ? handleMouseDown : undefined
+              }
+              onMouseOver={selectable ? handleMouseOver : undefined}
+              onMouseOut={selectable ? handleMouseOut : undefined}
+              onClick={(event) =>
+                onClick && data != null && onClick(event, data)
+              }
+              onDoubleClick={(event) =>
+                onDoubleClick && data != null && onDoubleClick(event, data)
+              }
+            >
+              <Box {...cellProps} onMouseEnter={handleMouseEnter}>
+                {child}
+              </Box>
+            </div>
+          );
+        }}
         columnCount={columns.length}
         columnWidth={columnWidth}
         defaultOrderBy={defaultOrderBy}
         height={
-          height -
-          headerHeight -
-          (hideFooter ? 0 : bottomHeight + 1) -
-          scrollbarSize
+          typeof height === "number"
+            ? height -
+              headerHeight -
+              (hideFooter ? 0 : bottomHeight + 1) -
+              scrollbarSize
+            : height
         }
         headerRenderer={headerRenderer}
         idField={idField}
-        itemRenderer={itemRenderer}
         footerRenderer={hideFooter ? undefined : footerRenderer}
         width={Math.max(width ?? 0, widthCalculator.total)}
         mRef={mRefLocal}

package/src/DataGridRenderers.tsx

@@ -23,7 +23,8 @@ export namespace DataGridRenderers {
     formattedValue,
     columnIndex,
     type,
-    renderProps
+    renderProps,
+    triggerChange
   }: GridCellRendererProps<T>): React.ReactNode {
     // Is loading
     if (data == null) {

package/src/DnDList.tsx

@@ -412,7 +412,7 @@ export function DnDList<
       );
   };
 
-  const divRef = React.useRef<HTMLDivElement>();
+  const divRef = React.useRef<HTMLDivElement>(null);
 
   if (dnd == null) {
     return <Skeleton variant="rectangular" width="100%" height={height} />;

package/src/MUUtils.ts

@@ -1,5 +1,3 @@
-import { QueryRQ } from "@etsoo/appscript";
-import { IdType } from "@etsoo/shared";
 import { GridApiCommunity } from "@mui/x-data-grid/internals";
 
 /**
@@ -33,35 +31,4 @@ export namespace MUUtils {
     }
     return items;
   }
-
-  /**
-   * Setup paging keysets
-   * @param data Paging data
-   * @param lastItem Last item of the query
-   * @param idField Id field
-   */
-  export function setupPagingKeysets<T, K extends IdType = number>(
-    data: QueryRQ<K>,
-    lastItem: T | undefined,
-    idField: keyof T & string
-  ) {
-    // If the id field is not set for ordering, add it with descending
-    if (typeof data.queryPaging === "object") {
-      const orderBy = (data.queryPaging.orderBy ??= []);
-      const idUpper = idField.toUpperCase();
-      if (!orderBy.find((o) => o.field.toUpperCase() === idUpper)) {
-        orderBy.push({ field: idField, desc: true, unique: true });
-      }
-
-      // Set the paging keysets
-      if (lastItem) {
-        const keysets = orderBy.map((o) => Reflect.get(lastItem, o.field));
-        data.queryPaging.keysets = keysets;
-      } else {
-        data.queryPaging.keysets = undefined;
-      }
-    }
-
-    return data;
-  }
 }

package/src/MobileListItemRenderer.tsx

@@ -1,11 +1,11 @@
 import { ListItemReact } from "@etsoo/react";
 import React from "react";
 import { MoreFab } from "./MoreFab";
-import { ScrollerListExInnerItemRendererProps } from "./ScrollerListEx";
 import LinearProgress from "@mui/material/LinearProgress";
 import Card from "@mui/material/Card";
 import CardHeader from "@mui/material/CardHeader";
 import CardContent from "@mui/material/CardContent";
+import { ScrollerListExItemRendererProps } from "./ScrollerListEx";
 
 /**
  * Default mobile list item renderer
@@ -15,7 +15,7 @@ import CardContent from "@mui/material/CardContent";
  * @returns Component
  */
 export function MobileListItemRenderer<T>(
-  { data, itemHeight, margins }: ScrollerListExInnerItemRendererProps<T>,
+  { data, itemHeight, margins }: ScrollerListExItemRendererProps<T>,
   renderer: (
     data: T
   ) => [

package/src/ResponsibleContainer.tsx

@@ -1,19 +1,11 @@
 import React from "react";
-import {
-  GridOnScrollProps,
-  ListChildComponentProps,
-  ListOnScrollProps,
-  VariableSizeGrid
-} from "react-window";
 import {
   GridColumn,
   GridJsonData,
   GridLoadDataProps,
-  GridLoaderStates,
   GridMethodRef,
   GridTemplateType,
   ReactUtils,
-  ScrollerListRef,
   useCombinedRefs,
   useDimensions,
   useSearchParamsWithCache
@@ -23,8 +15,8 @@ import { MUGlobal } from "./MUGlobal";
 import { PullToRefreshUI } from "./PullToRefreshUI";
 import {
   ScrollerListEx,
-  ScrollerListExInnerItemRendererProps,
-  ScrollerListExItemSize
+  ScrollerListExItemSize,
+  ScrollerListExProps
 } from "./ScrollerListEx";
 import { SearchBar } from "./SearchBar";
 import { Labels } from "./app/Labels";
@@ -94,17 +86,10 @@ export type ResponsibleContainerProps<T extends object, F> = Omit<
    */
   height?: number;
 
-  /**
-   * Inner item renderer
-   */
-  innerItemRenderer: (
-    props: ScrollerListExInnerItemRendererProps<T>
-  ) => React.ReactNode;
-
   /**
    * Item renderer
    */
-  itemRenderer?: (props: ListChildComponentProps<T>) => React.ReactElement;
+  itemRenderer?: ScrollerListExProps<T>["itemRenderer"];
 
   /**
    * Item size, a function indicates its a variable size list
@@ -228,6 +213,8 @@ export function ResponsibleContainer<T extends object, F>(
   const mRefs = useCombinedRefs(mRef, (ref: GridMethodRef<T>) => {
     if (ref == null) return;
     state.ref = ref;
+
+    if (ref.element && elementReady) elementReady(ref.element, true);
   });
 
   // Screen size detection
@@ -289,57 +276,6 @@ export function ResponsibleContainer<T extends object, F>(
     }
   );
 
-  const onInitLoad = (
-    ref: VariableSizeGrid<T> | ScrollerListRef
-  ): [T[], Partial<GridLoaderStates<T>>?] | null | undefined => {
-    // Avoid repeatedly load from cache
-    if (refs.current.initLoaded || !cacheKey) return undefined;
-
-    // Cache data
-    const cacheData = GridUtils.getCacheData<T>(cacheKey, cacheMinutes);
-    if (cacheData) {
-      const { rows, state } = cacheData;
-
-      GridUtils.mergeSearchData(state, searchData);
-
-      // Scroll position
-      const scrollData = sessionStorage.getItem(`${cacheKey}-scroll`);
-      if (scrollData) {
-        if ("resetAfterColumnIndex" in ref) {
-          const { scrollLeft, scrollTop } = JSON.parse(
-            scrollData
-          ) as GridOnScrollProps;
-
-          globalThis.setTimeout(
-            () => ref.scrollTo({ scrollLeft, scrollTop }),
-            0
-          );
-        } else {
-          const { scrollOffset } = JSON.parse(scrollData) as ListOnScrollProps;
-
-          globalThis.setTimeout(() => ref.scrollTo(scrollOffset), 0);
-        }
-      }
-
-      // Update flag value
-      refs.current.initLoaded = true;
-
-      // Return cached rows and state
-      return [rows, state];
-    }
-
-    return undefined;
-  };
-
-  const onListScroll = (props: ListOnScrollProps) => {
-    if (!cacheKey || !refs.current.initLoaded) return;
-    sessionStorage.setItem(`${cacheKey}-scroll`, JSON.stringify(props));
-  };
-  const onGridScroll = (props: GridOnScrollProps) => {
-    if (!cacheKey || !refs.current.initLoaded) return;
-    sessionStorage.setItem(`${cacheKey}-scroll`, JSON.stringify(props));
-  };
-
   // Rect
   const rect = dimensions[0][2];
 
@@ -372,8 +308,8 @@ export function ResponsibleContainer<T extends object, F>(
       heightLocal = adjustFabHeight(heightLocal, showDataGrid);
 
     if (showDataGrid) {
-      // Delete
-      delete rest.itemRenderer;
+      // Remove useless props
+      const { itemRenderer, ...gridProps } = rest;
 
       return (
         <Box className="DataGridBox">
@@ -384,28 +320,25 @@ export function ResponsibleContainer<T extends object, F>(
             loadData={localLoadData}
             mRef={mRefs}
             onDoubleClick={(_, data) => quickAction && quickAction(data)}
-            outerRef={(element?: HTMLDivElement) => {
-              if (element != null && elementReady) elementReady(element, true);
-            }}
-            onScroll={onGridScroll}
             columns={columns}
-            onUpdateRows={GridUtils.getUpdateRowsHandler<T>(cacheKey)}
-            onInitLoad={onInitLoad}
-            {...rest}
+            {...gridProps}
           />
         </Box>
       );
     }
 
-    // Delete
-    delete rest.checkable;
-    delete rest.borderRowsCount;
-    delete rest.bottomHeight;
-    delete rest.footerItemRenderer;
-    delete rest.headerHeight;
-    delete rest.hideFooter;
-    delete rest.hoverColor;
-    delete rest.selectable;
+    // Remove useless props
+    const {
+      checkable,
+      borderRowsCount,
+      bottomHeight,
+      footerItemRenderer,
+      headerHeight,
+      hideFooter,
+      hoverColor,
+      selectable,
+      ...listProps
+    } = rest;
 
     return (
       <Box className="ListBox" sx={{ height: heightLocal }}>
@@ -413,17 +346,11 @@ export function ResponsibleContainer<T extends object, F>(
           autoLoad={!hasFields}
           height={heightLocal}
           loadData={localLoadData}
-          onUpdateRows={GridUtils.getUpdateRowsHandler<T>(cacheKey)}
-          onInitLoad={onInitLoad}
           mRef={mRefs}
           onClick={(event, data) =>
             quickAction && ReactUtils.isSafeClick(event) && quickAction(data)
           }
-          oRef={(element) => {
-            if (element != null && elementReady) elementReady(element, false);
-          }}
-          onScroll={onListScroll}
-          {...rest}
+          {...listProps}
         />
       </Box>
     );