react-resizable-panels 4.14.0 → 4.14.2

package/dist/react-resizable-panels.d.ts

@@ -373,7 +373,7 @@ export declare type GridProps = HTMLAttributes<HTMLDivElement> & {
      * ℹ️ For layout changes caused by pointer events, this method is not called until the pointer has been released.
      * This method is recommended when saving layouts to some storage api.
      */
-    onLayoutChanged?: ((layout: GridLayout, meta: LayoutChangedMeta) => void) | undefined;
+    onLayoutChanged?: ((layout: GridLayout, meta: LayoutChangedMeta<GridLayout>) => void) | undefined;
     /**
      * Minimum size of the resizable hit target area (either a `Gridline` or a `Cell` edge)
      * This threshold ensures targets are large enough to avoid mis-clicks.
@@ -572,6 +572,8 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      * The `isUserInteraction` attribute signals whether the resize was caused by direct user input.
      * It is true for resizes caused by pointer or keyboard input
      * and false for other triggers (e.g. imperative API calls, initial mount, etc.)
+     * The `requestedLayout` attribute is the layout before constraints were applied for the current Group size;
+     * prefer it when persisting layouts.
      */
     onLayoutChanged?: (layout: Layout, meta: LayoutChangedMeta) => void;
     /**
@@ -623,19 +625,27 @@ export declare type Layout = {
 };
 
 /**
- * Metadata describing a completed layout change, passed as the second argument
- * to the `onLayoutChanged` callback. See #716.
+ * Metadata describing a completed layout change, passed as the second argument to the `onLayoutChanged` callback.
+ * See #716.
  */
-export declare type LayoutChangedMeta = {
+export declare type LayoutChangedMeta<RequestedLayout = Layout> = {
     /**
-     * `true` when the change was caused by the user directly manipulating a
-     * separator — releasing a pointer drag or pressing a resize key (arrow keys,
-     * Home/End, Enter). `false` for every other source (programmatic `setLayout`
-     * and other imperative API calls, constraint recompute, default-size change,
-     * initial mount), because the library cannot attribute the caller's intent
-     * there.
+     * `true` when the change was caused by the user directly manipulating a separator (keyboard or pointer)
+     * `false` for every other source (imperative API calls, constraint recompute, default-size change, initial mount),
+     * because the library cannot attribute the caller's intent there.
      */
     isUserInteraction: boolean;
+    /**
+     * Layout most recently requested by the user or application (e.g. pointer or keyboard input, imperative API, default layout)
+     * before constraints were applied for the current size.
+     *
+     * This will differ from the validated layout when constraints temporarily override the requested layout,
+     * e.g. a panel with a pixel-based `minSize` taking up a larger percentage of a small Group.
+     * The requested layout is restored if the Group grows back to a size where it satisfies all constraints.
+     *
+     * ℹ️ When saving layouts to storage, prefer this value to the validated layout.
+     */
+    requestedLayout?: RequestedLayout | undefined;
 };
 
 export declare type LayoutStorage = Pick<Storage, "getItem" | "setItem">;
@@ -995,7 +1005,7 @@ export declare function useDefaultGridLayout({ id, onlySaveAfterUserInteractions
     /**
      * Attach this callback on the `Grid` as the `onLayoutChanged` prop.
      */
-    onLayoutChanged: (layout: GridLayout, meta: LayoutChangedMeta) => void;
+    onLayoutChanged: (layout: GridLayout, meta: LayoutChangedMeta<GridLayout>) => void;
 };
 
 /**