@matthiaskrijgsman/mat-ui 0.0.6 → 0.0.8

package/dist/hooks/use-drag-x.d.ts

@@ -0,0 +1,37 @@
+import * as React from "react";
+type DragXEvent = {
+    /** Current pointer X (client) */
+    clientX: number;
+    /** X where the drag started */
+    startX: number;
+    /** Total horizontal movement since drag start */
+    totalDeltaX: number;
+    /** The original pointerdown event target */
+    target: EventTarget | null;
+};
+type UseDragXOptions = {
+    /** Called on every move with the incremental dx since the previous event */
+    onDelta: (dx: number, meta: DragXEvent) => void;
+    /** Called once when drag starts */
+    onDragStart?: (meta: DragXEvent) => void;
+    /** Called once when drag ends */
+    onDragEnd?: (meta: DragXEvent) => void;
+    /** Disable the hook */
+    disabled?: boolean;
+    /** Restrict to primary button drags (left click); default true  */
+    primaryButtonOnly?: boolean;
+    /** If true, preventDefault on move to avoid scrolling during touch drags */
+    preventScrollOnMove?: boolean;
+};
+type DragBind = {
+    onPointerDown: (e: React.PointerEvent) => void;
+    /** Recommended for the handle to avoid accidental scroll during touch drags */
+    style?: React.CSSProperties;
+    /** You can also put `touchAction: "none"` in your CSS */
+    role?: string;
+};
+export declare function useDragX(options: UseDragXOptions): {
+    isDragging: boolean;
+    bind: DragBind;
+};
+export {};