@orca-fe/hooks
Version:
React Hooks Collections
20 lines (19 loc) • 618 B
TypeScript
import type { BasicTarget } from './utils/domTarget';
export type UseAutoScrollOptions = {
/** 触发滚动的边缘区域大小 */
edgeSize?: number;
/** 实时获取容器 bounds */
realtimeBounds?: boolean;
/** 根据点击事件自动触发滚动 */
autoTrigger?: boolean;
/** 是否支持横向滚动 */
scrollableX?: boolean;
/** 是否支持纵向滚动 */
scrollableY?: boolean;
};
export default function useAutoScroll(target: BasicTarget, options?: UseAutoScrollOptions): {
start: () => void;
stop: () => void;
toggle: () => void;
running: boolean;
};