useWindowScroll

useWindowScroll 是一个 React Hook，它用于獲取瀏覽器窗口的滾動位置

useWindowScroll 追蹤視窗的捲動位置，回傳 x 和 y 座標以及一個程式化捲動的 scrollTo 函式。座標在使用者捲動時自動更新。

使用場景

  • 建構「回到頂部」按鈕，根據捲動位置顯示或隱藏
  • 根據視窗捲動位置觸發動畫或視差效果
  • 儲存和恢復使用者的捲動位置

注意事項

  • SSR 安全：在伺服器端渲染時回傳 x: 0, y: 0。伺服器上不會附加捲動事件監聽器。
  • 程式化捲動：使用回傳的 scrollTo 函式可平滑捲動到指定位置。
  • 相關 hooks：另請參閱 useScroll 用於追蹤任何可捲動元素（不僅限於視窗），以及 useWindowSize 追蹤視窗尺寸。

Usage

Live Editor
function Demo() {
  return (
    <div>
      <div>
        <iframe
          src="https://codesandbox.io/embed/dreamy-lehmann-mzg96r?fontsize=14&hidenavigation=1&theme=dark"
          style={{
            width: "100%",
            height: 500,
            border: 0,
            borderRadius: 4,
            overflow: "hidden",
          }}
          title="dreamy-lehmann-mzg96r"
          allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
          sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
        >
        </iframe>
      </div>
    </div>
  );
};
Result

API

useWindowScroll

Returns

UseWindowScrollState

Arguments

useWindowScrollState

參數名描述類型預設值
x水平滚动的像素值number (必填)-
y垂直滚动的像素值number (必填)-