@supunlakmal/hooks/dist/types/hooks/user-interface-dom/useScrollToTop.d.ts

A collection of reusable React hooks

interface ScrollToTopOptions {
    behavior?: ScrollBehavior;
}
/**
 * Custom hook that provides a function to scroll the window to the top.
 *
 * @param {ScrollToTopOptions} [options] - Optional configuration for the scroll behavior.
 * @param {'auto' | 'smooth'} [options.behavior='auto'] - Defines the transition animation.
 * @returns {() => void} A function that scrolls the window to the top when called.
 */
export declare const useScrollToTop: ({ behavior, }?: ScrollToTopOptions) => (() => void);
export {};