@react-hive/honey-layout 10.7.0 → 10.8.0

package/dist/hooks/use-honey-raf-loop.d.ts

@@ -10,7 +10,7 @@ interface HoneyRafOnFrameContext {
      * - Animation or transition completion
      * - Time- or state-based termination conditions
      */
-    stopRafLoop: () => void;
+    stop: () => void;
 }
 /**
  * Function invoked on every animation frame while the RAF loop is active.
@@ -85,12 +85,35 @@ interface UseHoneyRafLoopOptions {
      */
     onError?: (error: unknown) => void;
 }
+/**
+ * Public control API returned by {@link useHoneyRafLoop}.
+ */
+export interface HoneyRafLoopApi {
+    /**
+     * Indicates whether the RAF loop is currently running.
+     */
+    isRunning: boolean;
+    /**
+     * Starts the RAF loop.
+     *
+     * If the loop is already running, this call is ignored.
+     */
+    start: () => void;
+    /**
+     * Stops the RAF loop immediately.
+     *
+     * This method is safe to call:
+     * - From user code
+     * - From within the RAF frame handler
+     */
+    stop: () => void;
+}
 /**
  * A hook for running a controlled `requestAnimationFrame` loop.
  *
  * Features:
  * - Explicit RAF lifecycle control (`start` / `stop`)
- * - Delta time (`dt`) calculation with frame clamping
+ * - Delta time calculation with frame clamping
  * - Automatic cleanup on unmounting
  * - Conservative handling of tab visibility changes (mobile-safe)
  * - Safe error handling (stops loop on exception)
@@ -137,9 +160,5 @@ interface UseHoneyRafLoopOptions {
  * useHoneyRafLoop(onFrame);
  * ```
  */
-export declare const useHoneyRafLoop: (onFrame: HoneyRafOnFrameHandler, { autoStart, resumeOnVisibility, maxDeltaMs, onError, }?: UseHoneyRafLoopOptions) => {
-    isRafLoopRunning: boolean;
-    startRafLoop: () => void;
-    stopRafLoop: () => void;
-};
+export declare const useHoneyRafLoop: (onFrame: HoneyRafOnFrameHandler, { autoStart, resumeOnVisibility, maxDeltaMs, onError, }?: UseHoneyRafLoopOptions) => HoneyRafLoopApi;
 export {};

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

@@ -42,37 +42,40 @@ export interface UseHoneyTimerOptions {
      */
     onEnd?: UseHoneyTimerOnEndHandler;
 }
+/**
+ * Public control API returned by {@link useHoneyTimer}.
+ */
 export interface UseHoneyTimerApi {
     /**
      * Current timer value in milliseconds.
      *
      * This value updates over time while the timer is running.
      */
-    timerTimeMs: number;
+    timeMs: number;
     /**
      * Indicates whether the timer is currently progressing.
      */
-    isTimerRunning: boolean;
+    isRunning: boolean;
     /**
      * Starts the timer from `initialTimeMs`, resetting any previous state.
      */
-    startTimer: () => void;
+    start: () => void;
     /**
      * Pauses the timer while preserving the current time value.
      */
-    pauseTimer: () => void;
+    pause: () => void;
     /**
      * Resumes the timer from its current time value.
      *
      * Has no effect if the timer is already running.
      */
-    resumeTimer: () => void;
+    resume: () => void;
     /**
      * Resets the timer to a specific time value.
      *
      * @param timeMs - Optional new timer value. Defaults to `initialTimeMs`.
      */
-    resetTimer: (timeMs?: number) => void;
+    reset: (timeMs?: number) => void;
 }
 /**
  * A high-precision timer hook built on top of {@link useHoneyRafLoop}.