@synopackageland/ui 0.23.3 → 0.23.5

package/dist/interaction/index.d.ts

@@ -1,6 +1,7 @@
 export { IGNORE_OUTSIDE_ATTR, IGNORE_OUTSIDE_SELECTOR, outsideLayerCount, registerOutsideLayer, swallowNextClick, type OutsideLayer, type OutsideLayerOptions, type OutsideResult, } from './outside';
 export { COMPOSITION_END_GRACE_MS, createCompositionGuard, isComposingKey, isPrintableKey, type CompositionGuard, } from './ime';
 export { DRAG_THRESHOLD_PX, dropIndexAt, trackPointerGesture, type GestureAxis, type GestureCancelReason, type PointerGesture, type PointerGestureOptions, type PointerGestureState, } from './gesture';
+export { GESTURE_THRESHOLDS, swipeCommits, VELOCITY_MAX_SAMPLES, VELOCITY_REVERSAL_PX, VELOCITY_WINDOW_MS, VelocityEstimator, velocityDuration, type VelocitySample, } from './velocity';
 export { DIALOG_SELECTOR, createFocusOwner, focusSync, isInForeignDialog, pathInForeignDialog, type FocusOwner, } from './focus';
 export { createEditSession, editSessionOutside, type EditCommitResult, type EditSession, type EditSessionOptions, type EditSessionState, } from './editSession';
 export { useEditSession, useOutsideLayer, usePointerGesture } from './vue';

package/dist/interaction/velocity.d.ts

@@ -0,0 +1,65 @@
+/** How far back samples count, in ms. */
+export declare const VELOCITY_WINDOW_MS = 100;
+/** At most this many samples are kept (a burst of coalesced events cannot dominate). */
+export declare const VELOCITY_MAX_SAMPLES = 20;
+/** A movement smaller than this (CSS px) is not a change of direction. */
+export declare const VELOCITY_REVERSAL_PX = 0.5;
+/**
+ * The thresholds every gesture decision uses, in CSS px and px/s.
+ * - `flick`: a decisive flick (hide or show the phone bars at once).
+ * - `swipe`: a swipe that commits however short it was (pop a pushed page,
+ *   move to the next image), once it has moved past `slop`.
+ * - `swipeDistance`: a swipe that commits however slow it was (the next
+ *   image in a lightbox).
+ * - `hideDistance` / `showDistance`: a slow scroll hides the bars after this
+ *   much travel down and shows them after this much up (hysteresis, so a
+ *   slow or wobbly drag does not flicker them).
+ * - `slop`: travel before a touch counts as a gesture with a direction.
+ */
+export declare const GESTURE_THRESHOLDS: Readonly<{
+    flick: 1000;
+    swipe: 500;
+    swipeDistance: 48;
+    hideDistance: 48;
+    showDistance: 24;
+    slop: 6;
+}>;
+export interface VelocitySample {
+    /** Position along one axis in CSS px (scrollTop, clientX, clientY). */
+    position: number;
+    /** Timestamp in ms (event.timeStamp or performance.now()). */
+    time: number;
+}
+/**
+ * Velocity along one axis from a least-squares line through the samples of
+ * the last {@link VELOCITY_WINDOW_MS}. A reversal starts a new fit from the
+ * turning point, a gap longer than the window starts over, and a fit older
+ * than the window reads 0 (the finger or the scroll has stopped). Out-of-order
+ * samples are ignored; a sample with the same timestamp replaces the last.
+ */
+export declare class VelocityEstimator {
+    private samples;
+    private direction;
+    /** Add a sample; returns the velocity (px/s) at its time. */
+    add(position: number, time: number): number;
+    /** Velocity in px/s at `now` (the newest sample's time when omitted); 0 when stale or unknown. */
+    velocity(now?: number): number;
+    /** The samples in the fit, oldest first (for tests and diagnostics). */
+    get size(): number;
+    /** Forget everything: a new gesture. */
+    reset(): void;
+}
+/**
+ * A motion's duration scaled to the gesture that set it off: a flick at
+ * {@link GESTURE_THRESHOLDS}.flick or faster finishes in 60% of `baseMs`
+ * (never under 120ms), anything slower takes `baseMs`. Reduced motion is
+ * the stylesheet's (motion.css finishes every transition at once).
+ */
+export declare function velocityDuration(velocity: number, baseMs: number): number;
+/**
+ * Whether a released swipe commits: past `distance` (px) in its direction, or
+ * past the slop and at least {@link GESTURE_THRESHOLDS}.swipe px/s that way.
+ * `travel` and `velocity` are signed along the swipe's direction (positive
+ * means toward committing).
+ */
+export declare function swipeCommits(travel: number, velocity: number, distance: number): boolean;