ucc-ui/dist/types/hooks/useOffset.d.ts

ucc-ui components library

import { Ref } from 'vue';
interface IUseOffsetOptions {
    offset: number;
    boxHeight: Ref<number>;
    getLastBottomOffset: () => number;
}
interface IUseOffsetResult {
    topOffset: Ref<number>;
    bottomOffset: Ref<number>;
}
/**
 *
 * @param options
 * @param options.offset 偏移量
 * @param options.boxHeight 盒子高度
 * @param options.getLastBottomOffset 获取最后一个底部偏移量
 * @description 用于计算偏移量
 * @example
 * ```ts
 * const { topOffset, bottomOffset } = useOffset({
 *   offset: 10,
 *   boxHeight: 100,
 *   getLastBottomOffset: () => 0,
 * })
 * ```
 * @returns
 */
export declare function useOffset(options: IUseOffsetOptions): IUseOffsetResult;
export default useOffset;