bence-toth / react-hook-viewport-size

A React hook for detecting viewport size

react-hook-viewport-size 📏

A React hook for detecting viewport size.

Installation

Using npm:

npm install --save react-hook-viewport-size

Using yarn:

yarn add react-hook-viewport-size

Usage

import React from 'react'
import useViewportSize from 'react-hook-viewport-size'

const ComponentWithViewportSize = () => {
  const [viewportWidth, viewportHeight] = useViewportSize()

  return (
    <p>Viewport size: {viewportWidth} × {viewportHeight}</p>
  )
}

Contributions

Contributions are welcome. File bug reports, create pull requests, feel free to reach out at [email protected].

Licence

LGPL-3.0

react-hook-viewport-size's Issues

Add ambient types for TypeScript

Relicense under MIT

Upgrade peerDependencies to allow React 18.x

Rename master branch to main

Add tests

Upgrade peerDependencies to allow React 17+

Update dependencies

Add React to peer dependencies and update dependencies

Add boilerplate from Create React Thing

Operability improvements

• Update dev dependencies
• Add ESLint (+rule sets) and prettier to dev dependencies
• Add npm scripts to run prettier and eslint
• Create GH Actions workflow to run build, linter, and prettier

Untrack and remove package lock file