react-resizable-panels 2.0.9 → 2.0.10

package/src/Panel.test.tsx

@@ -88,7 +88,7 @@ describe("PanelGroup", () => {
       });
 
       it("should expand and collapse the first panel in a group", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [50, 50]);
         expect(leftPanelRef.current?.isCollapsed()).toBe(false);
@@ -108,7 +108,7 @@ describe("PanelGroup", () => {
       });
 
       it("should expand and collapse the last panel in a group", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [50, 50]);
         expect(leftPanelRef.current?.isCollapsed()).toBe(false);
@@ -128,7 +128,7 @@ describe("PanelGroup", () => {
       });
 
       it("should re-expand to the most recent size before collapsing", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [50, 50]);
         act(() => {
@@ -178,7 +178,7 @@ describe("PanelGroup", () => {
       });
 
       it("should resize the first panel in a group", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [20, 60, 20]);
         act(() => {
@@ -188,7 +188,7 @@ describe("PanelGroup", () => {
       });
 
       it("should resize the middle panel in a group", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [20, 60, 20]);
         act(() => {
@@ -198,7 +198,7 @@ describe("PanelGroup", () => {
       });
 
       it("should resize the last panel in a group", () => {
-        assert(mostRecentLayout);
+        assert(mostRecentLayout, "");
 
         verifyExpandedPanelGroupLayout(mostRecentLayout, [20, 60, 20]);
         act(() => {
@@ -261,7 +261,7 @@ describe("PanelGroup", () => {
     });
 
     const element = getPanelElement("panel", container);
-    assert(element);
+    assert(element, "");
     expect(element.tabIndex).toBe(123);
     expect(element.getAttribute("data-test-name")).toBe("foo");
     expect(element.title).toBe("bar");
@@ -296,9 +296,9 @@ describe("PanelGroup", () => {
       let leftElement = getPanelElement("left", container);
       let middleElement = getPanelElement("middle", container);
       let rightElement = getPanelElement("right", container);
-      assert(leftElement);
-      assert(middleElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(middleElement, "");
+      assert(rightElement, "");
       expect(leftElement.getAttribute("data-panel-size")).toBe("10.0");
       expect(middleElement.getAttribute("data-panel-size")).toBe("80.0");
       expect(rightElement.getAttribute("data-panel-size")).toBe("10.0");
@@ -348,9 +348,9 @@ describe("PanelGroup", () => {
       let leftElement = getPanelElement("left", container);
       let middleElement = getPanelElement("middle", container);
       let rightElement = getPanelElement("right", container);
-      assert(leftElement);
-      assert(middleElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(middleElement, "");
+      assert(rightElement, "");
       expect(leftElement.getAttribute("data-panel-size")).toBe("10.0");
       expect(middleElement.getAttribute("data-panel-size")).toBe("80.0");
       expect(rightElement.getAttribute("data-panel-size")).toBe("10.0");
@@ -388,9 +388,9 @@ describe("PanelGroup", () => {
       let leftElement = getPanelElement("left", container);
       let middleElement = getPanelElement("middle", container);
       let rightElement = getPanelElement("right", container);
-      assert(leftElement);
-      assert(middleElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(middleElement, "");
+      assert(rightElement, "");
       expect(leftElement.getAttribute("data-panel-size")).toBe("15.0");
       expect(middleElement.getAttribute("data-panel-size")).toBe("70.0");
       expect(rightElement.getAttribute("data-panel-size")).toBe("15.0");
@@ -428,9 +428,9 @@ describe("PanelGroup", () => {
       let leftElement = getPanelElement("left", container);
       let middleElement = getPanelElement("middle", container);
       let rightElement = getPanelElement("right", container);
-      assert(leftElement);
-      assert(middleElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(middleElement, "");
+      assert(rightElement, "");
       expect(leftElement.getAttribute("data-panel-size")).toBe("25.0");
       expect(middleElement.getAttribute("data-panel-size")).toBe("50.0");
       expect(rightElement.getAttribute("data-panel-size")).toBe("25.0");
@@ -691,8 +691,8 @@ describe("PanelGroup", () => {
       const leftElement = getPanelElement("left-panel", container);
       const rightElement = getPanelElement("right-panel", container);
 
-      assert(leftElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(rightElement, "");
 
       verifyAttribute(leftElement, "data-panel", "");
       verifyAttribute(leftElement, "data-panel-id", "left-panel");
@@ -723,8 +723,8 @@ describe("PanelGroup", () => {
       const leftElement = getPanelElement("left-panel", container);
       const rightElement = getPanelElement("right-panel", container);
 
-      assert(leftElement);
-      assert(rightElement);
+      assert(leftElement, "");
+      assert(rightElement, "");
 
       verifyAttribute(leftElement, "data-panel-size", "75.0");
       verifyAttribute(rightElement, "data-panel-size", "25.0");

package/src/PanelGroup.test.tsx

@@ -1,6 +1,6 @@
 // @ts-expect-error This is an experimental API
 // eslint-disable-next-line no-restricted-imports
-import { unstable_Activity as Activity } from "react";
+import { unstable_Activity as Activity, Fragment } from "react";
 import { Root, createRoot } from "react-dom/client";
 import { act } from "react-dom/test-utils";
 import {
@@ -130,6 +130,35 @@ describe("PanelGroup", () => {
     expect(rightPanelElement?.getAttribute("data-panel-size")).toBe("40.0");
   });
 
+  // github.com/bvaughn/react-resizable-panels/issues/303
+  it("should recalculate layout after panels are changed", () => {
+    let mostRecentLayout: number[] | null = null;
+
+    const onLayout = (layout: number[]) => {
+      mostRecentLayout = layout;
+    };
+
+    act(() => {
+      root.render(
+        <PanelGroup direction="vertical" onLayout={onLayout}>
+          <Panel id="foo" minSize={30} order={0} />
+          <PanelResizeHandle />
+          <Panel id="bar" minSize={70} order={1} />
+        </PanelGroup>
+      );
+    });
+    expect(mostRecentLayout).toEqual([30, 70]);
+
+    act(() => {
+      root.render(
+        <PanelGroup direction="vertical" onLayout={onLayout}>
+          <Panel id="bar" minSize={70} order={0} />
+        </PanelGroup>
+      );
+    });
+    expect(mostRecentLayout).toEqual([100]);
+  });
+
   describe("imperative handle API", () => {
     it("should report the most recently rendered group id", () => {
       const ref = createRef<ImperativePanelGroupHandle>();
@@ -194,7 +223,7 @@ describe("PanelGroup", () => {
     });
 
     const element = getPanelGroupElement("group", container);
-    assert(element);
+    assert(element, "");
     expect(element.tabIndex).toBe(123);
     expect(element.getAttribute("data-test-name")).toBe("foo");
     expect(element.title).toBe("bar");
@@ -268,7 +297,7 @@ describe("PanelGroup", () => {
       });
 
       const element = getPanelGroupElement("test-group", container);
-      assert(element);
+      assert(element, "");
 
       verifyAttribute(element, "data-panel-group", "");
       verifyAttribute(element, "data-panel-group-direction", "horizontal");

package/src/PanelGroup.ts

@@ -302,7 +302,7 @@ function PanelGroupWithForwardedRef({
           panelIndex++
         ) {
           const panelData = panelDataArray[panelIndex];
-          assert(panelData);
+          assert(panelData, `Panel data not found for index ${panelIndex}`);
 
           const isValid = validatePanelConstraints({
             panelConstraints,
@@ -336,7 +336,10 @@ function PanelGroupWithForwardedRef({
         pivotIndices,
       } = panelDataHelper(panelDataArray, panelData, prevLayout);
 
-      assert(panelSize != null);
+      assert(
+        panelSize != null,
+        `Panel size not found for panel "${panelData.id}"`
+      );
 
       if (panelSize !== collapsedSize) {
         // Store size before collapse;
@@ -443,7 +446,10 @@ function PanelGroupWithForwardedRef({
 
     const { panelSize } = panelDataHelper(panelDataArray, panelData, layout);
 
-    assert(panelSize != null);
+    assert(
+      panelSize != null,
+      `Panel size not found for panel "${panelData.id}"`
+    );
 
     return panelSize;
   }, []);
@@ -489,7 +495,10 @@ function PanelGroupWithForwardedRef({
       panelSize,
     } = panelDataHelper(panelDataArray, panelData, layout);
 
-    assert(panelSize != null);
+    assert(
+      panelSize != null,
+      `Panel size not found for panel "${panelData.id}"`
+    );
 
     return !collapsible || panelSize > collapsedSize;
   }, []);
@@ -699,7 +708,10 @@ function PanelGroupWithForwardedRef({
         prevLayout
       );
 
-      assert(panelSize != null);
+      assert(
+        panelSize != null,
+        `Panel size not found for panel "${panelData.id}"`
+      );
 
       const isLastPanel =
         findPanelDataIndex(panelDataArray, panelData) ===
@@ -756,7 +768,10 @@ function PanelGroupWithForwardedRef({
         panelData,
         layout
       );
-      assert(prevPanelSize != null);
+      if (prevPanelSize == null) {
+        // It's possible that the panels in this group have changed since the last render
+        return;
+      }
 
       if (
         prevCollapsible &&
@@ -788,7 +803,10 @@ function PanelGroupWithForwardedRef({
         dragHandleId,
         panelGroupElementRef.current
       );
-      assert(handleElement);
+      assert(
+        handleElement,
+        `Drag handle element not found for id "${dragHandleId}"`
+      );
 
       const initialCursorPosition = getResizeEventCursorPosition(
         direction,

package/src/PanelResizeHandle.test.tsx

@@ -66,7 +66,7 @@ describe("PanelResizeHandle", () => {
     });
 
     const element = getResizeHandleElement("handle", container);
-    assert(element);
+    assert(element, "");
     expect(element.tabIndex).toBe(123);
     expect(element.getAttribute("data-test-name")).toBe("foo");
     expect(element.title).toBe("bar");
@@ -94,8 +94,8 @@ describe("PanelResizeHandle", () => {
     const leftElement = getResizeHandleElement("handle-left", container);
     const rightElement = getResizeHandleElement("handle-right", container);
 
-    assert(leftElement);
-    assert(rightElement);
+    assert(leftElement, "");
+    assert(rightElement, "");
 
     // JSDom doesn't properly handle bounding rects
     mockBoundingClientRect(leftElement, {

package/src/PanelResizeHandle.ts

@@ -116,7 +116,7 @@ export function PanelResizeHandle({
     }
 
     const element = elementRef.current;
-    assert(element);
+    assert(element, "Element ref not attached");
 
     const setResizeHandlerState = (
       action: ResizeHandlerAction,

package/src/hooks/useWindowSplitterBehavior.ts

@@ -49,7 +49,7 @@ export function useWindowSplitterResizeHandlerBehavior({
           event.preventDefault();
 
           const groupId = handleElement.getAttribute("data-panel-group-id");
-          assert(groupId);
+          assert(groupId, `No group element found for id "${groupId}"`);
 
           const handles = getResizeHandleElementsForGroup(
             groupId,
@@ -61,7 +61,10 @@ export function useWindowSplitterResizeHandlerBehavior({
             panelGroupElement
           );
 
-          assert(index !== null);
+          assert(
+            index !== null,
+            `No resize element found for id "${handleId}"`
+          );
 
           const nextIndex = event.shiftKey
             ? index > 0

package/src/hooks/useWindowSplitterPanelGroupBehavior.ts

@@ -72,7 +72,7 @@ export function useWindowSplitterPanelGroupBehavior({
         }
       } else {
         const panelData = panelDataArray[index];
-        assert(panelData);
+        assert(panelData, `No panel data found for index "${index}"`);
 
         resizeHandleElement.setAttribute("aria-controls", panelData.id);
         resizeHandleElement.setAttribute(
@@ -105,18 +105,18 @@ export function useWindowSplitterPanelGroupBehavior({
       return;
     }
     const eagerValues = eagerValuesRef.current;
-    assert(eagerValues);
+    assert(eagerValues, `Eager values not found`);
 
     const { panelDataArray } = eagerValues;
     const groupElement = getPanelGroupElement(groupId, panelGroupElement);
     assert(groupElement != null, `No group found for id "${groupId}"`);
 
     const handles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
-    assert(handles);
+    assert(handles, `No resize handles found for group id "${groupId}"`);
 
     const cleanupFunctions = handles.map((handle) => {
       const handleId = handle.getAttribute("data-panel-resize-handle-id");
-      assert(handleId);
+      assert(handleId, `Resize handle element has no handle id attribute`);
 
       const [idBefore, idAfter] = getResizeHandlePanelIds(
         groupId,
@@ -142,7 +142,7 @@ export function useWindowSplitterPanelGroupBehavior({
             );
             if (index >= 0) {
               const panelData = panelDataArray[index];
-              assert(panelData);
+              assert(panelData, `No panel data found for index ${index}`);
 
               const size = layout[index];
 

package/src/utils/adjustLayoutByDelta.ts

@@ -25,8 +25,8 @@ export function adjustLayoutByDelta({
   const nextLayout = [...prevLayout];
 
   const [firstPivotIndex, secondPivotIndex] = pivotIndices;
-  assert(firstPivotIndex != null);
-  assert(secondPivotIndex != null);
+  assert(firstPivotIndex != null, "Invalid first pivot index");
+  assert(secondPivotIndex != null, "Invalid second pivot index");
 
   let deltaApplied = 0;
 
@@ -53,17 +53,25 @@ export function adjustLayoutByDelta({
         // Check if we should expand a collapsed panel
         const index = delta < 0 ? secondPivotIndex : firstPivotIndex;
         const panelConstraints = panelConstraintsArray[index];
-        assert(panelConstraints);
+        assert(
+          panelConstraints,
+          `Panel constraints not found for index ${index}`
+        );
+
+        const {
+          collapsedSize = 0,
+          collapsible,
+          minSize = 0,
+        } = panelConstraints;
 
         //DEBUG.push(`edge case check 1: ${index}`);
         //DEBUG.push(`  -> collapsible? ${constraints.collapsible}`);
-        if (panelConstraints.collapsible) {
+        if (collapsible) {
           const prevSize = prevLayout[index];
-          assert(prevSize != null);
-
-          const panelConstraints = panelConstraintsArray[index];
-          assert(panelConstraints);
-          const { collapsedSize = 0, minSize = 0 } = panelConstraints;
+          assert(
+            prevSize != null,
+            `Previous layout not found for panel index ${index}`
+          );
 
           if (fuzzyNumbersEqual(prevSize, collapsedSize)) {
             const localDelta = minSize - prevSize;
@@ -81,18 +89,25 @@ export function adjustLayoutByDelta({
         // Check if we should collapse a panel at its minimum size
         const index = delta < 0 ? firstPivotIndex : secondPivotIndex;
         const panelConstraints = panelConstraintsArray[index];
-        assert(panelConstraints);
-        const { collapsible } = panelConstraints;
+        assert(
+          panelConstraints,
+          `No panel constraints found for index ${index}`
+        );
+
+        const {
+          collapsedSize = 0,
+          collapsible,
+          minSize = 0,
+        } = panelConstraints;
 
         //DEBUG.push(`edge case check 2: ${index}`);
         //DEBUG.push(`  -> collapsible? ${collapsible}`);
         if (collapsible) {
           const prevSize = prevLayout[index];
-          assert(prevSize != null);
-
-          const panelConstraints = panelConstraintsArray[index];
-          assert(panelConstraints);
-          const { collapsedSize = 0, minSize = 0 } = panelConstraints;
+          assert(
+            prevSize != null,
+            `Previous layout not found for panel index ${index}`
+          );
 
           if (fuzzyNumbersEqual(prevSize, minSize)) {
             const localDelta = prevSize - collapsedSize;
@@ -124,7 +139,10 @@ export function adjustLayoutByDelta({
     //DEBUG.push("pre calc...");
     while (true) {
       const prevSize = prevLayout[index];
-      assert(prevSize != null);
+      assert(
+        prevSize != null,
+        `Previous layout not found for panel index ${index}`
+      );
 
       const maxSafeSize = resizePanel({
         panelConstraints: panelConstraintsArray,
@@ -158,7 +176,10 @@ export function adjustLayoutByDelta({
       const deltaRemaining = Math.abs(delta) - Math.abs(deltaApplied);
 
       const prevSize = prevLayout[index];
-      assert(prevSize != null);
+      assert(
+        prevSize != null,
+        `Previous layout not found for panel index ${index}`
+      );
 
       const unsafeSize = prevSize - deltaRemaining;
       const safeSize = resizePanel({
@@ -206,7 +227,10 @@ export function adjustLayoutByDelta({
     const pivotIndex = delta < 0 ? secondPivotIndex : firstPivotIndex;
 
     const prevSize = prevLayout[pivotIndex];
-    assert(prevSize != null);
+    assert(
+      prevSize != null,
+      `Previous layout not found for panel index ${pivotIndex}`
+    );
 
     const unsafeSize = prevSize + deltaApplied;
     const safeSize = resizePanel({
@@ -226,7 +250,10 @@ export function adjustLayoutByDelta({
       let index = pivotIndex;
       while (index >= 0 && index < panelConstraintsArray.length) {
         const prevSize = nextLayout[index];
-        assert(prevSize != null);
+        assert(
+          prevSize != null,
+          `Previous layout not found for panel index ${index}`
+        );
 
         const unsafeSize = prevSize + deltaRemaining;
         const safeSize = resizePanel({

package/src/utils/assert.ts

@@ -1,6 +1,6 @@
 export function assert(
   expectedCondition: any,
-  message: string = "Assertion failed!"
+  message: string
 ): asserts expectedCondition {
   if (!expectedCondition) {
     console.error(message);

package/src/utils/calculateAriaValues.ts

@@ -16,7 +16,7 @@ export function calculateAriaValues({
   let totalMaxSize = 0;
 
   const firstIndex = pivotIndices[0];
-  assert(firstIndex != null);
+  assert(firstIndex != null, "No pivot index found");
 
   // A panel's effective min/max sizes also need to account for other panel's sizes.
   panelsArray.forEach((panelData, index) => {

package/src/utils/calculateDragOffsetPercentage.ts

@@ -15,17 +15,20 @@ export function calculateDragOffsetPercentage(
   const isHorizontal = direction === "horizontal";
 
   const handleElement = getResizeHandleElement(dragHandleId, panelGroupElement);
-  assert(handleElement);
+  assert(
+    handleElement,
+    `No resize handle element found for id "${dragHandleId}"`
+  );
 
   const groupId = handleElement.getAttribute("data-panel-group-id");
-  assert(groupId);
+  assert(groupId, `Resize handle element has no group id attribute`);
 
   let { initialCursorPosition } = initialDragState;
 
   const cursorPosition = getResizeEventCursorPosition(direction, event);
 
   const groupElement = getPanelGroupElement(groupId, panelGroupElement);
-  assert(groupElement);
+  assert(groupElement, `No group element found for id "${groupId}"`);
 
   const groupRect = groupElement.getBoundingClientRect();
   const groupSizeInPixels = isHorizontal ? groupRect.width : groupRect.height;

package/src/utils/calculateUnsafeDefaultLayout.ts

@@ -18,7 +18,7 @@ export function calculateUnsafeDefaultLayout({
   // Distribute default sizes first
   for (let index = 0; index < panelDataArray.length; index++) {
     const panelConstraints = panelConstraintsArray[index];
-    assert(panelConstraints);
+    assert(panelConstraints, `Panel constraints not found for index ${index}`);
     const { defaultSize } = panelConstraints;
 
     if (defaultSize != null) {
@@ -31,7 +31,7 @@ export function calculateUnsafeDefaultLayout({
   // Remaining size should be distributed evenly between panels without default sizes
   for (let index = 0; index < panelDataArray.length; index++) {
     const panelConstraints = panelConstraintsArray[index];
-    assert(panelConstraints);
+    assert(panelConstraints, `Panel constraints not found for index ${index}`);
     const { defaultSize } = panelConstraints;
 
     if (defaultSize != null) {

package/src/utils/callPanelCallbacks.ts

@@ -9,7 +9,7 @@ export function callPanelCallbacks(
 ) {
   layout.forEach((size, index) => {
     const panelData = panelsArray[index];
-    assert(panelData);
+    assert(panelData, `Panel data not found for index ${index}`);
 
     const { callbacks, constraints, id: panelId } = panelData;
     const { collapsedSize = 0, collapsible } = constraints;

package/src/utils/resizePanel.ts

@@ -14,7 +14,10 @@ export function resizePanel({
   size: number;
 }) {
   const panelConstraints = panelConstraintsArray[panelIndex];
-  assert(panelConstraints != null);
+  assert(
+    panelConstraints != null,
+    `Panel constraints not found for index ${panelIndex}`
+  );
 
   let {
     collapsedSize = 0,

package/src/utils/test-utils.ts

@@ -38,7 +38,7 @@ export function expectToBeCloseToArray(
   try {
     actualNumbers.forEach((actualNumber, index) => {
       const expectedNumber = expectedNumbers[index];
-      assert(expectedNumber != null);
+      assert(expectedNumber != null, `Expected number not found`);
 
       expect(actualNumber).toBeCloseTo(expectedNumber, 1);
     });

package/src/utils/validatePanelConstraints.ts

@@ -15,7 +15,10 @@ export function validatePanelConstraints({
     const warnings = [];
 
     const panelConstraints = panelConstraintsArray[panelIndex];
-    assert(panelConstraints);
+    assert(
+      panelConstraints,
+      `No panel constraints found for index ${panelIndex}`
+    );
 
     const {
       collapsedSize = 0,

package/src/utils/validatePanelGroupLayout.ts

@@ -37,7 +37,7 @@ export function validatePanelGroupLayout({
     }
     for (let index = 0; index < panelConstraints.length; index++) {
       const unsafeSize = nextLayout[index];
-      assert(unsafeSize != null);
+      assert(unsafeSize != null, `No layout data found for index ${index}`);
       const safeSize = (100 / nextLayoutTotalSize) * unsafeSize;
       nextLayout[index] = safeSize;
     }
@@ -48,7 +48,7 @@ export function validatePanelGroupLayout({
   // First pass: Validate the proposed layout given each panel's constraints
   for (let index = 0; index < panelConstraints.length; index++) {
     const unsafeSize = nextLayout[index];
-    assert(unsafeSize != null);
+    assert(unsafeSize != null, `No layout data found for index ${index}`);
 
     const safeSize = resizePanel({
       panelConstraints,
@@ -68,7 +68,7 @@ export function validatePanelGroupLayout({
   if (!fuzzyNumbersEqual(remainingSize, 0)) {
     for (let index = 0; index < panelConstraints.length; index++) {
       const prevSize = nextLayout[index];
-      assert(prevSize != null);
+      assert(prevSize != null, `No layout data found for index ${index}`);
       const unsafeSize = prevSize + remainingSize;
       const safeSize = resizePanel({
         panelConstraints,

package/src/vendor/stacking-order.ts

@@ -27,7 +27,10 @@ export function compare(a: HTMLElement, b: HTMLElement): number {
     common_ancestor = a;
   }
 
-  assert(common_ancestor);
+  assert(
+    common_ancestor,
+    "Stacking order can only be calculated for elements with a common ancestor"
+  );
 
   const z_indexes = {
     a: get_z_index(find_stacking_context(ancestors.a)),
@@ -99,7 +102,7 @@ function find_stacking_context(nodes: HTMLElement[]) {
 
   while (i--) {
     const node = nodes[i];
-    assert(node);
+    assert(node, "Missing node");
     if (creates_stacking_context(node)) return node;
   }