@react-hive/honey-layout 9.15.0 → 10.0.0

package/dist/hooks/use-honey-synthetic-scroll-x.d.ts

@@ -1,2 +1,19 @@
 import type { UseHoneySyntheticScrollOptions } from './use-honey-synthetic-scroll';
+/**
+ * Enables synthetic horizontal (X-axis) scrolling for a container element
+ * using pointer-based drag interactions.
+ *
+ * This is a convenience wrapper around {@link useHoneySyntheticScroll} with
+ * the axis fixed to `'x'`.
+ *
+ * All behavior, boundaries, and lifecycle guarantees are identical to the
+ * base hook, but limited to horizontal movement only.
+ *
+ * @template Element - The HTML element type of the scrollable container.
+ *
+ * @param options - Configuration options forwarded to
+ * {@link useHoneySyntheticScroll}, excluding the `axis` option.
+ *
+ * @returns A ref that must be attached to the scrollable container element.
+ */
 export declare const useHoneySyntheticScrollX: <Element extends HTMLElement>(options?: Omit<UseHoneySyntheticScrollOptions<Element>, "axis">) => import("react").RefObject<import("..").Nullable<Element>>;

package/dist/hooks/use-honey-synthetic-scroll-y.d.ts

@@ -1,2 +1,19 @@
 import type { UseHoneySyntheticScrollOptions } from './use-honey-synthetic-scroll';
+/**
+ * Enables synthetic vertical (Y-axis) scrolling for a container element
+ * using pointer-based drag interactions.
+ *
+ * This is a convenience wrapper around {@link useHoneySyntheticScroll} with
+ * the axis fixed to `'y'`.
+ *
+ * All behavior, boundaries, and lifecycle guarantees are identical to the
+ * base hook, but limited to vertical movement only.
+ *
+ * @template Element - The HTML element type of the scrollable container.
+ *
+ * @param options - Configuration options forwarded to
+ * {@link useHoneySyntheticScroll}, excluding the `axis` option.
+ *
+ * @returns A ref that must be attached to the scrollable container element.
+ */
 export declare const useHoneySyntheticScrollY: <Element extends HTMLElement>(options?: Omit<UseHoneySyntheticScrollOptions<Element>, "axis">) => import("react").RefObject<import("..").Nullable<Element>>;

package/dist/hooks/use-honey-synthetic-scroll.d.ts

@@ -1,7 +1,36 @@
 import type { RefObject } from 'react';
 import type { Nullable } from '../types';
 import type { HoneyDragHandlers } from './use-honey-drag';
-type ScrollAxis = 'x' | 'y' | 'both';
+type Axis = 'x' | 'y' | 'both';
+interface ApplyAxisScrollParams {
+    /**
+     * Drag delta for the axis (deltaX or deltaY).
+     */
+    delta: number;
+    /**
+     * Current translate value for the axis.
+     */
+    currentTranslate: number;
+    /**
+     * Visible container size for the axis (width or height).
+     */
+    containerSize: number;
+    /**
+     * Overflow size for the axis.
+     */
+    overflowSize: number;
+    /**
+     * Overscroll window percentage.
+     */
+    overscrollPct: number;
+}
+/**
+ * Calculates the next translate value for a single scroll axis
+ * and determines whether movement is allowed within bounds.
+ *
+ * @returns The next translate value, or `null` if movement is not allowed.
+ */
+export declare const applyAxisScroll: ({ delta, currentTranslate, containerSize, overflowSize, overscrollPct, }: ApplyAxisScrollParams) => Nullable<number>;
 export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> extends Pick<HoneyDragHandlers<Element>, 'onStartDrag' | 'onEndDrag'> {
     /**
      * Axis along which synthetic scrolling is enabled.
@@ -12,7 +41,7 @@ export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> ext
      *
      * @default 'both'
      */
-    axis?: ScrollAxis;
+    axis?: Axis;
     /**
      * Percentage of the container size used as an overscroll buffer
      * on each enabled axis.
@@ -24,7 +53,7 @@ export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> ext
      *
      * @default 0
      */
-    availableWindowPct?: number;
+    overscrollPct?: number;
     /**
      * Whether to clear any applied translation transforms when the window resizes.
      *
@@ -56,5 +85,5 @@ export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> ext
  *
  * @returns A ref that must be attached to the scrollable container element.
  */
-export declare const useHoneySyntheticScroll: <Element extends HTMLElement>({ axis, availableWindowPct, onStartDrag, onEndDrag, resetOnResize, }?: UseHoneySyntheticScrollOptions<Element>) => RefObject<Nullable<Element>>;
+export declare const useHoneySyntheticScroll: <Element extends HTMLElement>({ axis, overscrollPct, onStartDrag, onEndDrag, resetOnResize, }?: UseHoneySyntheticScrollOptions<Element>) => RefObject<Nullable<Element>>;
 export {};