react-resizable-panels 2.0.9 → 2.0.11

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.0.11
+
+- Fix resize handle cursor hit detection when when viewport is scrolled (#305)
+
+## 2.0.10
+
+- Fix conditional layout edge case (#309)
+
 ## 2.0.9
 
 - Fix Flex stacking context bug (#301)

package/dist/declarations/src/utils/assert.d.ts

@@ -1 +1 @@
-export declare function assert(expectedCondition: any, message?: string): asserts expectedCondition;
+export declare function assert(expectedCondition: any, message: string): asserts expectedCondition;

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

@@ -271,15 +271,15 @@ function isTouchEvent(event) {
 function getResizeEventCoordinates(event) {
   if (isMouseEvent(event)) {
     return {
-      x: event.pageX,
-      y: event.pageY
+      x: event.clientX,
+      y: event.clientY
     };
   } else if (isTouchEvent(event)) {
     const touch = event.touches[0];
-    if (touch && touch.pageX && touch.pageY) {
+    if (touch && touch.clientX && touch.clientY) {
       return {
-        x: touch.pageX,
-        y: touch.pageY
+        x: touch.clientX,
+        y: touch.clientY
       };
     }
   }
@@ -325,7 +325,7 @@ function compare(a, b) {
     b = ancestors.b.pop();
     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)),
     b: get_z_index(find_stacking_context(ancestors.b))
@@ -383,7 +383,7 @@ function find_stacking_context(nodes) {
   let i = nodes.length;
   while (i--) {
     const node = nodes[i];
-    assert(node);
+    assert(node, "Missing node");
     if (creates_stacking_context(node)) return node;
   }
   return null;
@@ -670,7 +670,7 @@ function updateResizeHandlerStates(action, event) {
   });
 }
 
-function assert(expectedCondition, message = "Assertion failed!") {
+function assert(expectedCondition, message) {
   if (!expectedCondition) {
     console.error(message);
     throw Error(message);
@@ -701,7 +701,7 @@ function resizePanel({
   size
 }) {
   const panelConstraints = panelConstraintsArray[panelIndex];
-  assert(panelConstraints != null);
+  assert(panelConstraints != null, `Panel constraints not found for index ${panelIndex}`);
   let {
     collapsedSize = 0,
     collapsible,
@@ -739,8 +739,8 @@ 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;
 
   //const DEBUG = [];
@@ -766,19 +766,18 @@ 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;
             //DEBUG.push(`  -> expand delta: ${localDelta}`);
@@ -795,22 +794,18 @@ 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);
+        assert(panelConstraints, `No panel constraints found for index ${index}`);
         const {
-          collapsible
+          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;
             //DEBUG.push(`  -> expand delta: ${localDelta}`);
@@ -840,7 +835,7 @@ 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,
         panelIndex: index,
@@ -871,7 +866,7 @@ function adjustLayoutByDelta({
     while (index >= 0 && index < panelConstraintsArray.length) {
       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({
         panelConstraints: panelConstraintsArray,
@@ -908,7 +903,7 @@ function adjustLayoutByDelta({
     // Now distribute the applied delta to the panels in the other direction
     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({
       panelConstraints: panelConstraintsArray,
@@ -926,7 +921,7 @@ 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({
           panelConstraints: panelConstraintsArray,
@@ -972,7 +967,7 @@ function calculateAriaValues({
   let totalMinSize = 0;
   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) => {
@@ -1081,7 +1076,7 @@ function useWindowSplitterPanelGroupBehavior({
       const resizeHandleElement = resizeHandleElements[index];
       if (resizeHandleElement == null) ; else {
         const panelData = panelDataArray[index];
-        assert(panelData);
+        assert(panelData, `No panel data found for index "${index}"`);
         resizeHandleElement.setAttribute("aria-controls", panelData.id);
         resizeHandleElement.setAttribute("aria-valuemax", "" + Math.round(valueMax));
         resizeHandleElement.setAttribute("aria-valuemin", "" + Math.round(valueMin));
@@ -1102,17 +1097,17 @@ 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, handleId, panelDataArray, panelGroupElement);
       if (idBefore == null || idAfter == null) {
         return () => {};
@@ -1128,7 +1123,7 @@ function useWindowSplitterPanelGroupBehavior({
               const index = panelDataArray.findIndex(panelData => panelData.id === idBefore);
               if (index >= 0) {
                 const panelData = panelDataArray[index];
-                assert(panelData);
+                assert(panelData, `No panel data found for index ${index}`);
                 const size = layout[index];
                 const {
                   collapsedSize = 0,
@@ -1187,15 +1182,15 @@ function getResizeEventCursorPosition(direction, event) {
 function calculateDragOffsetPercentage(event, dragHandleId, direction, initialDragState, panelGroupElement) {
   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;
   const offsetPixels = cursorPosition - initialCursorPosition;
@@ -1256,7 +1251,7 @@ 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;
@@ -1270,7 +1265,7 @@ 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;
@@ -1290,7 +1285,7 @@ function calculateUnsafeDefaultLayout({
 function callPanelCallbacks(panelsArray, layout, panelIdToLastNotifiedSizeMap) {
   layout.forEach((size, index) => {
     const panelData = panelsArray[index];
-    assert(panelData);
+    assert(panelData, `Panel data not found for index ${index}`);
     const {
       callbacks,
       constraints,
@@ -1480,7 +1475,7 @@ function validatePanelGroupLayout({
   } else if (!fuzzyNumbersEqual(nextLayoutTotalSize, 100)) {
     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;
     }
@@ -1490,7 +1485,7 @@ 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,
       panelIndex: index,
@@ -1507,7 +1502,7 @@ 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,
@@ -1673,7 +1668,7 @@ function PanelGroupWithForwardedRef({
         panelSize,
         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;
         // This is the size that gets restored if the expand() API is used.
@@ -1750,7 +1745,7 @@ function PanelGroupWithForwardedRef({
     const {
       panelSize
     } = panelDataHelper(panelDataArray, panelData, layout);
-    assert(panelSize != null);
+    assert(panelSize != null, `Panel size not found for panel "${panelData.id}"`);
     return panelSize;
   }, []);
 
@@ -1794,7 +1789,7 @@ function PanelGroupWithForwardedRef({
       collapsible,
       panelSize
     } = panelDataHelper(panelDataArray, panelData, layout);
-    assert(panelSize != null);
+    assert(panelSize != null, `Panel size not found for panel "${panelData.id}"`);
     return !collapsible || panelSize > collapsedSize;
   }, []);
   const registerPanel = useCallback(panelData => {
@@ -1961,7 +1956,7 @@ function PanelGroupWithForwardedRef({
       panelSize,
       pivotIndices
     } = panelDataHelper(panelDataArray, panelData, prevLayout);
-    assert(panelSize != null);
+    assert(panelSize != null, `Panel size not found for panel "${panelData.id}"`);
     const isLastPanel = findPanelDataIndex(panelDataArray, panelData) === panelDataArray.length - 1;
     const delta = isLastPanel ? panelSize - unsafePanelSize : unsafePanelSize - panelSize;
     const nextLayout = adjustLayoutByDelta({
@@ -1998,7 +1993,10 @@ function PanelGroupWithForwardedRef({
     const {
       panelSize: prevPanelSize
     } = panelDataHelper(panelDataArray, 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 && nextCollapsible && prevPanelSize === prevCollapsedSize) {
       if (prevCollapsedSize !== nextCollapsedSize) {
         resizePanel(panelData, nextCollapsedSize);
@@ -2020,7 +2018,7 @@ function PanelGroupWithForwardedRef({
       return;
     }
     const handleElement = getResizeHandleElement(dragHandleId, panelGroupElementRef.current);
-    assert(handleElement);
+    assert(handleElement, `Drag handle element not found for id "${dragHandleId}"`);
     const initialCursorPosition = getResizeEventCursorPosition(direction, event);
     setDragState({
       dragHandleId,
@@ -2149,10 +2147,10 @@ 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, panelGroupElement);
             const index = getResizeHandleElementIndex(groupId, handleId, panelGroupElement);
-            assert(index !== null);
+            assert(index !== null, `No resize element found for id "${handleId}"`);
             const nextIndex = event.shiftKey ? index > 0 ? index - 1 : handles.length - 1 : index + 1 < handles.length ? index + 1 : 0;
             const nextHandle = handles[nextIndex];
             nextHandle.focus();
@@ -2224,7 +2222,7 @@ function PanelResizeHandle({
       return;
     }
     const element = elementRef.current;
-    assert(element);
+    assert(element, "Element ref not attached");
     const setResizeHandlerState = (action, isActive, event) => {
       if (isActive) {
         switch (action) {