@orca-fe/hooks/lib/usePan.d.ts

React Hooks Collections

import type { Target } from 'ahooks/lib/useEventListener';
type PositionType = [number, number];
export type UsePanCallbackParams = {
    /** 拖动事件的起始位置 */
    startPosition: PositionType;
    /** 拖动事件的偏移量 */
    offset: PositionType;
    /** 是否结束（鼠标抬起） */
    finish: boolean;
    /** 是否开始（鼠标按下） */
    start: boolean;
    /** 触发拖动事件的鼠标事件 */
    ev: MouseEvent | TouchEvent;
    /** 触发拖动事件的 HTML 元素 */
    target: HTMLElement;
    /** 触发拖动事件的 HTML 元素的边界 */
    bounds: DOMRect;
};
export default function usePan<T extends Target = Target>(callback: (event: UsePanCallbackParams) => boolean | void, target: T): void;
export {};