@orca-fe/hooks
Version:
React Hooks Collections
22 lines (21 loc) • 818 B
TypeScript
import type { BasicTarget } from './utils/domTarget';
export declare const WHEEL_UP = "up";
export declare const WHEEL_DOWN = "down";
export declare const WHEEL_LEFT = "left";
export declare const WHEEL_RIGHT = "right";
export type WheelScrollDirection = typeof WHEEL_UP | typeof WHEEL_DOWN | typeof WHEEL_LEFT | typeof WHEEL_RIGHT;
export type WheelScrollState = {
/** 滚动中 */
rolling: boolean;
/** 当前滚动方向 */
direction: WheelScrollDirection | null;
/** 偏移量 */
movement: number;
/** 累计滚动距离 */
distance: number;
};
export type UseWheelOptions = {
/** 判断滚轮停止滚动毫秒数,必须大于最小延迟毫秒数 */
delay?: number;
};
export default function useWheel(target: BasicTarget, options?: UseWheelOptions): WheelScrollState;