react-resizable-panels 4.3.2 → 4.4.0

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

@@ -23,7 +23,7 @@ declare type BaseSeparatorAttributes = Omit<HTMLAttributes<HTMLDivElement>, "rol
  *
  * ℹ️ [Test id](https://testing-library.com/docs/queries/bytestid/) can be used to narrow selection when unit testing.
  */
-export declare function Group({ children, className, defaultLayout, disableCursor, disabled, elementRef: elementRefProp, groupRef, id: idProp, onLayoutChange: onLayoutChangeUnstable, orientation, style, ...rest }: GroupProps): JSX.Element;
+export declare function Group({ children, className, defaultLayout, disableCursor, disabled, elementRef: elementRefProp, groupRef, id: idProp, onLayoutChange: onLayoutChangeUnstable, onLayoutChanged: onLayoutChangedUnstable, orientation, style, ...rest }: GroupProps): JSX.Element;
 
 export declare namespace Group {
     var displayName: string;
@@ -100,9 +100,19 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      */
     id?: string | number | undefined;
     /**
-     * Called when panel sizes change; receives a map of Panel id to size.
+     * Called when the Group's layout is changing.
+     *
+     * ⚠️ For layout changes caused by pointer events, this method is called each time the pointer is moved.
+     * For most cases, it is recommended to use the `onLayoutChanged` callback instead.
      */
     onLayoutChange?: (layout: Layout) => void | undefined;
+    /**
+     * Called after the Group's layout has  been changed.
+     *
+     * ℹ️ 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: Layout) => void | undefined;
     /**
      * Specifies the resizable orientation ("horizontal" or "vertical"); defaults to "horizontal"
      */
@@ -351,6 +361,8 @@ export declare type SizeUnit = "px" | "%" | "em" | "rem" | "vh" | "vw";
 export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ...rest }: {
     /**
      * Debounce save operation by the specified number of milliseconds; defaults to 100ms
+     *
+     * @deprecated Use the {@link onLayoutChanged} callback instead; it does not require debouncing
      */
     debounceSaveMs?: number;
     /**
@@ -379,8 +391,20 @@ export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ..
      */
     id: string;
 })): {
+    /**
+     * Pass this value to `Group` as the `defaultLayout` prop.
+     */
     defaultLayout: Layout | undefined;
+    /**
+     * Attach this callback on the `Group` as the `onLayoutChange` prop.
+     *
+     * @deprecated Use the {@link onLayoutChanged} prop instead.
+     */
     onLayoutChange: (layout: Layout) => void | undefined;
+    /**
+     * Attach this callback on the `Group` as the `onLayoutChanged` prop.
+     */
+    onLayoutChanged: (layout: Layout) => void | undefined;
 };
 
 /**