简体中文

useWindowScroll

Tags:

Browser

一个 React 钩子，用于跟踪和操作窗口滚动状态。

演示

源码

(X, Y):

(0, 0)

(maxX, maxY):

(0, 0)

horizontal scroll helper

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

🪝 Hook 🎨 Demo 📄 Document

API

const scroll = useWindowScroll(options)

选项 Options

export interface UseWindowScrollOptions {
  /**
   * 滚动行为，设置为 'smooth' 以启用平滑滚动。
   *
   * @defaultValue 'auto'
   */
  behavior?: ScrollBehavior
}

返回值

export interface UseWindowScrollReturns extends Position {
  /**
   * 将窗口滚动到指定位置。
   *
   * @param newPos 要滚动到的新位置。
   */
  scrollTo(newPos: Partial<Position>): void
  /**
   * 将窗口滚动到顶部。
   */
  scrollToTop(): void
  /**
   * 将窗口滚动到底部。
   */
  scrollToBottom(): void
  /**
   * 将窗口滚动到左边。
   */
  scrollToLeft(): void
  /**
   * 将窗口滚动到右边。
   */
  scrollToRight(): void
}

ON THIS PAGE

#useWindowScroll

#演示

#用法

#源码

#API

#选项 Options

#返回值

useWindowScroll

演示

用法

源码

API

选项 Options

返回值