# react-viewport-hooks

> Get real viewport width & height

Latest version **1.5.0** (published 2020-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-viewport-hooks
pnpm add react-viewport-hooks
yarn add react-viewport-hooks
bun add react-viewport-hooks
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2020-06-01 |
| First published | 2019-08-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 31.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jakub Biesiada |
| Maintainers | jbiesiada |
| Keywords | viewport, hooks, React, library |

## Links

- npm: https://www.npmjs.com/package/react-viewport-hooks
- Repository: https://github.com/JB1905/react-viewport-hooks
- Homepage: https://github.com/JB1905/react-viewport-hooks#readme
- Issues: https://github.com/JB1905/react-viewport-hooks/issues
- npm.io page: https://npm.io/package/react-viewport-hooks

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.5.0 (latest) — 2020-06-01
- 1.5.0-beta.3 (beta) — 2020-06-01
- 2.0.0-alpha.2 (alpha) — 2020-04-29
- 1.5.0-beta.2 — 2020-06-01
- 1.5.0-beta.1 — 2020-05-31
- 1.4.0 — 2020-05-25
- 2.0.0-alpha.1 — 2020-04-16
- 1.3.0-beta.1 — 2020-04-13
- 1.2.2 — 2020-02-22
- 1.2.1 — 2020-02-11
- 1.2.0 — 2020-02-11
- 1.2.0-beta.3 — 2020-02-11
- 1.2.0-beta.1 — 2020-02-11
- 1.1.2 — 2020-02-08
- 1.1.2-beta.1 — 2020-02-01
- … 6 more at https://npm.io/package/react-viewport-hooks/versions

## README

# [react-viewport-hooks](https://github.com/jb1905/react-viewport-hooks)

[![NPM version](http://img.shields.io/npm/v/react-viewport-hooks.svg?style=flat-square)](https://www.npmjs.com/package/react-viewport-hooks)
[![NPM downloads](http://img.shields.io/npm/dm/react-viewport-hooks.svg?style=flat-square)](https://www.npmjs.com/package/react-viewport-hooks)

## About

Get real viewport width & height

## How to Install

First, install the library in your project by npm:

```sh
$ npm install react-viewport-hooks
```

Or Yarn:

```sh
$ 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:**

```js
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:**

```js
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

---
_Source: https://npm.io/package/react-viewport-hooks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._