react-resizable-panels 1.0.0-rc.3 → 1.0.0

package/CHANGELOG.md

@@ -1,8 +1,8 @@
 # Changelog
 
-## 1.0.0-rc.1
+## 1.0.0
 
-- Remove support for pixel-based Panel constraints; props like `defaultSizePercentage` should now be `defaultSize`
+- Remove support for pixel-based Panel constraints; (props like `defaultSizePercentage` should now be `defaultSize`)
 - Replaced `dataAttributes` prop with `...rest` prop that supports all HTML attributes
 
 ## 0.0.63

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

@@ -937,10 +937,6 @@ function debounce(callback, durationMs = 10) {
   return callable;
 }
 
-function getPanelElementsForGroup(groupId) {
-  return Array.from(document.querySelectorAll(`[data-panel][data-panel-group-id="${groupId}"]`));
-}
-
 // PanelGroup might be rendering in a server-side environment where localStorage is not available
 // or on a browser with cookies/storage disabled.
 // In either case, this function avoids accessing localStorage until needed,
@@ -1107,6 +1103,7 @@ function PanelGroupWithForwardedRef({
   const groupId = useUniqueId(idFromProps);
   const [dragState, setDragState] = useState(null);
   const [layout, setLayout] = useState([]);
+  useState([]);
   const panelIdToLastNotifiedSizeMapRef = useRef({});
   const panelSizeBeforeCollapseRef = useRef(new Map());
   const prevDeltaRef = useRef(0);
@@ -1121,7 +1118,8 @@ function PanelGroupWithForwardedRef({
   });
   const eagerValuesRef = useRef({
     layout,
-    panelDataArray: []
+    panelDataArray: [],
+    panelDataArrayChanged: false
   });
   useRef({
     didLogIdAndOrderWarning: false,
@@ -1340,28 +1338,8 @@ function PanelGroupWithForwardedRef({
   }, []);
   const registerPanel = useCallback(panelData => {
     const {
-      autoSaveId,
-      id: groupId,
-      onLayout,
-      storage
-    } = committedValuesRef.current;
-    const {
-      layout: prevLayout,
       panelDataArray
     } = eagerValuesRef.current;
-
-    // HACK
-    // This appears to be triggered by some React Suspense+Offscreen+StrictMode bug;
-    // see app.replay.io/recording/17b6e11d-4500-4173-b23d-61dfd141fed1
-    const index = findPanelDataIndex(panelDataArray, panelData);
-    if (index >= 0) {
-      if (panelData.idIsFromProps) {
-        console.warn(`Panel with id "${panelData.id}" registered twice`);
-      } else {
-        console.warn(`Panel registered twice`);
-      }
-      return;
-    }
     panelDataArray.push(panelData);
     panelDataArray.sort((panelA, panelB) => {
       const orderA = panelA.order;
@@ -1376,45 +1354,52 @@ function PanelGroupWithForwardedRef({
         return orderA - orderB;
       }
     });
+    eagerValuesRef.current.panelDataArrayChanged = true;
+  }, []);
 
-    // Wait until all panels have registered before we try to compute layout;
-    // doing it earlier is both wasteful and may trigger misleading warnings in development mode.
-    const panelElements = getPanelElementsForGroup(groupId);
-    if (panelElements.length !== panelDataArray.length) {
-      return;
-    }
-
-    // If this panel has been configured to persist sizing information,
-    // default size should be restored from local storage if possible.
-    let unsafeLayout = null;
-    if (autoSaveId) {
-      unsafeLayout = loadPanelLayout(autoSaveId, panelDataArray, storage);
-    }
-    if (unsafeLayout == null) {
-      unsafeLayout = calculateUnsafeDefaultLayout({
+  // (Re)calculate group layout whenever panels are registered or unregistered.
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  useIsomorphicLayoutEffect(() => {
+    if (eagerValuesRef.current.panelDataArrayChanged) {
+      eagerValuesRef.current.panelDataArrayChanged = false;
+      const {
+        autoSaveId,
+        onLayout,
+        storage
+      } = committedValuesRef.current;
+      const {
+        layout: prevLayout,
         panelDataArray
-      });
-    }
+      } = eagerValuesRef.current;
 
-    // Validate even saved layouts in case something has changed since last render
-    // e.g. for pixel groups, this could be the size of the window
-    const nextLayout = validatePanelGroupLayout({
-      layout: unsafeLayout,
-      panelConstraints: panelDataArray.map(panelData => panelData.constraints)
-    });
+      // If this panel has been configured to persist sizing information,
+      // default size should be restored from local storage if possible.
+      let unsafeLayout = null;
+      if (autoSaveId) {
+        unsafeLayout = loadPanelLayout(autoSaveId, panelDataArray, storage);
+      }
+      if (unsafeLayout == null) {
+        unsafeLayout = calculateUnsafeDefaultLayout({
+          panelDataArray
+        });
+      }
 
-    // Offscreen mode makes this a bit weird;
-    // Panels unregister when hidden and re-register when shown again,
-    // but the overall layout doesn't change between these two cases.
-    setLayout(nextLayout);
-    eagerValuesRef.current.layout = nextLayout;
-    if (!areEqual(prevLayout, nextLayout)) {
-      if (onLayout) {
-        onLayout(nextLayout);
+      // Validate even saved layouts in case something has changed since last render
+      // e.g. for pixel groups, this could be the size of the window
+      const nextLayout = validatePanelGroupLayout({
+        layout: unsafeLayout,
+        panelConstraints: panelDataArray.map(panelData => panelData.constraints)
+      });
+      if (!areEqual(prevLayout, nextLayout)) {
+        setLayout(nextLayout);
+        eagerValuesRef.current.layout = nextLayout;
+        if (onLayout) {
+          onLayout(nextLayout);
+        }
+        callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
       }
-      callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
     }
-  }, []);
+  });
   const registerResizeHandle = useCallback(dragHandleId => {
     return function resizeHandler(event) {
       event.preventDefault();
@@ -1542,79 +1527,21 @@ function PanelGroupWithForwardedRef({
     resetGlobalCursorStyle();
     setDragState(null);
   }, []);
-  const unregisterPanelRef = useRef({
-    pendingPanelIds: new Set(),
-    timeout: null
-  });
   const unregisterPanel = useCallback(panelData => {
     const {
-      onLayout
-    } = committedValuesRef.current;
-    const {
-      layout: prevLayout,
       panelDataArray
     } = eagerValuesRef.current;
     const index = findPanelDataIndex(panelDataArray, panelData);
     if (index >= 0) {
       panelDataArray.splice(index, 1);
-      unregisterPanelRef.current.pendingPanelIds.add(panelData.id);
-    }
-    if (unregisterPanelRef.current.timeout != null) {
-      clearTimeout(unregisterPanelRef.current.timeout);
-    }
-
-    // Batch panel unmounts so that we only calculate layout once;
-    // This is more efficient and avoids misleading warnings in development mode.
-    // We can't check the DOM to detect this because Panel elements have not yet been removed.
-    unregisterPanelRef.current.timeout = setTimeout(() => {
-      const {
-        pendingPanelIds
-      } = unregisterPanelRef.current;
-      const panelIdToLastNotifiedSizeMap = panelIdToLastNotifiedSizeMapRef.current;
 
       // TRICKY
-      // Strict effects mode
-      let unmountDueToStrictMode = false;
-      pendingPanelIds.forEach(panelId => {
-        pendingPanelIds.delete(panelId);
-        if (panelDataArray.find(({
-          id
-        }) => id === panelId) != null) {
-          unmountDueToStrictMode = true;
-        } else {
-          // TRICKY
-          // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
-          // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
-          // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
-          delete panelIdToLastNotifiedSizeMap[panelId];
-        }
-      });
-      if (unmountDueToStrictMode) {
-        return;
-      }
-      if (panelDataArray.length === 0) {
-        // The group is unmounting; skip layout calculation.
-        return;
-      }
-      let unsafeLayout = calculateUnsafeDefaultLayout({
-        panelDataArray
-      });
-
-      // Validate even saved layouts in case something has changed since last render
-      // e.g. for pixel groups, this could be the size of the window
-      const nextLayout = validatePanelGroupLayout({
-        layout: unsafeLayout,
-        panelConstraints: panelDataArray.map(panelData => panelData.constraints)
-      });
-      if (!areEqual(prevLayout, nextLayout)) {
-        setLayout(nextLayout);
-        eagerValuesRef.current.layout = nextLayout;
-        if (onLayout) {
-          onLayout(nextLayout);
-        }
-        callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
-      }
-    }, 0);
+      // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
+      // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
+      // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
+      delete panelIdToLastNotifiedSizeMapRef.current[panelData.id];
+      eagerValuesRef.current.panelDataArrayChanged = true;
+    }
   }, []);
   const context = useMemo(() => ({
     collapsePanel,

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

@@ -953,10 +953,6 @@ function debounce(callback, durationMs = 10) {
   return callable;
 }
 
-function getPanelElementsForGroup(groupId) {
-  return Array.from(document.querySelectorAll(`[data-panel][data-panel-group-id="${groupId}"]`));
-}
-
 // PanelGroup might be rendering in a server-side environment where localStorage is not available
 // or on a browser with cookies/storage disabled.
 // In either case, this function avoids accessing localStorage until needed,
@@ -1170,6 +1166,7 @@ function PanelGroupWithForwardedRef({
   const groupId = useUniqueId(idFromProps);
   const [dragState, setDragState] = useState(null);
   const [layout, setLayout] = useState([]);
+  useState([]);
   const panelIdToLastNotifiedSizeMapRef = useRef({});
   const panelSizeBeforeCollapseRef = useRef(new Map());
   const prevDeltaRef = useRef(0);
@@ -1184,7 +1181,8 @@ function PanelGroupWithForwardedRef({
   });
   const eagerValuesRef = useRef({
     layout,
-    panelDataArray: []
+    panelDataArray: [],
+    panelDataArrayChanged: false
   });
   const devWarningsRef = useRef({
     didLogIdAndOrderWarning: false,
@@ -1445,28 +1443,8 @@ function PanelGroupWithForwardedRef({
   }, []);
   const registerPanel = useCallback(panelData => {
     const {
-      autoSaveId,
-      id: groupId,
-      onLayout,
-      storage
-    } = committedValuesRef.current;
-    const {
-      layout: prevLayout,
       panelDataArray
     } = eagerValuesRef.current;
-
-    // HACK
-    // This appears to be triggered by some React Suspense+Offscreen+StrictMode bug;
-    // see app.replay.io/recording/17b6e11d-4500-4173-b23d-61dfd141fed1
-    const index = findPanelDataIndex(panelDataArray, panelData);
-    if (index >= 0) {
-      if (panelData.idIsFromProps) {
-        console.warn(`Panel with id "${panelData.id}" registered twice`);
-      } else {
-        console.warn(`Panel registered twice`);
-      }
-      return;
-    }
     panelDataArray.push(panelData);
     panelDataArray.sort((panelA, panelB) => {
       const orderA = panelA.order;
@@ -1481,45 +1459,52 @@ function PanelGroupWithForwardedRef({
         return orderA - orderB;
       }
     });
+    eagerValuesRef.current.panelDataArrayChanged = true;
+  }, []);
 
-    // Wait until all panels have registered before we try to compute layout;
-    // doing it earlier is both wasteful and may trigger misleading warnings in development mode.
-    const panelElements = getPanelElementsForGroup(groupId);
-    if (panelElements.length !== panelDataArray.length) {
-      return;
-    }
-
-    // If this panel has been configured to persist sizing information,
-    // default size should be restored from local storage if possible.
-    let unsafeLayout = null;
-    if (autoSaveId) {
-      unsafeLayout = loadPanelLayout(autoSaveId, panelDataArray, storage);
-    }
-    if (unsafeLayout == null) {
-      unsafeLayout = calculateUnsafeDefaultLayout({
+  // (Re)calculate group layout whenever panels are registered or unregistered.
+  // eslint-disable-next-line react-hooks/exhaustive-deps
+  useIsomorphicLayoutEffect(() => {
+    if (eagerValuesRef.current.panelDataArrayChanged) {
+      eagerValuesRef.current.panelDataArrayChanged = false;
+      const {
+        autoSaveId,
+        onLayout,
+        storage
+      } = committedValuesRef.current;
+      const {
+        layout: prevLayout,
         panelDataArray
-      });
-    }
+      } = eagerValuesRef.current;
 
-    // Validate even saved layouts in case something has changed since last render
-    // e.g. for pixel groups, this could be the size of the window
-    const nextLayout = validatePanelGroupLayout({
-      layout: unsafeLayout,
-      panelConstraints: panelDataArray.map(panelData => panelData.constraints)
-    });
+      // If this panel has been configured to persist sizing information,
+      // default size should be restored from local storage if possible.
+      let unsafeLayout = null;
+      if (autoSaveId) {
+        unsafeLayout = loadPanelLayout(autoSaveId, panelDataArray, storage);
+      }
+      if (unsafeLayout == null) {
+        unsafeLayout = calculateUnsafeDefaultLayout({
+          panelDataArray
+        });
+      }
 
-    // Offscreen mode makes this a bit weird;
-    // Panels unregister when hidden and re-register when shown again,
-    // but the overall layout doesn't change between these two cases.
-    setLayout(nextLayout);
-    eagerValuesRef.current.layout = nextLayout;
-    if (!areEqual(prevLayout, nextLayout)) {
-      if (onLayout) {
-        onLayout(nextLayout);
+      // Validate even saved layouts in case something has changed since last render
+      // e.g. for pixel groups, this could be the size of the window
+      const nextLayout = validatePanelGroupLayout({
+        layout: unsafeLayout,
+        panelConstraints: panelDataArray.map(panelData => panelData.constraints)
+      });
+      if (!areEqual(prevLayout, nextLayout)) {
+        setLayout(nextLayout);
+        eagerValuesRef.current.layout = nextLayout;
+        if (onLayout) {
+          onLayout(nextLayout);
+        }
+        callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
       }
-      callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
     }
-  }, []);
+  });
   const registerResizeHandle = useCallback(dragHandleId => {
     return function resizeHandler(event) {
       event.preventDefault();
@@ -1647,79 +1632,21 @@ function PanelGroupWithForwardedRef({
     resetGlobalCursorStyle();
     setDragState(null);
   }, []);
-  const unregisterPanelRef = useRef({
-    pendingPanelIds: new Set(),
-    timeout: null
-  });
   const unregisterPanel = useCallback(panelData => {
     const {
-      onLayout
-    } = committedValuesRef.current;
-    const {
-      layout: prevLayout,
       panelDataArray
     } = eagerValuesRef.current;
     const index = findPanelDataIndex(panelDataArray, panelData);
     if (index >= 0) {
       panelDataArray.splice(index, 1);
-      unregisterPanelRef.current.pendingPanelIds.add(panelData.id);
-    }
-    if (unregisterPanelRef.current.timeout != null) {
-      clearTimeout(unregisterPanelRef.current.timeout);
-    }
-
-    // Batch panel unmounts so that we only calculate layout once;
-    // This is more efficient and avoids misleading warnings in development mode.
-    // We can't check the DOM to detect this because Panel elements have not yet been removed.
-    unregisterPanelRef.current.timeout = setTimeout(() => {
-      const {
-        pendingPanelIds
-      } = unregisterPanelRef.current;
-      const panelIdToLastNotifiedSizeMap = panelIdToLastNotifiedSizeMapRef.current;
 
       // TRICKY
-      // Strict effects mode
-      let unmountDueToStrictMode = false;
-      pendingPanelIds.forEach(panelId => {
-        pendingPanelIds.delete(panelId);
-        if (panelDataArray.find(({
-          id
-        }) => id === panelId) != null) {
-          unmountDueToStrictMode = true;
-        } else {
-          // TRICKY
-          // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
-          // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
-          // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
-          delete panelIdToLastNotifiedSizeMap[panelId];
-        }
-      });
-      if (unmountDueToStrictMode) {
-        return;
-      }
-      if (panelDataArray.length === 0) {
-        // The group is unmounting; skip layout calculation.
-        return;
-      }
-      let unsafeLayout = calculateUnsafeDefaultLayout({
-        panelDataArray
-      });
-
-      // Validate even saved layouts in case something has changed since last render
-      // e.g. for pixel groups, this could be the size of the window
-      const nextLayout = validatePanelGroupLayout({
-        layout: unsafeLayout,
-        panelConstraints: panelDataArray.map(panelData => panelData.constraints)
-      });
-      if (!areEqual(prevLayout, nextLayout)) {
-        setLayout(nextLayout);
-        eagerValuesRef.current.layout = nextLayout;
-        if (onLayout) {
-          onLayout(nextLayout);
-        }
-        callPanelCallbacks(panelDataArray, nextLayout, panelIdToLastNotifiedSizeMapRef.current);
-      }
-    }, 0);
+      // When a panel is removed from the group, we should delete the most recent prev-size entry for it.
+      // If we don't do this, then a conditionally rendered panel might not call onResize when it's re-mounted.
+      // Strict effects mode makes this tricky though because all panels will be registered, unregistered, then re-registered on mount.
+      delete panelIdToLastNotifiedSizeMapRef.current[panelData.id];
+      eagerValuesRef.current.panelDataArrayChanged = true;
+    }
   }, []);
   const context = useMemo(() => ({
     collapsePanel,