react-resizable-panels 1.0.7 → 1.0.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.8
+
+- Update component signature to declare `ReactElement` return type (rather than `ReactNode`) (#256)
+- Update `Panel` dev warning to avoid warning when `defaultSize === collapsedSize` for collapsible panels (#257)
+- Support shadow dom by removing direct references to / dependencies on the root `document` (#204)
+
 ## 1.0.7
 
 - Narrow `tagName` prop to only allow `HTMLElement` names (rather than the broader `Element` type) (#251)

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

@@ -1,4 +1,4 @@
-import { ForwardedRef, HTMLAttributes, PropsWithChildren, ReactNode } from "./vendor/react.js";
+import { ForwardedRef, HTMLAttributes, PropsWithChildren, ReactElement } from "./vendor/react.js";
 export type PanelOnCollapse = () => void;
 export type PanelOnExpand = () => void;
 export type PanelOnResize = (size: number, prevSize: number | undefined) => void;
@@ -47,7 +47,7 @@ export type PanelProps = Omit<HTMLAttributes<keyof HTMLElementTagNameMap>, "id"
 }>;
 export declare function PanelWithForwardedRef({ children, className: classNameFromProps, collapsedSize, collapsible, defaultSize, forwardedRef, id: idFromProps, maxSize, minSize, onCollapse, onExpand, onResize, order, style: styleFromProps, tagName: Type, ...rest }: PanelProps & {
     forwardedRef: ForwardedRef<ImperativePanelHandle>;
-}): ReactNode;
+}): ReactElement;
 export declare namespace PanelWithForwardedRef {
     var displayName: string;
 }
@@ -66,5 +66,5 @@ export declare const Panel: import("react").ForwardRefExoticComponent<Omit<HTMLA
     style?: object | undefined;
     tagName?: keyof HTMLElementTagNameMap | undefined;
 } & {
-    children?: ReactNode;
+    children?: import("react").ReactNode;
 } & import("react").RefAttributes<ImperativePanelHandle>>;

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

@@ -1,5 +1,5 @@
 import { Direction } from "./types.js";
-import { CSSProperties, HTMLAttributes, PropsWithChildren, ReactNode } from "./vendor/react.js";
+import { CSSProperties, HTMLAttributes, PropsWithChildren } from "./vendor/react.js";
 export type ImperativePanelGroupHandle = {
     getId: () => string;
     getLayout: () => number[];
@@ -32,5 +32,5 @@ export declare const PanelGroup: import("react").ForwardRefExoticComponent<Omit<
     style?: CSSProperties | undefined;
     tagName?: keyof HTMLElementTagNameMap | undefined;
 } & {
-    children?: ReactNode;
+    children?: import("react").ReactNode;
 } & import("react").RefAttributes<ImperativePanelGroupHandle>>;

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

@@ -1,4 +1,4 @@
-import { CSSProperties, HTMLAttributes, PropsWithChildren, ReactNode } from "./vendor/react.js";
+import { CSSProperties, HTMLAttributes, PropsWithChildren, ReactElement } from "./vendor/react.js";
 export type PanelResizeHandleOnDragging = (isDragging: boolean) => void;
 export type PanelResizeHandleProps = Omit<HTMLAttributes<keyof HTMLElementTagNameMap>, "id"> & PropsWithChildren<{
     className?: string;
@@ -9,7 +9,7 @@ export type PanelResizeHandleProps = Omit<HTMLAttributes<keyof HTMLElementTagNam
     tabIndex?: number;
     tagName?: keyof HTMLElementTagNameMap;
 }>;
-export declare function PanelResizeHandle({ children, className: classNameFromProps, disabled, id: idFromProps, onDragging, style: styleFromProps, tabIndex, tagName: Type, ...rest }: PanelResizeHandleProps): ReactNode;
+export declare function PanelResizeHandle({ children, className: classNameFromProps, disabled, id: idFromProps, onDragging, style: styleFromProps, tabIndex, tagName: Type, ...rest }: PanelResizeHandleProps): ReactElement;
 export declare namespace PanelResizeHandle {
     var displayName: string;
 }

package/dist/declarations/src/utils/dom/calculateAvailablePanelSizeInPixels.d.ts

@@ -1 +1 @@
-export declare function calculateAvailablePanelSizeInPixels(groupId: string): number;
+export declare function calculateAvailablePanelSizeInPixels(groupId: string, panelGroupElement: HTMLElement): number;

package/dist/declarations/src/utils/dom/getAvailableGroupSizePixels.d.ts

@@ -1 +1 @@
-export declare function getAvailableGroupSizePixels(groupId: string): number;
+export declare function getAvailableGroupSizePixels(groupId: string, panelGroupElement: HTMLElement): number;

package/dist/declarations/src/utils/dom/getPanelElement.d.ts

@@ -1 +1 @@
-export declare function getPanelElement(id: string): HTMLElement | null;
+export declare function getPanelElement(id: string, panelGroupElement: HTMLElement): HTMLElement | null;

package/dist/declarations/src/utils/dom/getPanelElementsForGroup.d.ts

@@ -1 +1 @@
-export declare function getPanelElementsForGroup(groupId: string): HTMLElement[];
+export declare function getPanelElementsForGroup(groupId: string, panelGroupElement: HTMLElement): HTMLElement[];

package/dist/declarations/src/utils/dom/getPanelGroupElement.d.ts

@@ -1 +1 @@
-export declare function getPanelGroupElement(id: string): HTMLElement | null;
+export declare function getPanelGroupElement(id: string, rootElement: ParentNode | HTMLElement): HTMLElement | null;

package/dist/declarations/src/utils/dom/getResizeHandleElement.d.ts

@@ -1 +1 @@
-export declare function getResizeHandleElement(id: string): HTMLElement | null;
+export declare function getResizeHandleElement(id: string, panelGroupElement: ParentNode): HTMLElement | null;

package/dist/declarations/src/utils/dom/getResizeHandleElementIndex.d.ts

@@ -1 +1 @@
-export declare function getResizeHandleElementIndex(groupId: string, id: string): number | null;
+export declare function getResizeHandleElementIndex(groupId: string, id: string, panelGroupElement: ParentNode): number | null;

package/dist/declarations/src/utils/dom/getResizeHandleElementsForGroup.d.ts

@@ -1 +1 @@
-export declare function getResizeHandleElementsForGroup(groupId: string): HTMLElement[];
+export declare function getResizeHandleElementsForGroup(groupId: string, panelGroupElement: ParentNode): HTMLElement[];

package/dist/declarations/src/utils/dom/getResizeHandlePanelIds.d.ts

@@ -1,2 +1,2 @@
 import { PanelData } from "../../Panel.js";
-export declare function getResizeHandlePanelIds(groupId: string, handleId: string, panelsArray: PanelData[]): [idBefore: string | null, idAfter: string | null];
+export declare function getResizeHandlePanelIds(groupId: string, handleId: string, panelsArray: PanelData[], panelGroupElement: ParentNode): [idBefore: string | null, idAfter: string | null];

package/dist/declarations/src/vendor/react.d.ts

@@ -1,6 +1,6 @@
 import * as React from "react";
-import type { CSSProperties, ElementType, ForwardedRef, HTMLAttributes, MouseEvent, PropsWithChildren, ReactNode, RefObject, TouchEvent } from "react";
+import type { CSSProperties, ElementType, ForwardedRef, HTMLAttributes, MouseEvent, PropsWithChildren, ReactElement, ReactNode, RefObject, TouchEvent } from "react";
 declare const createElement: typeof React.createElement, createContext: typeof React.createContext, createRef: typeof React.createRef, forwardRef: typeof React.forwardRef, useCallback: typeof React.useCallback, useContext: typeof React.useContext, useEffect: typeof React.useEffect, useImperativeHandle: typeof React.useImperativeHandle, useLayoutEffect: typeof React.useLayoutEffect, useMemo: typeof React.useMemo, useRef: typeof React.useRef, useState: typeof React.useState;
 declare const useId: () => string;
 export { createElement, createContext, createRef, forwardRef, useCallback, useContext, useEffect, useId, useImperativeHandle, useLayoutEffect, useMemo, useRef, useState, };
-export type { CSSProperties, ElementType, ForwardedRef, HTMLAttributes, MouseEvent, PropsWithChildren, ReactNode, RefObject, TouchEvent, };
+export type { CSSProperties, ElementType, ForwardedRef, HTMLAttributes, MouseEvent, PropsWithChildren, ReactElement, ReactNode, RefObject, TouchEvent, };

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

@@ -519,41 +519,48 @@ function calculateAriaValues({
   };
 }
 
-function getResizeHandleElementsForGroup(groupId) {
-  return Array.from(document.querySelectorAll(`[data-panel-resize-handle-id][data-panel-group-id="${groupId}"]`));
+function getResizeHandleElementsForGroup(groupId, panelGroupElement) {
+  return Array.from(panelGroupElement.querySelectorAll(`[data-panel-resize-handle-id][data-panel-group-id="${groupId}"]`));
 }
 
-function getResizeHandleElementIndex(groupId, id) {
-  const handles = getResizeHandleElementsForGroup(groupId);
+function getResizeHandleElementIndex(groupId, id, panelGroupElement) {
+  const handles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
   const index = handles.findIndex(handle => handle.getAttribute("data-panel-resize-handle-id") === id);
   return index !== null && index !== void 0 ? index : null;
 }
 
-function determinePivotIndices(groupId, dragHandleId) {
-  const index = getResizeHandleElementIndex(groupId, dragHandleId);
+function determinePivotIndices(groupId, dragHandleId, panelGroupElement) {
+  const index = getResizeHandleElementIndex(groupId, dragHandleId, panelGroupElement);
   return index != null ? [index, index + 1] : [-1, -1];
 }
 
-function getPanelGroupElement(id) {
-  const element = document.querySelector(`[data-panel-group][data-panel-group-id="${id}"]`);
+function getPanelGroupElement(id, rootElement) {
+  var _dataset;
+  //If the root element is the PanelGroup
+  if (rootElement instanceof HTMLElement && (rootElement === null || rootElement === void 0 ? void 0 : (_dataset = rootElement.dataset) === null || _dataset === void 0 ? void 0 : _dataset.panelGroupId) == id) {
+    return rootElement;
+  }
+
+  //Else query children
+  const element = rootElement.querySelector(`[data-panel-group][data-panel-group-id="${id}"]`);
   if (element) {
     return element;
   }
   return null;
 }
 
-function getResizeHandleElement(id) {
-  const element = document.querySelector(`[data-panel-resize-handle-id="${id}"]`);
+function getResizeHandleElement(id, panelGroupElement) {
+  const element = panelGroupElement.querySelector(`[data-panel-resize-handle-id="${id}"]`);
   if (element) {
     return element;
   }
   return null;
 }
 
-function getResizeHandlePanelIds(groupId, handleId, panelsArray) {
+function getResizeHandlePanelIds(groupId, handleId, panelsArray, panelGroupElement) {
   var _panelsArray$index$id, _panelsArray$index, _panelsArray$id, _panelsArray;
-  const handle = getResizeHandleElement(handleId);
-  const handles = getResizeHandleElementsForGroup(groupId);
+  const handle = getResizeHandleElement(handleId, panelGroupElement);
+  const handles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
   const index = handle ? handles.indexOf(handle) : -1;
   const idBefore = (_panelsArray$index$id = (_panelsArray$index = panelsArray[index]) === null || _panelsArray$index === void 0 ? void 0 : _panelsArray$index.id) !== null && _panelsArray$index$id !== void 0 ? _panelsArray$index$id : null;
   const idAfter = (_panelsArray$id = (_panelsArray = panelsArray[index + 1]) === null || _panelsArray === void 0 ? void 0 : _panelsArray.id) !== null && _panelsArray$id !== void 0 ? _panelsArray$id : null;
@@ -568,13 +575,17 @@ function useWindowSplitterPanelGroupBehavior({
   groupId,
   layout,
   panelDataArray,
+  panelGroupElement,
   setLayout
 }) {
   useRef({
     didWarnAboutMissingResizeHandle: false
   });
   useIsomorphicLayoutEffect(() => {
-    const resizeHandleElements = getResizeHandleElementsForGroup(groupId);
+    if (!panelGroupElement) {
+      return;
+    }
+    const resizeHandleElements = getResizeHandleElementsForGroup(groupId, panelGroupElement);
     for (let index = 0; index < panelDataArray.length - 1; index++) {
       const {
         valueMax,
@@ -603,21 +614,24 @@ function useWindowSplitterPanelGroupBehavior({
         resizeHandleElement.removeAttribute("aria-valuenow");
       });
     };
-  }, [groupId, layout, panelDataArray]);
+  }, [groupId, layout, panelDataArray, panelGroupElement]);
   useEffect(() => {
+    if (!panelGroupElement) {
+      return;
+    }
     const eagerValues = eagerValuesRef.current;
     assert(eagerValues);
     const {
       panelDataArray
     } = eagerValues;
-    const groupElement = getPanelGroupElement(groupId);
+    const groupElement = getPanelGroupElement(groupId, panelGroupElement);
     assert(groupElement != null, `No group found for id "${groupId}"`);
-    const handles = getResizeHandleElementsForGroup(groupId);
+    const handles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
     assert(handles);
     const cleanupFunctions = handles.map(handle => {
       const handleId = handle.getAttribute("data-panel-resize-handle-id");
       assert(handleId);
-      const [idBefore, idAfter] = getResizeHandlePanelIds(groupId, handleId, panelDataArray);
+      const [idBefore, idAfter] = getResizeHandlePanelIds(groupId, handleId, panelDataArray, panelGroupElement);
       if (idBefore == null || idAfter == null) {
         return () => {};
       }
@@ -644,7 +658,7 @@ function useWindowSplitterPanelGroupBehavior({
                     delta: fuzzyNumbersEqual(size, collapsedSize) ? minSize - collapsedSize : collapsedSize - size,
                     layout,
                     panelConstraints: panelDataArray.map(panelData => panelData.constraints),
-                    pivotIndices: determinePivotIndices(groupId, handleId),
+                    pivotIndices: determinePivotIndices(groupId, handleId, panelGroupElement),
                     trigger: "keyboard"
                   });
                   if (layout !== nextLayout) {
@@ -664,7 +678,7 @@ function useWindowSplitterPanelGroupBehavior({
     return () => {
       cleanupFunctions.forEach(cleanupFunction => cleanupFunction());
     };
-  }, [committedValuesRef, eagerValuesRef, groupId, layout, panelDataArray, setLayout]);
+  }, [panelGroupElement, committedValuesRef, eagerValuesRef, groupId, layout, panelDataArray, setLayout]);
 }
 
 function areEqual(arrayA, arrayB) {
@@ -702,9 +716,9 @@ function getResizeEventCursorPosition(direction, event) {
   }
 }
 
-function calculateDragOffsetPercentage(event, dragHandleId, direction, initialDragState) {
+function calculateDragOffsetPercentage(event, dragHandleId, direction, initialDragState, panelGroupElement) {
   const isHorizontal = direction === "horizontal";
-  const handleElement = getResizeHandleElement(dragHandleId);
+  const handleElement = getResizeHandleElement(dragHandleId, panelGroupElement);
   assert(handleElement);
   const groupId = handleElement.getAttribute("data-panel-group-id");
   assert(groupId);
@@ -712,7 +726,7 @@ function calculateDragOffsetPercentage(event, dragHandleId, direction, initialDr
     initialCursorPosition
   } = initialDragState;
   const cursorPosition = getResizeEventCursorPosition(direction, event);
-  const groupElement = getPanelGroupElement(groupId);
+  const groupElement = getPanelGroupElement(groupId, panelGroupElement);
   assert(groupElement);
   const groupRect = groupElement.getBoundingClientRect();
   const groupSizeInPixels = isHorizontal ? groupRect.width : groupRect.height;
@@ -722,7 +736,7 @@ function calculateDragOffsetPercentage(event, dragHandleId, direction, initialDr
 }
 
 // https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/movementX
-function calculateDeltaPercentage(event, dragHandleId, direction, initialDragState, keyboardResizeBy) {
+function calculateDeltaPercentage(event, dragHandleId, direction, initialDragState, keyboardResizeBy, panelGroupElement) {
   if (isKeyDown(event)) {
     const isHorizontal = direction === "horizontal";
     let delta = 0;
@@ -759,7 +773,7 @@ function calculateDeltaPercentage(event, dragHandleId, direction, initialDragSta
     if (initialDragState == null) {
       return 0;
     }
-    return calculateDragOffsetPercentage(event, dragHandleId, direction, initialDragState);
+    return calculateDragOffsetPercentage(event, dragHandleId, direction, initialDragState, panelGroupElement);
   }
 }
 
@@ -1111,6 +1125,7 @@ function PanelGroupWithForwardedRef({
   ...rest
 }) {
   const groupId = useUniqueId(idFromProps);
+  const panelGroupElementRef = useRef(null);
   const [dragState, setDragState] = useState(null);
   const [layout, setLayout] = useState([]);
   const panelIdToLastNotifiedSizeMapRef = useRef({});
@@ -1179,7 +1194,8 @@ function PanelGroupWithForwardedRef({
     groupId,
     layout,
     panelDataArray: eagerValuesRef.current.panelDataArray,
-    setLayout
+    setLayout,
+    panelGroupElement: panelGroupElementRef.current
   });
   useEffect(() => {
     const {
@@ -1422,6 +1438,10 @@ function PanelGroupWithForwardedRef({
   const registerResizeHandle = useCallback(dragHandleId => {
     return function resizeHandler(event) {
       event.preventDefault();
+      const panelGroupElement = panelGroupElementRef.current;
+      if (!panelGroupElement) {
+        return () => null;
+      }
       const {
         direction,
         dragState,
@@ -1436,8 +1456,8 @@ function PanelGroupWithForwardedRef({
       const {
         initialLayout
       } = dragState !== null && dragState !== void 0 ? dragState : {};
-      const pivotIndices = determinePivotIndices(groupId, dragHandleId);
-      let delta = calculateDeltaPercentage(event, dragHandleId, direction, dragState, keyboardResizeBy);
+      const pivotIndices = determinePivotIndices(groupId, dragHandleId, panelGroupElement);
+      let delta = calculateDeltaPercentage(event, dragHandleId, direction, dragState, keyboardResizeBy, panelGroupElement);
       if (delta === 0) {
         return;
       }
@@ -1532,7 +1552,10 @@ function PanelGroupWithForwardedRef({
     const {
       layout
     } = eagerValuesRef.current;
-    const handleElement = getResizeHandleElement(dragHandleId);
+    if (!panelGroupElementRef.current) {
+      return;
+    }
+    const handleElement = getResizeHandleElement(dragHandleId, panelGroupElementRef.current);
     assert(handleElement);
     const initialCursorPosition = getResizeEventCursorPosition(direction, event);
     setDragState({
@@ -1577,7 +1600,8 @@ function PanelGroupWithForwardedRef({
     resizePanel,
     startDragging,
     stopDragging,
-    unregisterPanel
+    unregisterPanel,
+    panelGroupElement: panelGroupElementRef.current
   }), [collapsePanel, dragState, direction, expandPanel, getPanelSize, getPanelStyle, groupId, isPanelCollapsed, isPanelExpanded, registerPanel, registerResizeHandle, resizePanel, startDragging, stopDragging, unregisterPanel]);
   const style = {
     display: "flex",
@@ -1596,6 +1620,7 @@ function PanelGroupWithForwardedRef({
       ...style,
       ...styleFromProps
     },
+    ref: panelGroupElementRef,
     // CSS selectors
     "data-panel-group": "",
     "data-panel-group-direction": direction,
@@ -1630,13 +1655,14 @@ function panelDataHelper(panelDataArray, panelData, layout) {
 function useWindowSplitterResizeHandlerBehavior({
   disabled,
   handleId,
-  resizeHandler
+  resizeHandler,
+  panelGroupElement
 }) {
   useEffect(() => {
-    if (disabled || resizeHandler == null) {
+    if (disabled || resizeHandler == null || panelGroupElement == null) {
       return;
     }
-    const handleElement = getResizeHandleElement(handleId);
+    const handleElement = getResizeHandleElement(handleId, panelGroupElement);
     if (handleElement == null) {
       return;
     }
@@ -1661,8 +1687,8 @@ function useWindowSplitterResizeHandlerBehavior({
             event.preventDefault();
             const groupId = handleElement.getAttribute("data-panel-group-id");
             assert(groupId);
-            const handles = getResizeHandleElementsForGroup(groupId);
-            const index = getResizeHandleElementIndex(groupId, handleId);
+            const handles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
+            const index = getResizeHandleElementIndex(groupId, handleId, panelGroupElement);
             assert(index !== null);
             const nextIndex = event.shiftKey ? index > 0 ? index - 1 : handles.length - 1 : index + 1 < handles.length ? index + 1 : 0;
             const nextHandle = handles[nextIndex];
@@ -1675,7 +1701,7 @@ function useWindowSplitterResizeHandlerBehavior({
     return () => {
       handleElement.removeEventListener("keydown", onKeyDown);
     };
-  }, [disabled, handleId, resizeHandler]);
+  }, [panelGroupElement, disabled, handleId, resizeHandler]);
 }
 
 function PanelResizeHandle({
@@ -1708,7 +1734,8 @@ function PanelResizeHandle({
     groupId,
     registerResizeHandle,
     startDragging,
-    stopDragging
+    stopDragging,
+    panelGroupElement
   } = panelGroupContext;
   const resizeHandleId = useUniqueId(idFromProps);
   const isDragging = (dragState === null || dragState === void 0 ? void 0 : dragState.dragHandleId) === resizeHandleId;
@@ -1767,7 +1794,8 @@ function PanelResizeHandle({
   useWindowSplitterResizeHandlerBehavior({
     disabled,
     handleId: resizeHandleId,
-    resizeHandler
+    resizeHandler,
+    panelGroupElement
   });
   const style = {
     cursor: getCursorStyle(direction),
@@ -1823,13 +1851,12 @@ function PanelResizeHandle({
 }
 PanelResizeHandle.displayName = "PanelResizeHandle";
 
-function calculateAvailablePanelSizeInPixels(groupId) {
-  const panelGroupElement = getPanelGroupElement(groupId);
+function calculateAvailablePanelSizeInPixels(groupId, panelGroupElement) {
   if (panelGroupElement == null) {
     return NaN;
   }
   const direction = panelGroupElement.getAttribute("data-panel-group-direction");
-  const resizeHandles = getResizeHandleElementsForGroup(groupId);
+  const resizeHandles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
   if (direction === "horizontal") {
     return panelGroupElement.offsetWidth - resizeHandles.reduce((accumulated, handle) => {
       return accumulated + handle.offsetWidth;
@@ -1841,13 +1868,9 @@ function calculateAvailablePanelSizeInPixels(groupId) {
   }
 }
 
-function getAvailableGroupSizePixels(groupId) {
-  const panelGroupElement = getPanelGroupElement(groupId);
-  if (panelGroupElement == null) {
-    return NaN;
-  }
+function getAvailableGroupSizePixels(groupId, panelGroupElement) {
   const direction = panelGroupElement.getAttribute("data-panel-group-direction");
-  const resizeHandles = getResizeHandleElementsForGroup(groupId);
+  const resizeHandles = getResizeHandleElementsForGroup(groupId, panelGroupElement);
   if (direction === "horizontal") {
     return panelGroupElement.offsetWidth - resizeHandles.reduce((accumulated, handle) => {
       return accumulated + handle.offsetWidth;
@@ -1859,16 +1882,16 @@ function getAvailableGroupSizePixels(groupId) {
   }
 }
 
-function getPanelElement(id) {
-  const element = document.querySelector(`[data-panel-id="${id}"]`);
+function getPanelElement(id, panelGroupElement) {
+  const element = panelGroupElement.querySelector(`[data-panel-id="${id}"]`);
   if (element) {
     return element;
   }
   return null;
 }
 
-function getPanelElementsForGroup(groupId) {
-  return Array.from(document.querySelectorAll(`[data-panel][data-panel-group-id="${groupId}"]`));
+function getPanelElementsForGroup(groupId, panelGroupElement) {
+  return Array.from(panelGroupElement.querySelectorAll(`[data-panel][data-panel-group-id="${groupId}"]`));
 }
 
 exports.Panel = Panel;