useOnWindowScroll

React, Hooks, Effect, Event

Executes a callback whenever the window is scrolled.

  • Use the useRef() hook to create a variable, listener, which will hold the listener reference.
  • Use the useEffect() hook and EventTarget.addEventListener() to listen to the 'scroll' event of the window global object.
  • Use EventTarget.removeEventListener() to remove any existing listeners and clean up when the component unmounts.
const useOnWindowScroll = callback => {
  const listener = React.useRef(null);

  React.useEffect(() => {
    if (listener.current)
      window.removeEventListener('scroll', listener.current);
    listener.current = window.addEventListener('scroll', callback);
    return () => {
      window.removeEventListener('scroll', listener.current);
    };
  }, [callback]);
};
const App = () => {
  useOnWindowScroll(() => console.log(`scroll Y: ${window.pageYOffset}`));
  return <p style={{ height: '300vh' }}>Scroll and check the console</p>;
};

ReactDOM.render(<App />, document.getElementById('root'));

Recommended snippets

  • useOnWindowResize

    React, Hooks

    Executes a callback whenever the window is resized.

  • useOnGlobalEvent

    React, Hooks

    Executes a callback whenever an event occurs on the global object.

  • useUnload

    React, Hooks

    Handles the beforeunload window event.