Chalarangelo/30-seconds-of-code

View on GitHub
content/snippets/react/s/use-window-size.md

Summary

Maintainability
Test Coverage
---
title: React useWindowSize hook
type: snippet
language: react
tags: [hooks,state,effect]
cover: polar-bear
dateModified: 2021-10-18
---

Tracks the dimensions of the browser window.

- Use the `useState()` hook to initialize a state variable that will hold the window's dimensions. Initialize with both values set to `undefined` to avoid mismatch between server and client renders.
- Create a function that uses `Window.innerWidth` and `Window.innerHeight` to update the state variable.
- Use the `useEffect()` hook to set an appropriate listener for the `'resize'` event on mount and clean it up when unmounting.

```jsx
const useWindowSize = () => {
  const [windowSize, setWindowSize] = React.useState({
    width: undefined,
    height: undefined,
  });

  React.useEffect(() => {
    const handleResize = () =>
      setWindowSize({ width: window.innerWidth, height: window.innerHeight });

    window.addEventListener('resize', handleResize);

    handleResize();

    return () => {
      window.removeEventListener('resize', handleResize);
    };
  }, []);

  return windowSize;
};

const MyApp = () => {
  const { width, height } = useWindowSize();

  return (
    <p>
      Window size: ({width} x {height})
    </p>
  );
};

ReactDOM.createRoot(document.getElementById('root')).render(
  <MyApp />
);
```