react-resizable-panels 4.2.1 → 4.2.2-issue-572

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

@@ -7,7 +7,9 @@ import { Ref } from 'react';
 import { RefObject } from 'react';
 import { SetStateAction } from 'react';
 
-declare type BaseAttributes = Omit<HTMLAttributes<HTMLDivElement>, "role" | "tabIndex">;
+declare type BasePanelAttributes = Omit<HTMLAttributes<HTMLDivElement>, "onResize">;
+
+declare type BaseSeparatorAttributes = Omit<HTMLAttributes<HTMLDivElement>, "role" | "tabIndex">;
 
 /**
  * A Group wraps a set of resizable Panel components.
@@ -213,7 +215,7 @@ export declare interface PanelImperativeHandle {
     resize: (size: number | string) => void;
 }
 
-export declare type PanelProps = HTMLAttributes<HTMLDivElement> & {
+export declare type PanelProps = BasePanelAttributes & {
     /**
      * CSS class name.
      *
@@ -308,7 +310,7 @@ export declare namespace Separator {
     var displayName: string;
 }
 
-export declare type SeparatorProps = BaseAttributes & {
+export declare type SeparatorProps = BaseSeparatorAttributes & {
     /**
      * CSS class name.
      *
@@ -340,6 +342,10 @@ export declare type SeparatorProps = BaseAttributes & {
 
 export declare type SizeUnit = "px" | "%" | "em" | "rem" | "vh" | "vw";
 
+/**
+ * Saves and restores group layouts between page loads.
+ * It can be configured to store values using `localStorage`, `sessionStorage`, cookies, or any other persistence layer that makes sense for your application.
+ */
 export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ...rest }: {
     /**
      * Debounce save operation by the specified number of milliseconds; defaults to 100ms
@@ -348,14 +354,17 @@ export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ..
     /**
      * For Groups that contain conditionally-rendered Panels, this prop can be used to save and restore multiple layouts.
      *
+     * ℹ️ This prevents layout shift for server-rendered apps.
+     *
      * ⚠️ Panel ids must match the Panels rendered within the Group during mount or the initial layout will be incorrect.
      */
     panelIds?: string[] | undefined;
     /**
      * Storage implementation; supports localStorage, sessionStorage, and custom implementations
      * Refer to documentation site for example integrations.
+     *
      */
-    storage: LayoutStorage;
+    storage?: LayoutStorage;
 } & ({
     /**
      * Group id; must be unique in order for layouts to be saved separately.
@@ -364,7 +373,7 @@ export declare function useDefaultLayout({ debounceSaveMs, panelIds, storage, ..
     groupId: string;
 } | {
     /**
-     * Unique layout identifier.
+     * Uniquely identifies a specific group/layout.
      */
     id: string;
 })): {