import type { Position } from "../utils/basic.js";
export interface UseWindowScrollOptions {
    /**
     * The scroll behavior, set to 'smooth' to enable smooth scrolling.
     *
     * @defaultValue 'auto'
     */
    behavior?: ScrollBehavior;
}
export interface UseWindowScrollReturns extends Position {
    /**
     * The maximum scroll position on the x-axis.
     */
    maxX: number;
    /**
     * The maximum scroll position on the y-axis.
     */
    maxY: number;
    /**
     * Scrolls the window to the specified position.
     *
     * @param newPos The new position to scroll to.
     */
    scrollTo(newPos: Partial<Position>): void;
    /**
     * Scrolls the window to the top.
     */
    scrollToTop(): void;
    /**
     * Scrolls the window to the bottom.
     */
    scrollToBottom(): void;
    /**
     * Scrolls the window to the left.
     */
    scrollToLeft(): void;
    /**
     * Scrolls the window to the right.
     */
    scrollToRight(): void;
}
/**
 * A React Hook that helps to track and manipulate window scroll state.
 */
export declare function useWindowScroll(options?: UseWindowScrollOptions): UseWindowScrollReturns;