react-resizable-panels 4.14.8 → 4.15.0

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

@@ -412,6 +412,8 @@ export declare interface GridTrackImperativeHandle {
     /**
      * Expand a collapsed track to its most recent size.
      *
+     * ℹ️ If restoring that size would require collapsing another track, the track expands to the largest size that fits instead (as long as that is at least its `minSize`).
+     *
      * ⚠️ This method will do nothing if the track is not currently collapsed.
      */
     expand: () => void;
@@ -732,6 +734,8 @@ export declare interface PanelImperativeHandle {
     /**
      * Expand a collapsed Panel to its most recent size.
      *
+     * ℹ️ If restoring that size would require collapsing another Panel, the Panel expands to the largest size that fits instead (as long as that is at least its `minSize`).
+     *
      * ⚠️ This method will do nothing if the Panel is not currently collapsed.
      */
     expand: () => void;
@@ -890,6 +894,44 @@ export declare type PanelSize = {
     inPixels: number;
 };
 
+/**
+ * The nearest ancestor Grid (returned by `useParentGrid`), including its imperative API.
+ */
+export declare type ParentGrid = GridImperativeHandle & {
+    /**
+     * Id of the Grid.
+     */
+    id: string;
+};
+
+/**
+ * The nearest ancestor Group (returned by `useParentGroup`), including its imperative API.
+ */
+export declare type ParentGroup = GroupImperativeHandle & {
+    /**
+     * Id of the Group.
+     */
+    id: string;
+    /**
+     * Orientation of the Group.
+     */
+    orientation: Orientation;
+};
+
+/**
+ * The nearest ancestor Panel (returned by `useParentPanel`), including its imperative API.
+ */
+export declare type ParentPanel = PanelImperativeHandle & {
+    /**
+     * Id of the Group that contains the Panel.
+     */
+    groupId: string;
+    /**
+     * Id of the Panel.
+     */
+    id: string;
+};
+
 declare type ResizePreviewMode = "panel" | "separator";
 
 /**
@@ -1101,4 +1143,25 @@ export declare function usePanelCallbackRef(): [PanelImperativeHandle | null, Di
  */
 export declare function usePanelRef(): RefObject<PanelImperativeHandle | null>;
 
+/**
+ * Returns the nearest ancestor Grid (or null if the component is not rendered within a Grid).
+ *
+ * ℹ️ The returned value includes the Grid's imperative API; it does not change when the Grid's layout changes.
+ */
+export declare function useParentGrid(): ParentGrid | null;
+
+/**
+ * Returns the nearest ancestor Group (or null if the component is not rendered within a Group).
+ *
+ * ℹ️ The returned value includes the Group's imperative API; it does not change when the Group's layout changes.
+ */
+export declare function useParentGroup(): ParentGroup | null;
+
+/**
+ * Returns the nearest ancestor Panel (or null if the component is not rendered within a Panel).
+ *
+ * ℹ️ The returned value includes the Panel's imperative API; it does not change when the Panel is resized.
+ */
+export declare function useParentPanel(): ParentPanel | null;
+
 export { }