mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
36 lines
664 B
Markdown
36 lines
664 B
Markdown
# `useWindowSize`
|
|
|
|
React sensor hook that tracks dimensions of the browser window.
|
|
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import {useWindowSize} from 'react-use';
|
|
|
|
const Demo = () => {
|
|
const {width, height} = useWindowSize();
|
|
|
|
return (
|
|
<div>
|
|
<div>width: {width}</div>
|
|
<div>height: {height}</div>
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Reference
|
|
|
|
```js
|
|
useWindowSize(options);
|
|
```
|
|
|
|
- `initialWidth` — Initial width value for non-browser environments.
|
|
- `initialHeight` — Initial height value for non-browser environments.
|
|
- `onChange` — Callback function triggered when the window size changes.
|
|
|
|
## Related hooks
|
|
|
|
- [useSize](./useSize.md)
|
|
- [useMeasure](./useMeasure.md) |