@zstings/utils/dist/types/src/util/scrollTo.d.ts

javascript、typescript 工具函数库 文档地址 [utils 文档](https://zstings.github.io/utils/)

/**
 * 滚动至···
 * @param option 可选的对象
 * @param option.rate 滚动的步长，默认 4
 * @param option.num 滚动的目标值，默认 0
 * @param option.direction 滚动的方向，默认 'top', 支持 'top' | 'left'
 * @param option.dom 滚动的目标元素，默认 document.scrollingElement
 * @param callback 滚动结束的回调函数
 * @category 工具Util
 * @example
 * 回到顶部
 * ```ts
 * scrollTo()
 * ```
 * @example
 * 回到顶部后触发回调
 * ```ts
 * scrollTo({}, () => console.log('到了'))
 * ```
 * @example
 * 回到距离顶部的100像素的位置
 * ```ts
 * scrollTo({num: 100})
 * ```
 * @example
 * 滚动到元素box的最左端
 * ```ts
 * scrollTo({dom: document.querySelector('.box')})
 * ```
 * @example
 * 滚动到元素box距离左端100像素位置
 * ```ts
 * scrollTo({num: 100, dom: document.querySelector('.box')})
 * ```
 */
export default function scrollTo(option?: {
    rate?: number;
    num?: number;
    direction?: 'top' | 'left';
    dom?: HTMLElement;
}, callback?: () => void): void;