#useWindowScroll

const scroll = useWindowScroll(options)

export interface UseWindowScrollOptions {
  /**
   * The scroll behavior, set to 'smooth' to enable smooth scrolling.
   *
   * @defaultValue 'auto'
   */
  behavior?: ScrollBehavior
}

export interface UseWindowScrollReturns extends Position {
  /**
   * 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
}