react-resizable-panels 0.0.60 → 0.0.62

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.0.62
+
+- Edge case expand/collapse invalid size guard (#220)
+
+## 0.0.61
+
+- Better unstable Offscreen/Activity API.
+
 ## 0.0.60
 
 - Better support imperative API usage from mount effects.

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

@@ -711,6 +711,7 @@ function getResizeHandlePanelIds(groupId, handleId, panelsArray) {
 
 function useWindowSplitterPanelGroupBehavior({
   committedValuesRef,
+  eagerValuesRef,
   groupId,
   layout,
   panelDataArray,
@@ -753,7 +754,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);
@@ -811,7 +812,7 @@ function useWindowSplitterPanelGroupBehavior({
     return () => {
       cleanupFunctions.forEach(cleanupFunction => cleanupFunction());
     };
-  }, [committedValuesRef, groupId, layout, panelDataArray, setLayout]);
+  }, [committedValuesRef, eagerValuesRef, groupId, layout, panelDataArray, setLayout]);
 }
 
 function areEqual(arrayA, arrayB) {
@@ -1276,11 +1277,13 @@ function PanelGroupWithForwardedRef({
     id: groupId,
     keyboardResizeByPercentage,
     keyboardResizeByPixels,
-    layout,
     onLayout,
-    panelDataArray: [],
     storage
   });
+  const eagerValuesRef = useRef({
+    layout,
+    panelDataArray: []
+  });
   useRef({
     didLogIdAndOrderWarning: false,
     didLogPanelConstraintsWarning: false,
@@ -1290,9 +1293,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 {
@@ -1304,10 +1309,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({
@@ -1317,7 +1324,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, safeLayout)) {
         setLayout(safeLayout);
-        committedValuesRef.current.layout = safeLayout;
+        eagerValuesRef.current.layout = safeLayout;
         if (onLayout) {
           onLayout(safeLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1342,15 +1349,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) {
@@ -1367,8 +1375,9 @@ function PanelGroupWithForwardedRef({
   }, [autoSaveId, layout, storage]);
   useIsomorphicLayoutEffect(() => {
     const {
+      layout: prevLayout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const constraints = panelDataArray.map(({
       constraints
     }) => constraints);
@@ -1382,7 +1391,6 @@ function PanelGroupWithForwardedRef({
       const resizeObserver = new ResizeObserver(() => {
         const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
         const {
-          layout: prevLayout,
           onLayout
         } = committedValuesRef.current;
         const nextLayout = validatePanelGroupLayout({
@@ -1392,7 +1400,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!areEqual(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1415,11 +1423,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 {
@@ -1444,7 +1454,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1459,11 +1469,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 {
@@ -1476,7 +1488,7 @@ function PanelGroupWithForwardedRef({
       if (panelSizePercentage === collapsedSizePercentage) {
         // Restore this panel to the size it was before it was collapsed, if possible.
         const prevPanelSizePercentage = panelSizeBeforeCollapseRef.current.get(panelData.id);
-        const baseSizePercentage = prevPanelSizePercentage != null ? prevPanelSizePercentage : minSizePercentage;
+        const baseSizePercentage = prevPanelSizePercentage != null && prevPanelSizePercentage >= minSizePercentage ? prevPanelSizePercentage : minSizePercentage;
         const isLastPanel = panelDataArray.indexOf(panelData) === panelDataArray.length - 1;
         const delta = isLastPanel ? panelSizePercentage - baseSizePercentage : baseSizePercentage - panelSizePercentage;
         const nextLayout = adjustLayoutByDelta({
@@ -1489,7 +1501,7 @@ function PanelGroupWithForwardedRef({
         });
         if (!compareLayouts(prevLayout, nextLayout)) {
           setLayout(nextLayout);
-          committedValuesRef.current.layout = nextLayout;
+          eagerValuesRef.current.layout = nextLayout;
           if (onLayout) {
             onLayout(nextLayout.map(sizePercentage => ({
               sizePercentage,
@@ -1507,7 +1519,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       panelSizePercentage,
       panelSizePixels
@@ -1522,7 +1534,7 @@ function PanelGroupWithForwardedRef({
   const getPanelStyle = useCallback(panelData => {
     const {
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const panelIndex = panelDataArray.indexOf(panelData);
     return computePanelFlexBoxStyle({
       dragState,
@@ -1537,7 +1549,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1551,7 +1563,7 @@ function PanelGroupWithForwardedRef({
     const {
       layout,
       panelDataArray
-    } = committedValuesRef.current;
+    } = eagerValuesRef.current;
     const {
       collapsedSizePercentage,
       collapsible,
@@ -1563,11 +1575,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;
@@ -1619,9 +1633,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,
@@ -1640,10 +1658,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 : {};
@@ -1699,7 +1719,7 @@ function PanelGroupWithForwardedRef({
       }
       if (layoutChanged) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,
@@ -1713,11 +1733,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,
@@ -1737,7 +1759,7 @@ function PanelGroupWithForwardedRef({
     });
     if (!compareLayouts(prevLayout, nextLayout)) {
       setLayout(nextLayout);
-      committedValuesRef.current.layout = nextLayout;
+      eagerValuesRef.current.layout = nextLayout;
       if (onLayout) {
         onLayout(nextLayout.map(sizePercentage => ({
           sizePercentage,
@@ -1749,9 +1771,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({
@@ -1772,10 +1796,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);
@@ -1792,7 +1818,7 @@ function PanelGroupWithForwardedRef({
       const {
         pendingPanelIds
       } = unregisterPanelRef.current;
-      panelIdToLastNotifiedMixedSizesMapRef.current;
+      const map = panelIdToLastNotifiedMixedSizesMapRef.current;
 
       // TRICKY
       // Strict effects mode
@@ -1808,7 +1834,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) {
@@ -1833,7 +1859,7 @@ function PanelGroupWithForwardedRef({
       });
       if (!areEqual(prevLayout, nextLayout)) {
         setLayout(nextLayout);
-        committedValuesRef.current.layout = nextLayout;
+        eagerValuesRef.current.layout = nextLayout;
         if (onLayout) {
           onLayout(nextLayout.map(sizePercentage => ({
             sizePercentage,