react-resizable-panels 0.0.57 → 0.0.59

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # 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.
+- Add data attribute support to `Panel`, `PanelGroup`, and `PanelResizeHandle`.
+- Update API documentation to reflect changed imperative API method names.
+- `PanelOnResize` TypeScript def updated to reflect that previous size param is `undefined` the first time it is called.
+
 ## 0.0.57
 
 - [#207](https://github.com/bvaughn/react-resizable-panels/pull/207): Fix DEV conditional error that broke data attributes (and selectors).

package/dist/declarations/src/Panel.d.ts

@@ -1,8 +1,8 @@
-import { MixedSizes } from "./types.js";
+import { DataAttributes, MixedSizes } from "./types.js";
 import { ElementType, ForwardedRef, PropsWithChildren } from "./vendor/react.js";
 export type PanelOnCollapse = () => void;
 export type PanelOnExpand = () => void;
-export type PanelOnResize = (mixedSizes: MixedSizes, prevMixedSizes: MixedSizes) => void;
+export type PanelOnResize = (mixedSizes: MixedSizes, prevMixedSizes: MixedSizes | undefined) => void;
 export type PanelCallbacks = {
     onCollapse?: PanelOnCollapse;
     onExpand?: PanelOnExpand;
@@ -31,6 +31,8 @@ export type ImperativePanelHandle = {
     expand: () => void;
     getId(): string;
     getSize(): MixedSizes;
+    isCollapsed: () => boolean;
+    isExpanded: () => boolean;
     resize: (size: Partial<MixedSizes>) => void;
 };
 export type PanelProps = PropsWithChildren<{
@@ -38,6 +40,7 @@ export type PanelProps = PropsWithChildren<{
     collapsedSizePercentage?: number | undefined;
     collapsedSizePixels?: number | undefined;
     collapsible?: boolean | undefined;
+    dataAttributes?: DataAttributes;
     defaultSizePercentage?: number | undefined;
     defaultSizePixels?: number | undefined;
     id?: string;
@@ -52,7 +55,7 @@ export type PanelProps = PropsWithChildren<{
     style?: object;
     tagName?: ElementType;
 }>;
-export declare function PanelWithForwardedRef({ children, className: classNameFromProps, collapsedSizePercentage, collapsedSizePixels, collapsible, defaultSizePercentage, defaultSizePixels, forwardedRef, id: idFromProps, maxSizePercentage, maxSizePixels, minSizePercentage, minSizePixels, onCollapse, onExpand, onResize, order, style: styleFromProps, tagName: Type, }: PanelProps & {
+export declare function PanelWithForwardedRef({ children, className: classNameFromProps, collapsedSizePercentage, collapsedSizePixels, collapsible, dataAttributes, defaultSizePercentage, defaultSizePixels, forwardedRef, id: idFromProps, maxSizePercentage, maxSizePixels, minSizePercentage, minSizePixels, onCollapse, onExpand, onResize, order, style: styleFromProps, tagName: Type, }: PanelProps & {
     forwardedRef: ForwardedRef<ImperativePanelHandle>;
 }): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 export declare namespace PanelWithForwardedRef {
@@ -63,6 +66,7 @@ export declare const Panel: import("react").ForwardRefExoticComponent<{
     collapsedSizePercentage?: number | undefined;
     collapsedSizePixels?: number | undefined;
     collapsible?: boolean | undefined;
+    dataAttributes?: DataAttributes | undefined;
     defaultSizePercentage?: number | undefined;
     defaultSizePixels?: number | undefined;
     id?: string | undefined;

package/dist/declarations/src/PanelGroup.d.ts

@@ -1,4 +1,4 @@
-import { Direction, MixedSizes } from "./types.js";
+import { DataAttributes, Direction, MixedSizes } from "./types.js";
 import { CSSProperties, ElementType, PropsWithChildren } from "./vendor/react.js";
 export type ImperativePanelGroupHandle = {
     getId: () => string;
@@ -13,6 +13,7 @@ export type PanelGroupOnLayout = (layout: MixedSizes[]) => void;
 export type PanelGroupProps = PropsWithChildren<{
     autoSaveId?: string;
     className?: string;
+    dataAttributes?: DataAttributes;
     direction: Direction;
     id?: string | null;
     keyboardResizeByPercentage?: number | null;
@@ -25,6 +26,7 @@ export type PanelGroupProps = PropsWithChildren<{
 export declare const PanelGroup: import("react").ForwardRefExoticComponent<{
     autoSaveId?: string | undefined;
     className?: string | undefined;
+    dataAttributes?: DataAttributes | undefined;
     direction: Direction;
     id?: string | null | undefined;
     keyboardResizeByPercentage?: number | null | undefined;

package/dist/declarations/src/PanelResizeHandle.d.ts

@@ -1,15 +1,17 @@
 import { CSSProperties, ElementType, ReactNode } from "./vendor/react.js";
+import { DataAttributes } from "./types.js";
 export type PanelResizeHandleOnDragging = (isDragging: boolean) => void;
 export type PanelResizeHandleProps = {
     children?: ReactNode;
     className?: string;
+    dataAttributes?: DataAttributes;
     disabled?: boolean;
     id?: string | null;
     onDragging?: PanelResizeHandleOnDragging;
     style?: CSSProperties;
     tagName?: ElementType;
 };
-export declare function PanelResizeHandle({ children, className: classNameFromProps, disabled, id: idFromProps, onDragging, style: styleFromProps, tagName: Type, }: PanelResizeHandleProps): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
+export declare function PanelResizeHandle({ children, className: classNameFromProps, dataAttributes, disabled, id: idFromProps, onDragging, style: styleFromProps, tagName: Type, }: PanelResizeHandleProps): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 export declare namespace PanelResizeHandle {
     var displayName: string;
 }

package/dist/declarations/src/types.d.ts

@@ -5,3 +5,6 @@ export type MixedSizes = {
 };
 export type ResizeEvent = KeyboardEvent | MouseEvent | TouchEvent;
 export type ResizeHandler = (event: ResizeEvent) => void;
+export type DataAttributes = {
+    [attribute: string]: string | number | boolean | undefined;
+};

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

@@ -68,6 +68,7 @@ function PanelWithForwardedRef({
   collapsedSizePercentage,
   collapsedSizePixels,
   collapsible,
+  dataAttributes,
   defaultSizePercentage,
   defaultSizePixels,
   forwardedRef,
@@ -181,6 +182,7 @@ function PanelWithForwardedRef({
       ...style,
       ...styleFromProps
     },
+    ...dataAttributes,
     // CSS selectors
     "data-panel": "",
     "data-panel-id": panelId,
@@ -196,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;
 }
@@ -275,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));
@@ -318,7 +320,13 @@ function resizePanel({
   if (minSizePercentage != null) {
     if (fuzzyCompareNumbers(size, minSizePercentage) < 0) {
       if (collapsible) {
-        size = collapsedSizePercentage;
+        // Collapsible panels should snap closed or open only once they cross the halfway point between collapsed and min size.
+        const halfwayPoint = (collapsedSizePercentage + minSizePercentage) / 2;
+        if (fuzzyCompareNumbers(size, halfwayPoint) < 0) {
+          size = collapsedSizePercentage;
+        } else {
+          size = minSizePercentage;
+        }
       } else {
         size = minSizePercentage;
       }
@@ -345,60 +353,123 @@ function adjustLayoutByDelta({
   const nextLayout = [...prevLayout];
   let deltaApplied = 0;
 
+  //const DEBUG = [];
+  //DEBUG.push(`adjustLayoutByDelta() ${prevLayout.join(", ")}`);
+  //DEBUG.push(`  delta: ${delta}`);
+  //DEBUG.push(`  pivotIndices: ${pivotIndices.join(", ")}`);
+  //DEBUG.push(`  trigger: ${trigger}`);
+  //DEBUG.push("");
+
   // A resizing panel affects the panels before or after it.
   //
-  // A negative delta means the panel immediately after the resizer should grow/expand by decreasing its offset.
+  // A negative delta means the panel(s) immediately after the resize handle should grow/expand by decreasing its offset.
   // Other panels may also need to shrink/contract (and shift) to make room, depending on the min weights.
   //
-  // A positive delta means the panel immediately before the resizer should "expand".
-  // This is accomplished by shrinking/contracting (and shifting) one or more of the panels after the resizer.
+  // A positive delta means the panel(s) immediately before the resize handle should "expand".
+  // This is accomplished by shrinking/contracting (and shifting) one or more of the panels after the resize handle.
 
-  // First, check the panel we're pivoting around;
-  // We should only expand or contract by as much as its constraints allow
   {
-    const pivotIndex = delta < 0 ? pivotIndices[1] : pivotIndices[0];
-    const initialSize = nextLayout[pivotIndex];
-    const {
-      collapsible
-    } = panelConstraints[pivotIndex];
-    const {
-      collapsedSizePercentage,
-      minSizePercentage
-    } = computePercentagePanelConstraints(panelConstraints, pivotIndex, groupSizePixels);
-    const isCollapsed = collapsible && fuzzyNumbersEqual(initialSize, collapsedSizePercentage);
-    let unsafeSize = initialSize + Math.abs(delta);
-    if (isCollapsed) {
-      switch (trigger) {
-        case "keyboard":
-          if (minSizePercentage > unsafeSize) {
-            unsafeSize = minSizePercentage;
+    // If this is a resize triggered by a keyboard event, our logic for expanding/collapsing is different.
+    // We no longer check the halfway threshold because this may prevent the panel from expanding at all.
+    if (trigger === "keyboard") {
+      {
+        // Check if we should expand a collapsed panel
+        const index = delta < 0 ? pivotIndices[1] : pivotIndices[0];
+        const constraints = panelConstraints[index];
+        //DEBUG.push(`edge case check 1: ${index}`);
+        //DEBUG.push(`  -> collapsible? ${constraints.collapsible}`);
+        if (constraints.collapsible) {
+          const prevSize = prevLayout[index];
+          const {
+            collapsedSizePercentage,
+            minSizePercentage
+          } = computePercentagePanelConstraints(panelConstraints, index, groupSizePixels);
+          if (fuzzyNumbersEqual(prevSize, collapsedSizePercentage)) {
+            const localDelta = minSizePercentage - prevSize;
+            //DEBUG.push(`  -> expand delta: ${localDelta}`);
+
+            if (fuzzyCompareNumbers(localDelta, Math.abs(delta)) > 0) {
+              delta = delta < 0 ? 0 - localDelta : localDelta;
+              //DEBUG.push(`  -> delta: ${delta}`);
+            }
+          }
+        }
+      }
+
+      {
+        // Check if we should collapse a panel at its minimum size
+        const index = delta < 0 ? pivotIndices[0] : pivotIndices[1];
+        const constraints = panelConstraints[index];
+        //DEBUG.push(`edge case check 2: ${index}`);
+        //DEBUG.push(`  -> collapsible? ${constraints.collapsible}`);
+        if (constraints.collapsible) {
+          const prevSize = prevLayout[index];
+          const {
+            collapsedSizePercentage,
+            minSizePercentage
+          } = computePercentagePanelConstraints(panelConstraints, index, groupSizePixels);
+          if (fuzzyNumbersEqual(prevSize, minSizePercentage)) {
+            const localDelta = prevSize - collapsedSizePercentage;
+            //DEBUG.push(`  -> expand delta: ${localDelta}`);
+
+            if (fuzzyCompareNumbers(localDelta, Math.abs(delta)) > 0) {
+              delta = delta < 0 ? 0 - localDelta : localDelta;
+              //DEBUG.push(`  -> delta: ${delta}`);
+            }
           }
+        }
       }
     }
-    const safeSize = resizePanel({
-      groupSizePixels,
-      panelConstraints,
-      panelIndex: pivotIndex,
-      size: unsafeSize
-    });
-    if (fuzzyNumbersEqual(initialSize, safeSize)) {
-      // If there's no room for the pivot panel to grow, we should ignore this change
-      return nextLayout;
-    } else {
-      delta = delta < 0 ? initialSize - safeSize : safeSize - initialSize;
+    //DEBUG.push("");
+  }
+
+  {
+    // Pre-calculate max available delta in the opposite direction of our pivot.
+    // This will be the maximum amount we're allowed to expand/contract the panels in the primary direction.
+    // If this amount is less than the requested delta, adjust the requested delta.
+    // If this amount is greater than the requested delta, that's useful information too–
+    // as an expanding panel might change from collapsed to min size.
+
+    const increment = delta < 0 ? 1 : -1;
+    let index = delta < 0 ? pivotIndices[1] : pivotIndices[0];
+    let maxAvailableDelta = 0;
+
+    //DEBUG.push("pre calc...");
+    while (true) {
+      const prevSize = prevLayout[index];
+      const maxSafeSize = resizePanel({
+        groupSizePixels,
+        panelConstraints,
+        panelIndex: index,
+        size: 100
+      });
+      const delta = maxSafeSize - prevSize;
+      //DEBUG.push(`  ${index}: ${prevSize} -> ${maxSafeSize}`);
+
+      maxAvailableDelta += delta;
+      index += increment;
+      if (index < 0 || index >= panelConstraints.length) {
+        break;
+      }
     }
+
+    //DEBUG.push(`  -> max available delta: ${maxAvailableDelta}`);
+    const minAbsDelta = Math.min(Math.abs(delta), Math.abs(maxAvailableDelta));
+    delta = delta < 0 ? 0 - minAbsDelta : minAbsDelta;
+    //DEBUG.push(`  -> adjusted delta: ${delta}`);
+    //DEBUG.push("");
   }
 
-  // Delta added to a panel needs to be subtracted from other panels
-  // within the constraints that those panels allow
   {
+    // Delta added to a panel needs to be subtracted from other panels (within the constraints that those panels allow).
+
     const pivotIndex = delta < 0 ? pivotIndices[0] : pivotIndices[1];
     let index = pivotIndex;
     while (index >= 0 && index < panelConstraints.length) {
       const deltaRemaining = Math.abs(delta) - Math.abs(deltaApplied);
       const prevSize = prevLayout[index];
       const unsafeSize = prevSize - deltaRemaining;
-      let safeSize = resizePanel({
+      const safeSize = resizePanel({
         groupSizePixels,
         panelConstraints,
         panelIndex: index,
@@ -420,13 +491,18 @@ function adjustLayoutByDelta({
       }
     }
   }
+  //DEBUG.push(`after 1: ${nextLayout.join(", ")}`);
+  //DEBUG.push(`  deltaApplied: ${deltaApplied}`);
+  //DEBUG.push("");
 
   // If we were unable to resize any of the panels panels, return the previous state.
   // This will essentially bailout and ignore e.g. drags past a panel's boundaries
   if (fuzzyNumbersEqual(deltaApplied, 0)) {
+    //console.log(DEBUG.join("\n"));
     return prevLayout;
   }
   {
+    // Now distribute the applied delta to the panels in the other direction
     const pivotIndex = delta < 0 ? pivotIndices[1] : pivotIndices[0];
     const unsafeSize = prevLayout[pivotIndex] + deltaApplied;
     const safeSize = resizePanel({
@@ -466,29 +542,21 @@ function adjustLayoutByDelta({
           index++;
         }
       }
-
-      // If we can't redistribute, this layout is invalid;
-      // There may be an incremental layout that is valid though
-      if (!fuzzyNumbersEqual(deltaRemaining, 0)) {
-        try {
-          return adjustLayoutByDelta({
-            delta: delta < 0 ? delta + 1 : delta - 1,
-            groupSizePixels,
-            layout: prevLayout,
-            panelConstraints,
-            pivotIndices,
-            trigger
-          });
-        } catch (error) {
-          if (error instanceof RangeError) {
-            console.error(`Could not apply delta ${delta} to layout`);
-            return prevLayout;
-          }
-        } finally {
-        }
-      }
     }
   }
+  //DEBUG.push(`after 2: ${nextLayout.join(", ")}`);
+  //DEBUG.push(`  deltaApplied: ${deltaApplied}`);
+  //DEBUG.push("");
+
+  const totalSize = nextLayout.reduce((total, size) => size + total, 0);
+  deltaApplied = 100 - totalSize;
+  //DEBUG.push(`total size: ${totalSize}`);
+  //DEBUG.push(`  deltaApplied: ${deltaApplied}`);
+  //console.log(DEBUG.join("\n"));
+
+  if (!fuzzyNumbersEqual(totalSize, 100)) {
+    return prevLayout;
+  }
   return nextLayout;
 }
 
@@ -682,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");
@@ -710,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),
@@ -1185,6 +1246,7 @@ function PanelGroupWithForwardedRef({
   autoSaveId,
   children,
   className: classNameFromProps = "",
+  dataAttributes,
   direction,
   forwardedRef,
   id: idFromProps,
@@ -1202,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,
@@ -1310,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({
@@ -1389,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 {
@@ -1432,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 {
@@ -1627,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,
@@ -1684,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,
@@ -1717,6 +1843,7 @@ function PanelGroupWithForwardedRef({
       ...style,
       ...styleFromProps
     },
+    ...dataAttributes,
     // CSS selectors
     "data-panel-group": "",
     "data-panel-group-direction": direction,
@@ -1804,6 +1931,7 @@ function useWindowSplitterResizeHandlerBehavior({
 function PanelResizeHandle({
   children = null,
   className: classNameFromProps = "",
+  dataAttributes,
   disabled = false,
   id: idFromProps = null,
   onDragging,
@@ -1926,6 +2054,7 @@ function PanelResizeHandle({
       ...styleFromProps
     },
     tabIndex: 0,
+    ...dataAttributes,
     // CSS selectors
     "data-panel-group-direction": direction,
     "data-panel-group-id": groupId,