useOnWindowScroll

About

A React hook for adding an event listener for window scroll


Examples

import "./styles.css";
import { useOnWindowScroll } from "rooks";

function App() {
  useOnWindowScroll(() => console.log("window scrolled"));
  return (
    <div
      style={{ display: "flex", flexDirection: "column", alignItems: "center" }}
    >
      <h1>Rooks : useOnWindowScroll example</h1>
      <p>Scroll Down</p>

      <div
        style={{
          display: "flex",
          flexDirection: "column",
          alignItems: "center",
        }}
      >
        <div
          style={{
            width: "200px",
            height: "800px",
            backgroundColor: "teal",
            marginTop: "20px",
          }}
        ></div>
      </div>
      <p>Scroll Up</p>
    </div>
  );
}

export default App;

Arguments

ArgumentsTypeDescriptionDefault value
callbackfunctionCallback function which needs to run on unmountundefined
whenbooleanWhen the event handler should be activetrue
isLayoutEffectbooleanShould it use layout effect.false

Returns

No return value.

Join the community!

Join our discord server! You can click the floating discord icon at the bottom right of the screen and chat with us!

Powered by vercel