[core] Add React 18 to peer dependencies

mui · Apr 2, 2022 · 850295a · 850295a
1 parent b4c16bd
commit 850295a
Show file tree

Hide file tree

Showing 11 changed files with 64 additions and 41 deletions.
diff --git a/docs/data/data-grid/events/events.json b/docs/data/data-grid/events/events.json
@@ -249,7 +249,7 @@
     "name": "rowsScroll",
     "description": "Fired during the scroll of the grid viewport.",
     "params": "GridScrollParams",
-    "event": "MuiEvent<{}>"
+    "event": "MuiEvent<React.UIEvent | MuiBaseEvent>"
   },
   {
     "name": "rowsScrollEnd",

diff --git a/docs/src/pages/components/data-grid/events/events.json b/docs/src/pages/components/data-grid/events/events.json
@@ -249,7 +249,7 @@
     "name": "rowsScroll",
     "description": "Fired during the scroll of the grid viewport.",
     "params": "GridScrollParams",
-    "event": "MuiEvent<{}>"
+    "event": "MuiEvent<React.UIEvent | MuiBaseEvent>"
   },
   {
     "name": "rowsScrollEnd",

diff --git a/packages/grid/x-data-grid-generator/package.json b/packages/grid/x-data-grid-generator/package.json
@@ -45,7 +45,7 @@
   "peerDependencies": {
     "@mui/icons-material": "^5.2.5",
     "@mui/material": "^5.2.8",
-    "react": "^17.0.2"
+    "react": "^17.0.2 || ^18.0.0"
   },
   "setupFiles": [
     "<rootDir>/src/setupTests.js"

diff --git a/packages/grid/x-data-grid-pro/package.json b/packages/grid/x-data-grid-pro/package.json
@@ -53,7 +53,7 @@
   "peerDependencies": {
     "@mui/material": "^5.2.8",
     "@mui/system": "^5.2.8",
-    "react": "^17.0.2"
+    "react": "^17.0.2 || ^18.0.0"
   },
   "setupFiles": [
     "<rootDir>/src/setupTests.js"

diff --git a/packages/grid/x-data-grid-pro/src/components/DataGridProColumnHeaders.tsx b/packages/grid/x-data-grid-pro/src/components/DataGridProColumnHeaders.tsx
@@ -122,27 +122,15 @@ export const DataGridProColumnHeaders = React.forwardRef<
   const pinnedColumns = useGridSelector(apiRef, gridPinnedColumnsSelector);
   const [leftPinnedColumns, rightPinnedColumns] = filterColumns(pinnedColumns, visibleColumnFields);
 
-  const {
-    isDragging,
-    renderContext,
-    updateInnerPosition,
-    getRootProps,
-    getInnerProps,
-    getColumns,
-  } = useGridColumnHeaders({
-    innerRef,
-    minColumnIndex: leftPinnedColumns.length,
-  });
+  const { isDragging, renderContext, getRootProps, getInnerProps, getColumns } =
+    useGridColumnHeaders({
+      innerRef,
+      minColumnIndex: leftPinnedColumns.length,
+    });
 
   const ownerState = { leftPinnedColumns, rightPinnedColumns, classes: rootProps.classes };
   const classes = useUtilityClasses(ownerState);
 
-  React.useEffect(() => {
-    if (renderContext) {
-      updateInnerPosition(renderContext);
-    }
-  }, [renderContext, updateInnerPosition]);
-
   const leftRenderContext =
     renderContext && leftPinnedColumns.length
       ? {

diff --git a/packages/grid/x-data-grid-pro/src/components/DataGridProVirtualScroller.tsx b/packages/grid/x-data-grid-pro/src/components/DataGridProVirtualScroller.tsx
@@ -210,10 +210,6 @@ const DataGridProVirtualScroller = React.forwardRef<
   useGridApiEventHandler(apiRef, GridEvents.columnWidthChange, refreshRenderZonePosition);
   useGridApiEventHandler(apiRef, GridEvents.columnOrderChange, refreshRenderZonePosition);
 
-  React.useEffect(() => {
-    refreshRenderZonePosition();
-  }, [refreshRenderZonePosition]);
-
   const leftRenderContext =
     renderContext && leftPinnedColumns.length > 0
       ? {

diff --git a/packages/grid/x-data-grid/package.json b/packages/grid/x-data-grid/package.json
@@ -54,7 +54,7 @@
   "peerDependencies": {
     "@mui/material": "^5.2.8",
     "@mui/system": "^5.2.8",
-    "react": "^17.0.2"
+    "react": "^17.0.2 || ^18.0.0"
   },
   "setupFiles": [
     "<rootDir>/src/setupTests.js"

diff --git a/packages/grid/x-data-grid/src/hooks/features/columnHeaders/useGridColumnHeaders.tsx b/packages/grid/x-data-grid/src/hooks/features/columnHeaders/useGridColumnHeaders.tsx
@@ -1,4 +1,5 @@
 import * as React from 'react';
+import * as ReactDOM from 'react-dom';
 import { useForkRef } from '@mui/material/utils';
 import { useGridApiContext } from '../../utils/useGridApiContext';
 import { useGridSelector } from '../../utils/useGridSelector';
@@ -26,6 +27,10 @@ interface UseGridColumnHeadersProps {
   minColumnIndex?: number;
 }
 
+function isUIEvent(event: any): event is React.UIEvent {
+  return !!event.target;
+}
+
 export const useGridColumnHeaders = (props: UseGridColumnHeadersProps) => {
   const { innerRef: innerRefProp, minColumnIndex = 0 } = props;
 
@@ -70,8 +75,14 @@ export const useGridColumnHeaders = (props: UseGridColumnHeadersProps) => {
     [columnPositions, minColumnIndex, rootProps.columnBuffer],
   );
 
+  React.useLayoutEffect(() => {
+    if (renderContext) {
+      updateInnerPosition(renderContext);
+    }
+  }, [renderContext, updateInnerPosition]);
+
   const handleScroll = React.useCallback<GridEventListener<GridEvents.rowsScroll>>(
-    ({ left, renderContext: nextRenderContext = null }) => {
+    ({ left, renderContext: nextRenderContext = null }, event) => {
       if (!innerRef.current) {
         return;
       }
@@ -87,13 +98,30 @@ export const useGridColumnHeaders = (props: UseGridColumnHeadersProps) => {
       }
       prevScrollLeft.current = left;
 
+      // We can only update the position when we guarantee that the render context has been
+      // rendered. This is achieved using ReactDOM.flushSync or when the context doesn't change.
+      let canUpdateInnerPosition = false;
+
       if (nextRenderContext !== prevRenderContext.current || !prevRenderContext.current) {
-        setRenderContext(nextRenderContext);
+        // ReactDOM.flushSync cannot be called on `scroll` events fired inside effects
+        if (isUIEvent(event)) {
+          // To prevent flickering, the inner position can only be updated after the new context has
+          // been rendered. ReactDOM.flushSync ensures that the state changes will happen before
+          // updating the position.
+          ReactDOM.flushSync(() => {
+            setRenderContext(nextRenderContext);
+          });
+          canUpdateInnerPosition = true;
+        } else {
+          setRenderContext(nextRenderContext);
+        }
         prevRenderContext.current = nextRenderContext;
+      } else {
+        canUpdateInnerPosition = true;
       }
 
       // Pass directly the render context to avoid waiting for the next render
-      if (nextRenderContext) {
+      if (nextRenderContext && canUpdateInnerPosition) {
         updateInnerPosition(nextRenderContext);
       }
     },
@@ -204,7 +232,6 @@ export const useGridColumnHeaders = (props: UseGridColumnHeadersProps) => {
     renderContext,
     getColumns,
     isDragging: !!dragCol,
-    updateInnerPosition,
     getRootProps: (other = {}) => ({ style: rootStyle, ...other }),
     getInnerProps: () => ({ ref: handleInnerRef, 'aria-rowindex': 1, role: 'row' }),
   };

diff --git a/packages/grid/x-data-grid/src/hooks/features/virtualization/useGridVirtualScroller.tsx b/packages/grid/x-data-grid/src/hooks/features/virtualization/useGridVirtualScroller.tsx
@@ -1,4 +1,5 @@
 import * as React from 'react';
+import * as ReactDOM from 'react-dom';
 import { useForkRef } from '@mui/material/utils';
 import { useGridApiContext } from '../../utils/useGridApiContext';
 import { useGridRootProps } from '../../utils/useGridRootProps';
@@ -197,13 +198,18 @@ export const useGridVirtualScroller = (props: UseGridVirtualScrollerProps) => {
     ],
   );
 
+  React.useLayoutEffect(() => {
+    if (renderContext) {
+      updateRenderZonePosition(renderContext);
+    }
+  }, [renderContext, updateRenderZonePosition]);
+
   const updateRenderContext = React.useCallback(
     (nextRenderContext) => {
       setRenderContext(nextRenderContext);
-      updateRenderZonePosition(nextRenderContext);
       prevRenderContext.current = nextRenderContext;
     },
-    [setRenderContext, prevRenderContext, updateRenderZonePosition],
+    [setRenderContext, prevRenderContext],
   );
 
   React.useEffect(() => {
@@ -212,7 +218,6 @@ export const useGridVirtualScroller = (props: UseGridVirtualScrollerProps) => {
     }
 
     const initialRenderContext = computeRenderContext();
-    prevRenderContext.current = initialRenderContext;
     updateRenderContext(initialRenderContext);
 
     const { top, left } = scrollPosition.current!;
@@ -257,14 +262,21 @@ export const useGridVirtualScroller = (props: UseGridVirtualScrollerProps) => {
       prevTotalWidth.current !== columnsTotalWidth;
 
     // TODO v6: rename event to a wider name, it's not only fired for row scrolling
-    apiRef.current.publishEvent(GridEvents.rowsScroll, {
-      top: scrollTop,
-      left: scrollLeft,
-      renderContext: shouldSetState ? nextRenderContext : prevRenderContext.current,
-    });
+    apiRef.current.publishEvent(
+      GridEvents.rowsScroll,
+      {
+        top: scrollTop,
+        left: scrollLeft,
+        renderContext: shouldSetState ? nextRenderContext : prevRenderContext.current,
+      },
+      event,
+    );
 
     if (shouldSetState) {
-      updateRenderContext(nextRenderContext);
+      // Prevents batching render context changes
+      ReactDOM.flushSync(() => {
+        updateRenderContext(nextRenderContext);
+      });
       prevTotalWidth.current = columnsTotalWidth;
     }
   };

diff --git a/packages/grid/x-data-grid/src/models/events/gridEventLookup.ts b/packages/grid/x-data-grid/src/models/events/gridEventLookup.ts
@@ -209,7 +209,7 @@ export interface GridEventLookup
   };
 
   // Scroll
-  rowsScroll: { params: GridScrollParams };
+  rowsScroll: { params: GridScrollParams; event: React.UIEvent | MuiBaseEvent };
   virtualScrollerContentSizeChange: {};
 
   // Selection

diff --git a/packages/x-license-pro/package.json b/packages/x-license-pro/package.json
@@ -39,7 +39,7 @@
     "yargs": "^17.4.0"
   },
   "peerDependencies": {
-    "react": "^17.0.2"
+    "react": "^17.0.2 || ^18.0.0"
   },
   "setupFiles": [
     "<rootDir>/src/setupTests.js"