@react-hive/honey-utils 3.17.0 → 3.18.0

package/dist/index.dev.cjs

@@ -1631,75 +1631,47 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _geometry__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ~/geometry */ "./src/geometry/index.ts");
 
 /**
- * Advances a value by one inertia step using velocity, friction, and hard bounds.
+ * Advances a value by a single inertial step using velocity,
+ * elapsed time, exponential friction, and hard bounds.
  *
- * This utility models **inertial motion** (momentum + decay) on top of
- * {@link resolveBoundedDelta}, which acts as the authoritative constraint layer.
+ * This function models **momentum-driven motion** and delegates
+ * boundary enforcement to {@link resolveBoundedDelta}, which guarantees:
+ * - no overshoot
+ * - no jitter at bounds
+ * - deterministic stopping behavior
  *
- * The function:
- * - Integrates velocity over the elapsed time to produce a movement delta
- * - Resolves that delta against fixed bounds
- * - Applies exponential friction to gradually reduce velocity
- * - Stops immediately when a bound is hit or velocity falls below a threshold
+ * ---
  *
- * ⚠️ This function performs **one step only** and is intended to be called
- * repeatedly from an animation loop (e.g. `requestAnimationFrame`).
+ * ### Termination conditions
+ * Inertia stops immediately when:
+ * - the absolute velocity falls below `minVelocityPxMs`, or
+ * - movement in the current direction is blocked by a bound
+ *
+ * ---
+ *
+ * ⚠️ **Single-step function**
+ * This function performs **one inertia step only**.
+ * It must be called repeatedly from an animation loop
+ * (e.g. `requestAnimationFrame`) to produce continuous motion.
+ *
+ * ---
  *
  * ### Common use cases
  * - Synthetic scrolling with momentum
+ * - Drag-to-scroll interactions
  * - Carousels and sliders
  * - Timelines and scrubbers
- * - Drag-to-scroll interactions with inertia
- *
- * @param value - Current value before applying inertia (e.g. translate position).
- * @param min - Minimum allowed value (inclusive).
- * @param max - Maximum allowed value (inclusive).
- * @param velocity - Current velocity in units per millisecond (e.g. px/ms).
- * @param deltaTime - Time elapsed since the previous step, in milliseconds.
- * @param friction - Exponential friction coefficient controlling decay rate.
- * @param minVelocity - Minimum velocity below which inertia stops.
- *
- * @returns An object containing the updated value and velocity,
- *          or `null` when inertia has completed or movement is no longer possible.
- *
- * @example
- * ```ts
- * let value = translateX;
- * let velocity = releaseVelocity; // px/ms from drag end
- * let lastTime = performance.now();
- *
- * const step = (time: number) => {
- *   const deltaTime = time - lastTime;
- *   lastTime = time;
- *
- *   const result = applyInertiaStep({
- *     value,
- *     velocity,
- *     min: -maxOverflow,
- *     max: 0,
- *     deltaTime,
- *   });
- *
- *   if (!result) {
- *     return; // inertia finished
- *   }
- *
- *   value = result.value;
- *   velocity = result.velocity;
  *
- *   container.style.transform = `translateX(${value}px)`;
- *   requestAnimationFrame(step);
- * };
- *
- * requestAnimationFrame(step);
- * ```
+ * @returns An {@link InertiaStepResult} when inertia is still active,
+ *          or `null` when inertia has completed or further movement
+ *          is not possible.
  */
-const applyInertiaStep = ({ value, min, max, velocity, deltaTime, friction = 0.002, minVelocity = 0.01, }) => {
-    if (Math.abs(velocity) < minVelocity) {
+const applyInertiaStep = ({ value, min, max, velocityPxMs, deltaTimeMs, friction = 0.002, minVelocityPxMs = 0.01, }) => {
+    if (Math.abs(velocityPxMs) < minVelocityPxMs) {
         return null;
     }
     // Distance we want to move this frame
-    const delta = velocity * deltaTime;
+    const delta = velocityPxMs * deltaTimeMs;
     const nextValue = (0,_geometry__WEBPACK_IMPORTED_MODULE_0__.resolveBoundedDelta)({
         delta,
         value,
@@ -1711,11 +1683,11 @@ const applyInertiaStep = ({ value, min, max, velocity, deltaTime, friction = 0.0
         return null;
     }
     // Apply exponential friction
-    const decay = Math.exp(-friction * deltaTime);
-    const nextVelocity = velocity * decay;
+    const decay = Math.exp(-friction * deltaTimeMs);
+    const nextVelocityPxMs = velocityPxMs * decay;
     return {
         value: nextValue,
-        velocity: nextVelocity,
+        velocityPxMs: nextVelocityPxMs,
     };
 };