@aplus-frontend/ui
Version:
27 lines (26 loc) • 715 B
TypeScript
import { ScrollOffsetType } from '../interface';
import { Ref } from 'vue';
type ScrollBackOptions = {
scrollOffset: {
x: number;
y: number;
};
maxScrollDistance: {
x: number;
y: number;
};
timer?: number;
onScroll?: (x: boolean, y: boolean) => void;
onScrollEnd?: (x: boolean, y: boolean) => void;
};
/**
* 在特定的时间内滚动到0
* @param options
* @returns
*/
declare const useScrollSmooth: ({ scrollOffset, maxScrollDistance, timer, onScroll, onScrollEnd }: ScrollBackOptions) => {
start: (target: Partial<ScrollOffsetType>) => void;
stop: () => void;
isActive: Readonly< Ref<boolean, boolean>>;
};
export { useScrollSmooth };