@rooks/use-window-size
v4.11.2
Published
A React Hooks package for window-size
Downloads
8,691
Maintainers
Readme
@rooks/use-window-size
Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using
npm install rooks
or
yarn add rooks
Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!
About
Window size hook for React.
Installation
npm install --save @rooks/use-window-size
Importing the hook
import useWindowSize from "@rooks/use-window-size"
Usage
function WindowComponent() {
const { innerWidth, innerHeight, outerHeight, outerWidth } = useWindowSize();
return (
<div>
<p>
<span>innerHeight - </span>
<span>{innerHeight}</span>
</p>
<p>
<span>innerWidth - </span>
<span>{innerWidth}</span>
</p>
<p>
<span>outerHeight - </span>
<span>{outerHeight}</span>
</p>
<p>
<span>outerWidth - </span>
<span>{outerWidth}</span>
</p>
</div>
);
}
render(<WindowComponent/>)
Returned Object keys
| Returned object attributes | Type | Description | | -------------------------- | ---- | ---------------------- | | width | int | inner width of window | | height | int | inner height of window | | outerWidth | int | outer height of window | | outerHeight | int | outer width of window |