react-resizable-panels 0.0.58 → 0.0.59

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.59
+
+- Support imperative panel API usage on-mount.
+- Made PanelGroup bailout condition smarter (don't bailout for empty groups unless pixel constraints are used).
+- Improved window splitter compatibility by better handling "Enter" key.
+
 ## 0.0.58
 
 - Change group layout to more thoroughly distribute resize delta to support more flexible group size configurations.

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

@@ -198,8 +198,6 @@ const Panel = forwardRef((props, ref) => createElement(PanelWithForwardedRef, {
 PanelWithForwardedRef.displayName = "Panel";
 Panel.displayName = "forwardRef(Panel)";
 
-const PRECISION = 10;
-
 function convertPixelsToPercentage(pixels, groupSizePixels) {
   return pixels / groupSizePixels * 100;
 }
@@ -277,6 +275,8 @@ function computePercentagePanelConstraints(panelConstraintsArray, panelIndex, gr
   };
 }
 
+const PRECISION = 10;
+
 function fuzzyCompareNumbers(actual, expected, fractionDigits = PRECISION) {
   actual = parseFloat(actual.toFixed(fractionDigits));
   expected = parseFloat(expected.toFixed(fractionDigits));
@@ -750,15 +750,10 @@ function useWindowSplitterPanelGroupBehavior({
   }, [groupId, layout, panelDataArray]);
   useEffect(() => {
     const {
-      direction,
       panelDataArray
     } = committedValuesRef.current;
     const groupElement = getPanelGroupElement(groupId);
     assert(groupElement != null, `No group found for id "${groupId}"`);
-    const {
-      height,
-      width
-    } = groupElement.getBoundingClientRect();
     const handles = getResizeHandleElementsForGroup(groupId);
     const cleanupFunctions = handles.map(handle => {
       const handleId = handle.getAttribute("data-panel-resize-handle-id");
@@ -778,21 +773,19 @@ function useWindowSplitterPanelGroupBehavior({
               if (index >= 0) {
                 const panelData = panelDataArray[index];
                 const size = layout[index];
-                if (size != null) {
-                  var _getPercentageSizeFro;
+                if (size != null && panelData.constraints.collapsible) {
+                  var _getPercentageSizeFro, _getPercentageSizeFro2;
                   const groupSizePixels = getAvailableGroupSizePixels(groupId);
-                  const minSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                  const collapsedSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                    sizePercentage: panelData.constraints.collapsedSizePercentage,
+                    sizePixels: panelData.constraints.collapsedSizePixels
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
+                  const minSize = (_getPercentageSizeFro2 = getPercentageSizeFromMixedSizes({
                     sizePercentage: panelData.constraints.minSizePercentage,
                     sizePixels: panelData.constraints.minSizePixels
-                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
-                  let delta = 0;
-                  if (size.toPrecision(PRECISION) <= minSize.toPrecision(PRECISION)) {
-                    delta = direction === "horizontal" ? width : height;
-                  } else {
-                    delta = -(direction === "horizontal" ? width : height);
-                  }
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro2 !== void 0 ? _getPercentageSizeFro2 : 0;
                   const nextLayout = adjustLayoutByDelta({
-                    delta,
+                    delta: fuzzyNumbersEqual(size, collapsedSize) ? minSize - collapsedSize : collapsedSize - size,
                     groupSizePixels,
                     layout,
                     panelConstraints: panelDataArray.map(panelData => panelData.constraints),
@@ -1271,6 +1264,7 @@ function PanelGroupWithForwardedRef({
   const panelIdToLastNotifiedMixedSizesMapRef = useRef({});
   const panelSizeBeforeCollapseRef = useRef(new Map());
   const prevDeltaRef = useRef(0);
+  const [imperativeApiQueue, setImperativeApiQueue] = useState([]);
   const committedValuesRef = useRef({
     direction,
     dragState,
@@ -1379,8 +1373,12 @@ function PanelGroupWithForwardedRef({
     }
     const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
     if (groupSizePixels <= 0) {
-      // Wait until the group has rendered a non-zero size before computing layout.
-      return;
+      if (shouldMonitorPixelBasedConstraints(panelDataArray.map(({
+        constraints
+      }) => constraints))) {
+        // Wait until the group has rendered a non-zero size before computing layout.
+        return;
+      }
     }
     if (unsafeLayout == null) {
       unsafeLayout = calculateUnsafeDefaultLayout({
@@ -1458,6 +1456,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "collapse"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1501,6 +1510,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "expand"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1696,6 +1716,18 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        mixedSizes,
+        type: "resize"
+      }]);
+      return;
+    }
     const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
     const {
       groupSizePixels,
@@ -1753,6 +1785,31 @@ function PanelGroupWithForwardedRef({
       return panelDataArray;
     });
   }, []);
+
+  // Handle imperative API calls that were made before panels were registered
+  useIsomorphicLayoutEffect(() => {
+    const queue = imperativeApiQueue;
+    while (queue.length > 0) {
+      const current = queue.shift();
+      switch (current.type) {
+        case "collapse":
+          {
+            collapsePanel(current.panelData);
+            break;
+          }
+        case "expand":
+          {
+            expandPanel(current.panelData);
+            break;
+          }
+        case "resize":
+          {
+            resizePanel(current.panelData, current.mixedSizes);
+            break;
+          }
+      }
+    }
+  }, [collapsePanel, expandPanel, imperativeApiQueue, layout, panelDataArray, resizePanel]);
   const context = useMemo(() => ({
     collapsePanel,
     direction,

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

@@ -204,8 +204,6 @@ const Panel = forwardRef((props, ref) => createElement(PanelWithForwardedRef, {
 PanelWithForwardedRef.displayName = "Panel";
 Panel.displayName = "forwardRef(Panel)";
 
-const PRECISION = 10;
-
 function convertPixelsToPercentage(pixels, groupSizePixels) {
   return pixels / groupSizePixels * 100;
 }
@@ -283,6 +281,8 @@ function computePercentagePanelConstraints(panelConstraintsArray, panelIndex, gr
   };
 }
 
+const PRECISION = 10;
+
 function fuzzyCompareNumbers(actual, expected, fractionDigits = PRECISION) {
   actual = parseFloat(actual.toFixed(fractionDigits));
   expected = parseFloat(expected.toFixed(fractionDigits));
@@ -766,15 +766,10 @@ function useWindowSplitterPanelGroupBehavior({
   }, [groupId, layout, panelDataArray]);
   useEffect(() => {
     const {
-      direction,
       panelDataArray
     } = committedValuesRef.current;
     const groupElement = getPanelGroupElement(groupId);
     assert(groupElement != null, `No group found for id "${groupId}"`);
-    const {
-      height,
-      width
-    } = groupElement.getBoundingClientRect();
     const handles = getResizeHandleElementsForGroup(groupId);
     const cleanupFunctions = handles.map(handle => {
       const handleId = handle.getAttribute("data-panel-resize-handle-id");
@@ -794,21 +789,19 @@ function useWindowSplitterPanelGroupBehavior({
               if (index >= 0) {
                 const panelData = panelDataArray[index];
                 const size = layout[index];
-                if (size != null) {
-                  var _getPercentageSizeFro;
+                if (size != null && panelData.constraints.collapsible) {
+                  var _getPercentageSizeFro, _getPercentageSizeFro2;
                   const groupSizePixels = getAvailableGroupSizePixels(groupId);
-                  const minSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                  const collapsedSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                    sizePercentage: panelData.constraints.collapsedSizePercentage,
+                    sizePixels: panelData.constraints.collapsedSizePixels
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
+                  const minSize = (_getPercentageSizeFro2 = getPercentageSizeFromMixedSizes({
                     sizePercentage: panelData.constraints.minSizePercentage,
                     sizePixels: panelData.constraints.minSizePixels
-                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
-                  let delta = 0;
-                  if (size.toPrecision(PRECISION) <= minSize.toPrecision(PRECISION)) {
-                    delta = direction === "horizontal" ? width : height;
-                  } else {
-                    delta = -(direction === "horizontal" ? width : height);
-                  }
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro2 !== void 0 ? _getPercentageSizeFro2 : 0;
                   const nextLayout = adjustLayoutByDelta({
-                    delta,
+                    delta: fuzzyNumbersEqual(size, collapsedSize) ? minSize - collapsedSize : collapsedSize - size,
                     groupSizePixels,
                     layout,
                     panelConstraints: panelDataArray.map(panelData => panelData.constraints),
@@ -1364,6 +1357,7 @@ function PanelGroupWithForwardedRef({
   const panelIdToLastNotifiedMixedSizesMapRef = useRef({});
   const panelSizeBeforeCollapseRef = useRef(new Map());
   const prevDeltaRef = useRef(0);
+  const [imperativeApiQueue, setImperativeApiQueue] = useState([]);
   const committedValuesRef = useRef({
     direction,
     dragState,
@@ -1472,8 +1466,12 @@ function PanelGroupWithForwardedRef({
     }
     const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
     if (groupSizePixels <= 0) {
-      // Wait until the group has rendered a non-zero size before computing layout.
-      return;
+      if (shouldMonitorPixelBasedConstraints(panelDataArray.map(({
+        constraints
+      }) => constraints))) {
+        // Wait until the group has rendered a non-zero size before computing layout.
+        return;
+      }
     }
     if (unsafeLayout == null) {
       unsafeLayout = calculateUnsafeDefaultLayout({
@@ -1593,6 +1591,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "collapse"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1636,6 +1645,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "expand"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1831,6 +1851,18 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        mixedSizes,
+        type: "resize"
+      }]);
+      return;
+    }
     const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
     const {
       groupSizePixels,
@@ -1888,6 +1920,31 @@ function PanelGroupWithForwardedRef({
       return panelDataArray;
     });
   }, []);
+
+  // Handle imperative API calls that were made before panels were registered
+  useIsomorphicLayoutEffect(() => {
+    const queue = imperativeApiQueue;
+    while (queue.length > 0) {
+      const current = queue.shift();
+      switch (current.type) {
+        case "collapse":
+          {
+            collapsePanel(current.panelData);
+            break;
+          }
+        case "expand":
+          {
+            expandPanel(current.panelData);
+            break;
+          }
+        case "resize":
+          {
+            resizePanel(current.panelData, current.mixedSizes);
+            break;
+          }
+      }
+    }
+  }, [collapsePanel, expandPanel, imperativeApiQueue, layout, panelDataArray, resizePanel]);
   const context = useMemo(() => ({
     collapsePanel,
     direction,

package/dist/react-resizable-panels.browser.development.esm.js

@@ -180,8 +180,6 @@ const Panel = forwardRef((props, ref) => createElement(PanelWithForwardedRef, {
 PanelWithForwardedRef.displayName = "Panel";
 Panel.displayName = "forwardRef(Panel)";
 
-const PRECISION = 10;
-
 function convertPixelsToPercentage(pixels, groupSizePixels) {
   return pixels / groupSizePixels * 100;
 }
@@ -259,6 +257,8 @@ function computePercentagePanelConstraints(panelConstraintsArray, panelIndex, gr
   };
 }
 
+const PRECISION = 10;
+
 function fuzzyCompareNumbers(actual, expected, fractionDigits = PRECISION) {
   actual = parseFloat(actual.toFixed(fractionDigits));
   expected = parseFloat(expected.toFixed(fractionDigits));
@@ -742,15 +742,10 @@ function useWindowSplitterPanelGroupBehavior({
   }, [groupId, layout, panelDataArray]);
   useEffect(() => {
     const {
-      direction,
       panelDataArray
     } = committedValuesRef.current;
     const groupElement = getPanelGroupElement(groupId);
     assert(groupElement != null, `No group found for id "${groupId}"`);
-    const {
-      height,
-      width
-    } = groupElement.getBoundingClientRect();
     const handles = getResizeHandleElementsForGroup(groupId);
     const cleanupFunctions = handles.map(handle => {
       const handleId = handle.getAttribute("data-panel-resize-handle-id");
@@ -770,21 +765,19 @@ function useWindowSplitterPanelGroupBehavior({
               if (index >= 0) {
                 const panelData = panelDataArray[index];
                 const size = layout[index];
-                if (size != null) {
-                  var _getPercentageSizeFro;
+                if (size != null && panelData.constraints.collapsible) {
+                  var _getPercentageSizeFro, _getPercentageSizeFro2;
                   const groupSizePixels = getAvailableGroupSizePixels(groupId);
-                  const minSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                  const collapsedSize = (_getPercentageSizeFro = getPercentageSizeFromMixedSizes({
+                    sizePercentage: panelData.constraints.collapsedSizePercentage,
+                    sizePixels: panelData.constraints.collapsedSizePixels
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
+                  const minSize = (_getPercentageSizeFro2 = getPercentageSizeFromMixedSizes({
                     sizePercentage: panelData.constraints.minSizePercentage,
                     sizePixels: panelData.constraints.minSizePixels
-                  }, groupSizePixels)) !== null && _getPercentageSizeFro !== void 0 ? _getPercentageSizeFro : 0;
-                  let delta = 0;
-                  if (size.toPrecision(PRECISION) <= minSize.toPrecision(PRECISION)) {
-                    delta = direction === "horizontal" ? width : height;
-                  } else {
-                    delta = -(direction === "horizontal" ? width : height);
-                  }
+                  }, groupSizePixels)) !== null && _getPercentageSizeFro2 !== void 0 ? _getPercentageSizeFro2 : 0;
                   const nextLayout = adjustLayoutByDelta({
-                    delta,
+                    delta: fuzzyNumbersEqual(size, collapsedSize) ? minSize - collapsedSize : collapsedSize - size,
                     groupSizePixels,
                     layout,
                     panelConstraints: panelDataArray.map(panelData => panelData.constraints),
@@ -1340,6 +1333,7 @@ function PanelGroupWithForwardedRef({
   const panelIdToLastNotifiedMixedSizesMapRef = useRef({});
   const panelSizeBeforeCollapseRef = useRef(new Map());
   const prevDeltaRef = useRef(0);
+  const [imperativeApiQueue, setImperativeApiQueue] = useState([]);
   const committedValuesRef = useRef({
     direction,
     dragState,
@@ -1448,8 +1442,12 @@ function PanelGroupWithForwardedRef({
     }
     const groupSizePixels = calculateAvailablePanelSizeInPixels(groupId);
     if (groupSizePixels <= 0) {
-      // Wait until the group has rendered a non-zero size before computing layout.
-      return;
+      if (shouldMonitorPixelBasedConstraints(panelDataArray.map(({
+        constraints
+      }) => constraints))) {
+        // Wait until the group has rendered a non-zero size before computing layout.
+        return;
+      }
     }
     if (unsafeLayout == null) {
       unsafeLayout = calculateUnsafeDefaultLayout({
@@ -1569,6 +1567,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "collapse"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1612,6 +1621,17 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        type: "expand"
+      }]);
+      return;
+    }
     if (panelData.constraints.collapsible) {
       const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
       const {
@@ -1807,6 +1827,18 @@ function PanelGroupWithForwardedRef({
       onLayout,
       panelDataArray
     } = committedValuesRef.current;
+
+    // See issues/211
+    if (panelDataArray.find(({
+      id
+    }) => id === panelData.id) == null) {
+      setImperativeApiQueue(prev => [...prev, {
+        panelData,
+        mixedSizes,
+        type: "resize"
+      }]);
+      return;
+    }
     const panelConstraintsArray = panelDataArray.map(panelData => panelData.constraints);
     const {
       groupSizePixels,
@@ -1864,6 +1896,31 @@ function PanelGroupWithForwardedRef({
       return panelDataArray;
     });
   }, []);
+
+  // Handle imperative API calls that were made before panels were registered
+  useIsomorphicLayoutEffect(() => {
+    const queue = imperativeApiQueue;
+    while (queue.length > 0) {
+      const current = queue.shift();
+      switch (current.type) {
+        case "collapse":
+          {
+            collapsePanel(current.panelData);
+            break;
+          }
+        case "expand":
+          {
+            expandPanel(current.panelData);
+            break;
+          }
+        case "resize":
+          {
+            resizePanel(current.panelData, current.mixedSizes);
+            break;
+          }
+      }
+    }
+  }, [collapsePanel, expandPanel, imperativeApiQueue, layout, panelDataArray, resizePanel]);
   const context = useMemo(() => ({
     collapsePanel,
     direction,