react-resizable-panels 0.0.60 → 0.0.61

package/dist/react-resizable-panels.node.cjs.js

@@ -632,6 +632,7 @@ function getResizeHandlePanelIds(groupId, handleId, panelsArray) {
 
 function useWindowSplitterPanelGroupBehavior({
   committedValuesRef,
+  eagerValuesRef,
   groupId,
   layout,
   panelDataArray,
@@ -643,7 +644,7 @@ function useWindowSplitterPanelGroupBehavior({
   useEffect(() => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const groupElement = getPanelGroupElement(groupId);
     assert(groupElement != null, `No group found for id "${groupId}"`);
     const handles = getResizeHandleElementsForGroup(groupId);
@@ -701,7 +702,7 @@ function useWindowSplitterPanelGroupBehavior({
     return () => {
       cleanupFunctions.forEach(cleanupFunction => cleanupFunction());
     };
-  }, [committedValuesRef, groupId, layout, panelDataArray, setLayout]);
+  }, [committedValuesRef, eagerValuesRef, groupId, layout, panelDataArray, setLayout]);
 }
 
 function areEqual(arrayA, arrayB) {
@@ -1166,11 +1167,13 @@ function PanelGroupWithForwardedRef({
     id: groupId,
     keyboardResizeByPercentage,
     keyboardResizeByPixels,
-    layout,
     onLayout,
-    panelDataArray: [],
     storage
   });
+  const eagerValuesRef = useRef({
+    layout,
+    panelDataArray: []
+  });
   useRef({
     didLogIdAndOrderWarning: false,
     didLogPanelConstraintsWarning: false,
@@ -1180,9 +1183,11 @@ function PanelGroupWithForwardedRef({
     getId: () => committedValuesRef.current.id,
     getLayout: () => {
       const {
-        id: groupId,
-        layout
+        id: groupId
       } = committedValuesRef.current;
+      const {
+        layout
+      } = eagerValuesRef.current;
       const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
       return layout.map(sizePercentage => {
         return {
@@ -1194,10 +1199,12 @@ function PanelGroupWithForwardedRef({
     setLayout: mixedSizes => {
       const {
         id: groupId,
+        onLayout
+      } = committedValuesRef.current;
+      const {
         layout: prevLayout,
-        onLayout,
         panelDataArray
-      } = committedValuesRef.current;
+      } = eagerValuesRef.current;
       const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
       const unsafeLayout = mixedSizes.map(mixedSize => getPercentageSizeFromMixedSizes(mixedSize, groupSizePixels));
       const safeLayout = validatePanelGroupLayout({
@@ -1207,7 +1214,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, safeLayout)) {
         setLayout(safeLayout);
-        committedValuesRef.current.layout = safeLayout;
+        eagerValuesRef.current.layout = safeLayout;
         if (onLayout) {
           onLayout(safeLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1221,15 +1228,16 @@ function PanelGroupWithForwardedRef({
 
   useWindowSplitterPanelGroupBehavior({
     committedValuesRef,
+    eagerValuesRef,
     groupId,
     layout,
-    panelDataArray: committedValuesRef.current.panelDataArray,
+    panelDataArray: eagerValuesRef.current.panelDataArray,
     setLayout
   });
   useEffect(() => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
 
     // If this panel has been configured to persist sizing information, save sizes to local storage.
     if (autoSaveId) {
@@ -1251,11 +1259,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const collapsePanel = useCallback(panelData => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1280,7 +1290,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1295,11 +1305,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const expandPanel = useCallback(panelData => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1325,7 +1337,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1343,7 +1355,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       panelSizePercentage,
       panelSizePixels
@@ -1358,7 +1370,7 @@ function PanelGroupWithForwardedRef({
   const getPanelStyle = useCallback(panelData => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const panelIndex = panelDataArray.indexOf(panelData);
     return computePanelFlexBoxStyle({
       dragState,
@@ -1373,7 +1385,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1387,7 +1399,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1399,11 +1411,13 @@ function PanelGroupWithForwardedRef({
     const {
       autoSaveId,
       id: groupId,
-      layout: prevLayout,
       onLayout,
-      panelDataArray,
       storage
     } = committedValuesRef.current;
+    const {
+      layout: prevLayout,
+      panelDataArray
+    } = eagerValuesRef.current;
     panelDataArray.push(panelData);
     panelDataArray.sort((panelA, panelB) => {
       const orderA = panelA.order;
@@ -1455,9 +1469,13 @@ function PanelGroupWithForwardedRef({
       layout: unsafeLayout,
       panelConstraints: panelDataArray.map(panelData => panelData.constraints)
     });
+
+    // Offscreen mode makes this a bit weird;
+    // Panels unregister when hidden and re-register when shown again,
+    // but the overall layout doesn't change between these two cases.
+    setLayout(nextLayout);
+    eagerValuesRef.current.layout = nextLayout;
     if (!areEqual(prevLayout, nextLayout)) {
-      setLayout(nextLayout);
-      committedValuesRef.current.layout = nextLayout;
       if (onLayout) {
         onLayout(nextLayout.map(sizePercentage => ({
           sizePercentage,
@@ -1476,10 +1494,12 @@ function PanelGroupWithForwardedRef({
         id: groupId,
         keyboardResizeByPercentage,
         keyboardResizeByPixels,
-        onLayout,
-        panelDataArray,
-        layout: prevLayout
+        onLayout
       } = committedValuesRef.current;
+      const {
+        layout: prevLayout,
+        panelDataArray
+      } = eagerValuesRef.current;
       const {
         initialLayout
       } = dragState !== null && dragState !== void 0 ? dragState : {};
@@ -1535,7 +1555,7 @@ function PanelGroupWithForwardedRef({
       }
       if (layoutChanged) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1549,11 +1569,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const resizePanel = useCallback((panelData, mixedSizes) => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
     const {
       groupSizePixels,
@@ -1573,7 +1595,7 @@ function PanelGroupWithForwardedRef({
     });
     if (!compareLayouts(prevLayout, nextLayout)) {
       setLayout(nextLayout);
-      committedValuesRef.current.layout = nextLayout;
+      eagerValuesRef.current.layout = nextLayout;
       if (onLayout) {
         onLayout(nextLayout.map(sizePercentage => ({
           sizePercentage,
@@ -1585,9 +1607,11 @@ function PanelGroupWithForwardedRef({
   }, [groupId]);
   const startDragging = useCallback((dragHandleId, event) => {
     const {
-      direction,
-      layout
+      direction
     } = committedValuesRef.current;
+    const {
+      layout
+    } = eagerValuesRef.current;
     const handleElement = getResizeHandleElement(dragHandleId);
     const initialCursorPosition = getResizeEventCursorPosition(direction, event);
     setDragState({
@@ -1608,10 +1632,12 @@ function PanelGroupWithForwardedRef({
   const unregisterPanel = useCallback(panelData => {
     const {
       id: groupId,
+      onLayout
+    } = committedValuesRef.current;
+    const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const index = panelDataArray.indexOf(panelData);
     if (index >= 0) {
       panelDataArray.splice(index, 1);
@@ -1628,7 +1654,7 @@ function PanelGroupWithForwardedRef({
       const {
         pendingPanelIds
       } = unregisterPanelRef.current;
-      panelIdToLastNotifiedMixedSizesMapRef.current;
+      const map = panelIdToLastNotifiedMixedSizesMapRef.current;
 
       // TRICKY
       // Strict effects mode
@@ -1644,7 +1670,7 @@ function PanelGroupWithForwardedRef({
           // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
           // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
           // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
-          delete panelIdToLastNotifiedMixedSizesMapRef.current[panelData.id];
+          delete map[panelData.id];
         }
       });
       if (!unmountDueToStrictMode) {
@@ -1669,7 +1695,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, nextLayout)) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,

package/dist/react-resizable-panels.node.esm.js

@@ -608,6 +608,7 @@ function getResizeHandlePanelIds(groupId, handleId, panelsArray) {
 
 function useWindowSplitterPanelGroupBehavior({
   committedValuesRef,
+  eagerValuesRef,
   groupId,
   layout,
   panelDataArray,
@@ -619,7 +620,7 @@ function useWindowSplitterPanelGroupBehavior({
   useEffect(() => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const groupElement = getPanelGroupElement(groupId);
     assert(groupElement != null, `No group found for id "${groupId}"`);
     const handles = getResizeHandleElementsForGroup(groupId);
@@ -677,7 +678,7 @@ function useWindowSplitterPanelGroupBehavior({
     return () => {
       cleanupFunctions.forEach(cleanupFunction => cleanupFunction());
     };
-  }, [committedValuesRef, groupId, layout, panelDataArray, setLayout]);
+  }, [committedValuesRef, eagerValuesRef, groupId, layout, panelDataArray, setLayout]);
 }
 
 function areEqual(arrayA, arrayB) {
@@ -1142,11 +1143,13 @@ function PanelGroupWithForwardedRef({
     id: groupId,
     keyboardResizeByPercentage,
     keyboardResizeByPixels,
-    layout,
     onLayout,
-    panelDataArray: [],
     storage
   });
+  const eagerValuesRef = useRef({
+    layout,
+    panelDataArray: []
+  });
   useRef({
     didLogIdAndOrderWarning: false,
     didLogPanelConstraintsWarning: false,
@@ -1156,9 +1159,11 @@ function PanelGroupWithForwardedRef({
     getId: () => committedValuesRef.current.id,
     getLayout: () => {
       const {
-        id: groupId,
-        layout
+        id: groupId
       } = committedValuesRef.current;
+      const {
+        layout
+      } = eagerValuesRef.current;
       const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
       return layout.map(sizePercentage => {
         return {
@@ -1170,10 +1175,12 @@ function PanelGroupWithForwardedRef({
     setLayout: mixedSizes => {
       const {
         id: groupId,
+        onLayout
+      } = committedValuesRef.current;
+      const {
         layout: prevLayout,
-        onLayout,
         panelDataArray
-      } = committedValuesRef.current;
+      } = eagerValuesRef.current;
       const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
       const unsafeLayout = mixedSizes.map(mixedSize => getPercentageSizeFromMixedSizes(mixedSize, groupSizePixels));
       const safeLayout = validatePanelGroupLayout({
@@ -1183,7 +1190,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, safeLayout)) {
         setLayout(safeLayout);
-        committedValuesRef.current.layout = safeLayout;
+        eagerValuesRef.current.layout = safeLayout;
         if (onLayout) {
           onLayout(safeLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1197,15 +1204,16 @@ function PanelGroupWithForwardedRef({
 
   useWindowSplitterPanelGroupBehavior({
     committedValuesRef,
+    eagerValuesRef,
     groupId,
     layout,
-    panelDataArray: committedValuesRef.current.panelDataArray,
+    panelDataArray: eagerValuesRef.current.panelDataArray,
     setLayout
   });
   useEffect(() => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
 
     // If this panel has been configured to persist sizing information, save sizes to local storage.
     if (autoSaveId) {
@@ -1227,11 +1235,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const collapsePanel = useCallback(panelData => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1256,7 +1266,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1271,11 +1281,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const expandPanel = useCallback(panelData => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1301,7 +1313,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1319,7 +1331,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       panelSizePercentage,
       panelSizePixels
@@ -1334,7 +1346,7 @@ function PanelGroupWithForwardedRef({
   const getPanelStyle = useCallback(panelData => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const panelIndex = panelDataArray.indexOf(panelData);
     return computePanelFlexBoxStyle({
       dragState,
@@ -1349,7 +1361,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1363,7 +1375,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1375,11 +1387,13 @@ function PanelGroupWithForwardedRef({
     const {
       autoSaveId,
       id: groupId,
-      layout: prevLayout,
       onLayout,
-      panelDataArray,
       storage
     } = committedValuesRef.current;
+    const {
+      layout: prevLayout,
+      panelDataArray
+    } = eagerValuesRef.current;
     panelDataArray.push(panelData);
     panelDataArray.sort((panelA, panelB) => {
       const orderA = panelA.order;
@@ -1431,9 +1445,13 @@ function PanelGroupWithForwardedRef({
       layout: unsafeLayout,
       panelConstraints: panelDataArray.map(panelData => panelData.constraints)
     });
+
+    // Offscreen mode makes this a bit weird;
+    // Panels unregister when hidden and re-register when shown again,
+    // but the overall layout doesn't change between these two cases.
+    setLayout(nextLayout);
+    eagerValuesRef.current.layout = nextLayout;
     if (!areEqual(prevLayout, nextLayout)) {
-      setLayout(nextLayout);
-      committedValuesRef.current.layout = nextLayout;
       if (onLayout) {
         onLayout(nextLayout.map(sizePercentage => ({
           sizePercentage,
@@ -1452,10 +1470,12 @@ function PanelGroupWithForwardedRef({
         id: groupId,
         keyboardResizeByPercentage,
         keyboardResizeByPixels,
-        onLayout,
-        panelDataArray,
-        layout: prevLayout
+        onLayout
       } = committedValuesRef.current;
+      const {
+        layout: prevLayout,
+        panelDataArray
+      } = eagerValuesRef.current;
       const {
         initialLayout
       } = dragState !== null && dragState !== void 0 ? dragState : {};
@@ -1511,7 +1531,7 @@ function PanelGroupWithForwardedRef({
       }
       if (layoutChanged) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1525,11 +1545,13 @@ function PanelGroupWithForwardedRef({
 
   // External APIs are safe to memoize via committed values ref
   const resizePanel = useCallback((panelData, mixedSizes) => {
+    const {
+      onLayout
+    } = committedValuesRef.current;
     const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
     const {
       groupSizePixels,
@@ -1549,7 +1571,7 @@ function PanelGroupWithForwardedRef({
     });
     if (!compareLayouts(prevLayout, nextLayout)) {
       setLayout(nextLayout);
-      committedValuesRef.current.layout = nextLayout;
+      eagerValuesRef.current.layout = nextLayout;
       if (onLayout) {
         onLayout(nextLayout.map(sizePercentage => ({
           sizePercentage,
@@ -1561,9 +1583,11 @@ function PanelGroupWithForwardedRef({
   }, [groupId]);
   const startDragging = useCallback((dragHandleId, event) => {
     const {
-      direction,
-      layout
+      direction
     } = committedValuesRef.current;
+    const {
+      layout
+    } = eagerValuesRef.current;
     const handleElement = getResizeHandleElement(dragHandleId);
     const initialCursorPosition = getResizeEventCursorPosition(direction, event);
     setDragState({
@@ -1584,10 +1608,12 @@ function PanelGroupWithForwardedRef({
   const unregisterPanel = useCallback(panelData => {
     const {
       id: groupId,
+      onLayout
+    } = committedValuesRef.current;
+    const {
       layout: prevLayout,
-      onLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const index = panelDataArray.indexOf(panelData);
     if (index >= 0) {
       panelDataArray.splice(index, 1);
@@ -1604,7 +1630,7 @@ function PanelGroupWithForwardedRef({
       const {
         pendingPanelIds
       } = unregisterPanelRef.current;
-      panelIdToLastNotifiedMixedSizesMapRef.current;
+      const map = panelIdToLastNotifiedMixedSizesMapRef.current;
 
       // TRICKY
       // Strict effects mode
@@ -1620,7 +1646,7 @@ function PanelGroupWithForwardedRef({
           // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
           // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
           // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
-          delete panelIdToLastNotifiedMixedSizesMapRef.current[panelData.id];
+          delete map[panelData.id];
         }
       });
       if (!unmountDueToStrictMode) {
@@ -1645,7 +1671,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, nextLayout)) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-resizable-panels",
-  "version": "0.0.60",
+  "version": "0.0.61",
   "description": "React components for resizable panel groups/layouts",
   "author": "Brian Vaughn <brian.david.vaughn@gmail.com>",
   "license": "MIT",