react-resizable-panels 4.14.3 → 4.14.5

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

@@ -86,7 +86,7 @@ export declare type CellProps = HTMLAttributes<HTMLDivElement> & {
      * Uniquely identifies this cell within the parent grid.
      * Falls back to `useId` when not provided.
      *
-     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes.
+     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes; (an explicit `data-testid` prop will take precedence).
      */
     id?: string | number | undefined;
     /**
@@ -357,7 +357,7 @@ export declare type GridProps = HTMLAttributes<HTMLDivElement> & {
      * Uniquely identifies this grid within an application.
      * Falls back to `useId` when not provided.
      *
-     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes.
+     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes; (an explicit `data-testid` prop will take precedence).
      */
     id?: string | number | undefined;
     /**
@@ -375,7 +375,7 @@ export declare type GridProps = HTMLAttributes<HTMLDivElement> & {
      */
     onLayoutChanged?: ((layout: GridLayout, meta: LayoutChangedMeta<GridLayout>) => void) | undefined;
     /**
-     * Minimum size of the resizable hit target area (either a `Gridline` or a `Cell` edge)
+     * 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.
      *
      * ℹ️ Refer to the `Group` prop of the same name for more information.
@@ -543,7 +543,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
     /**
      * Exposes the following imperative API:
      * - `getLayout(): Layout`
-     * - `setLayout(layout: Layout): void`
+     * - `setLayout(layout: Layout): Layout`
      *
      * ℹ️ The `useGroupRef` and `useGroupCallbackRef` hooks are exported for convenience use in TypeScript projects.
      */
@@ -552,7 +552,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      * Uniquely identifies this group within an application.
      * Falls back to `useId` when not provided.
      *
-     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes.
+     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes; (an explicit `data-testid` prop will take precedence).
      */
     id?: string | number | undefined;
     /**
@@ -563,7 +563,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      */
     onLayoutChange?: (layout: Layout) => void | undefined;
     /**
-     * Called after the Group's layout has  been changed.
+     * 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.
@@ -577,7 +577,7 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      */
     onLayoutChanged?: (layout: Layout, meta: LayoutChangedMeta) => void;
     /**
-     * Controls whether pointer dragging updates `Panel`s sizes immediately,
+     * Controls whether pointer dragging updates `Panel` sizes immediately,
      * or renders overlay separator previews until the pointer is released.
      *
      * Defaults to `"panel"` (immediate resizing); `"separator"` defers resizing until release.
@@ -586,14 +586,14 @@ export declare type GroupProps = HTMLAttributes<HTMLDivElement> & {
      */
     resizePreviewMode?: ResizePreviewMode | undefined;
     /**
-     * Minimum size of the resizable hit target area (either `Separator` or `Panel` edge)
-     * This threshold ensures are large enough to avoid mis-clicks.
+     * Minimum size of the resizable hit target area (either `Separator` or `Panel` edge).
+     * This threshold ensures targets are large enough to avoid mis-clicks.
      *
      * - Coarse inputs (typically a finger on a touchscreen) have reduced accuracy;
      * to ensure accessibility and ease of use, hit targets should be larger to prevent mis-clicks.
      * - Fine inputs (typically a mouse) can be smaller
      *
-     * ℹ️ [Apple interface guidelines](https://developer.apple.com/design/human-interface-guidelines/accessibility) suggest `20pt` (`27px`) on desktops and `28pt` (`37px`) for touch devices
+     * ℹ️ [Apple interface guidelines](https://developer.apple.com/design/human-interface-guidelines/accessibility) suggest `20pt` (`27px`) on desktops and `28pt` (`37px`) for touch devices.
      * In practice this seems to be much larger than many of their own applications use though.
      */
     resizeTargetMinimumSize?: {
@@ -724,7 +724,7 @@ declare type PanelConstraintProps = Pick<PanelProps, "collapsedSize" | "collapse
  */
 export declare interface PanelImperativeHandle {
     /**
-     * Collapse the Panel to it's `collapsedSize`.
+     * Collapse the Panel to its `collapsedSize`.
      *
      * ⚠️ This method will do nothing if the Panel is not `collapsible` or if it is already collapsed.
      */
@@ -764,7 +764,6 @@ export declare interface PanelImperativeHandle {
      * Other units should be specified as strings ending with their CSS property units (e.g. 1rem, 50vh)
      *
      * @param size New panel size
-     * @return Applied size (after validation)
      */
     resize: (size: number | string) => void;
 }
@@ -786,7 +785,7 @@ export declare type PanelProps = BasePanelAttributes & {
      * Defaults to half the distance between `collapsedSize` and `minSize`.
      *
      * For example if a panel declares `collapsedSize="5%"`, `collapsedThreshold="5%"`, and `minSize="25%"`,
-     * it will collapse when resized below 20% and expands when resized above 10%.
+     * it will collapse when resized below 20% and expand when resized above 10%.
      *
      * ℹ️ Interpretation rules:
      * - Numbers are interpreted as pixels (e.g. `minSize={200}` is 200 pixels)
@@ -797,7 +796,7 @@ export declare type PanelProps = BasePanelAttributes & {
     /**
      * This panel can be collapsed.
      *
-     * ℹ️ A collapsible panel will collapse when it's size is less than of the specified `minSize`
+     * ℹ️ A collapsible panel will collapse when its size is less than the specified `minSize`
      */
     collapsible?: boolean | undefined;
     /**
@@ -838,7 +837,7 @@ export declare type PanelProps = BasePanelAttributes & {
      *
      * ℹ️ This prop is used to associate persisted group layouts with the original panel.
      *
-     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes.
+     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes; (an explicit `data-testid` prop will take precedence).
      */
     id?: string | number | undefined;
     /**
@@ -871,9 +870,9 @@ export declare type PanelProps = BasePanelAttributes & {
      * Exposes the following imperative API:
      * - `collapse(): void`
      * - `expand(): void`
-     * - `getSize(): number`
+     * - `getSize(): PanelSize`
      * - `isCollapsed(): boolean`
-     * - `resize(size: number): void`
+     * - `resize(size: number | string): void`
      *
      * ℹ️ The `usePanelRef` and `usePanelCallbackRef` hooks are exported for convenience use in TypeScript projects.
      */
@@ -959,7 +958,7 @@ export declare type SeparatorProps = BaseSeparatorAttributes & {
      * Uniquely identifies the separator within the parent group.
      * Falls back to `useId` when not provided.
      *
-     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes.
+     * ℹ️ This value will also be assigned to the `id` and `data-testid` attributes; (an explicit `data-testid` prop will take precedence).
      */
     id?: string | number | undefined;
     /**