@react-hive/honey-layout 14.0.0 → 14.2.0

package/dist/hooks/use-honey-overlay.d.ts

@@ -1,4 +1,4 @@
-import type { HoneyOverlayId, HoneyOverlayEventListenerHandler } from '~/types';
+import type { HoneyOverlayId, HoneyOverlayEventListenerHandler } from '../types';
 interface UseHoneyOverlayOptions {
     onKeyUp?: HoneyOverlayEventListenerHandler;
 }
@@ -26,5 +26,5 @@ interface UseHoneyOverlayOptions {
  * });
  * ```
  */
-export declare const useHoneyOverlay: (targetOverlayId: HoneyOverlayId, { onKeyUp }?: UseHoneyOverlayOptions) => import("~/types").HoneyActiveOverlay | undefined;
+export declare const useHoneyOverlay: (targetOverlayId: HoneyOverlayId, { onKeyUp }?: UseHoneyOverlayOptions) => import("../types").HoneyActiveOverlay | undefined;
 export {};

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

@@ -1,6 +1,6 @@
 import type { RefObject } from 'react';
-import { Axis } from '@react-hive/honey-utils';
-import type { Nullable } from '~/types';
+import type { Axis } from '@react-hive/honey-utils';
+import type { Nullable } from '../types';
 import type { UseHoneyDragHandlers } from './use-honey-drag';
 interface ResolveAxisTranslateOptions {
     /**
@@ -48,6 +48,33 @@ export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> ext
      * @default 0
      */
     overscrollPct?: number;
+    /**
+     * Controls how the hook applies scroll-related interaction styles
+     * (`touch-action` and `overscroll-behavior`) to the container.
+     *
+     * Synthetic scrolling often requires restricting native browser scrolling
+     * behavior to ensure consistent drag and wheel handling.
+     *
+     * However, in some embedded layouts (such as carousels placed inside a
+     * vertically scrollable page), applying these styles can unintentionally
+     * block natural page scrolling.
+     *
+     * ### Modes
+     * - `'default'` — Applies restrictive interaction styles:
+     *   - `overscroll-behavior: contain`
+     *   - Axis-aware `touch-action` (`pan-y`, `pan-x`, or `none`)
+     *
+     *   Recommended for standalone synthetic scroll containers.
+     *
+     * - `'embedded'` — Does not apply any interaction-blocking styles.
+     *
+     *   Recommended when the container is integrated into another scrollable
+     *   context (e.g. horizontal carousel inside a page), where native scroll
+     *   chaining must remain intact.
+     *
+     * @default 'default'
+     */
+    scrollMode?: 'default' | 'embedded';
     /**
      * Whether to clear any applied translation transforms when the window resizes.
      *
@@ -69,6 +96,26 @@ export interface UseHoneySyntheticScrollOptions<Element extends HTMLElement> ext
      * @default true
      */
     enablePointerScroll?: boolean;
+    /**
+     * Master toggle for the synthetic scroll behavior.
+     *
+     * When `true`, the hook:
+     * - Enables drag-based translation via {@link useHoneyDrag}.
+     * - Optionally resets transforms on resize via {@link useHoneyResize}.
+     * - Applies overscroll and touch-action styles.
+     * - Intercepts wheel / trackpad scroll input if {@link enablePointerScroll} is enabled.
+     *
+     * When `false`, the hook becomes completely inert:
+     * - No drag or wheel listeners are attached.
+     * - No transforms are applied.
+     * - Native scrolling behavior is preserved.
+     *
+     * Useful for conditionally disabling synthetic scrolling
+     * (e.g. mobile layouts, reduced motion, or feature flags).
+     *
+     * @default true
+     */
+    enabled?: boolean;
 }
 /**
  * Enables synthetic scrolling for a container using pointer-based drag gestures.
@@ -92,5 +139,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, overscrollPct, onStartDrag, onEndDrag, resetOnResize, enablePointerScroll, }?: UseHoneySyntheticScrollOptions<Element>) => RefObject<Nullable<Element>>;
+export declare const useHoneySyntheticScroll: <Element extends HTMLElement>({ axis, overscrollPct, onStartDrag, onEndDrag, scrollMode, resetOnResize, enablePointerScroll, enabled, }?: UseHoneySyntheticScrollOptions<Element>) => RefObject<Nullable<Element>>;
 export {};

package/dist/hooks/use-register-honey-overlay.d.ts

@@ -1,4 +1,4 @@
-import type { HoneyActiveOverlay, HoneyOverlayConfig, Nullable } from '~/types';
+import type { HoneyActiveOverlay, HoneyOverlayConfig, Nullable } from '../types';
 /**
  * A hook for registering and managing an overlay in the layout system.
  *