1.5.0 • Published 4 years ago
react-viewport-hooks v1.5.0
react-viewport-hooks
About
Get real viewport width & height
How to Install
First, install the library in your project by npm:
$ npm install react-viewport-hooks
Or Yarn:
$ yarn add react-viewport-hooks
Getting Started
Options
Name | Type | Default | Description |
---|---|---|---|
updateOnResize | boolean | true | Update sizes on window resize |
defaultVW | number | undefined | Fallback for default vw value |
defaultVH | number | undefined | Fallback for default vh value |
Returned Values
Name | Type | Description |
---|---|---|
vw | number | Window viewport width |
vh | number | Window viewport height |
Example
useViewport
hook:
import React from 'react';
import { useViewport } from 'react-viewport-hooks';
const App = () => {
const { vw, vh } = useViewport(/* object with options (if needed) */);
document.documentElement.style.setProperty('--vw', `${vw}px`);
document.documentElement.style.setProperty('--vh', `${vh}px`);
return <h1>Hello Viewport!</h1>;
};
export default App;
withViewport
HOC:
import React from 'react';
import { withViewport } from 'react-viewport-hooks';
const App = ({ vw, vh }) => {
document.documentElement.style.setProperty('--vw', `${vw}px`);
document.documentElement.style.setProperty('--vh', `${vh}px`);
return <h1>Hello Viewport!</h1>;
};
export default withViewport(/* object with options (if needed) */)(App);
License
This project is licensed under the MIT License © 2019-present Jakub Biesiada
1.5.0
4 years ago
1.5.0-beta.3
4 years ago
1.5.0-beta.2
4 years ago
1.5.0-beta.1
4 years ago
1.4.0
4 years ago
2.0.0-alpha.2
4 years ago
2.0.0-alpha.1
4 years ago
1.3.0-beta.1
4 years ago
1.3.0
4 years ago
1.2.3-beta.1
4 years ago
1.2.2
4 years ago
1.2.1
4 years ago
1.2.0
4 years ago
1.2.0-beta.3
4 years ago
1.2.0-beta.2
4 years ago
1.2.0-beta.1
4 years ago
1.1.2
4 years ago
1.1.2-beta.1
4 years ago
1.1.1
5 years ago
1.1.0
5 years ago
1.1.0-beta.1
5 years ago
1.0.2
5 years ago
1.0.1
5 years ago
1.0.0
5 years ago