@dsmlll/react-scroll/dist/hooks/useScrollSync.d.ts

A React library for synchronizing scroll between a navigation component and content sections, with click-to-scroll functionality.

import { UseScrollSyncProps, UseScrollSyncReturn } from '../types';
/**
 * useScrollSync Hook 用于同步滚动容器中内容区域与导航标签的状态。
 * @param scrollContainerRef - 对滚动容器元素的引用。
 * @param navTabsRef - （可选）对导航标签容器元素的引用，用于计算偏移量。
 * @param sections - 一个对象，键是标签ID，值是对相应内容区域元素的引用。
 * @param initialActiveTab - （可选）初始激活的标签ID。
 * @param onActiveTabChange - （可选）当激活的标签发生变化时的回调函数。
 * @param userOptions - （可选）用户自定义的配置选项。
 * @returns 返回一个对象，包含当前激活的标签 (activeTab) 和处理标签点击的函数 (handleTabClick)。
 */
export declare const useScrollSync: ({ scrollContainerRef, navTabsRef, sections, initialActiveTab, onActiveTabChange, options: userOptions, }: UseScrollSyncProps) => UseScrollSyncReturn;