0.1.5 • Published 1 year ago

@stackmeister/react-use-document-visibility v0.1.5

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@stackmeister/react-use-document-visibility

A hook that checks if a screen is currently rendered by its system or not.

Mostly relies on document.hidden and the visibilitychange event.

This hook can help with green coding, to stop animations and heavy stuff when the app is not currently on top or rendered.

Install

// Yarn
yarn add @stackmeister/react-use-document-visibility

// NPM
npm i @stackmeister/react-use-document-visibility

TypeScript typings are included (No @types/ package needed)

Usage

import useDocumentVisibility from '@stackmeister/react-use-document-visibility'

const App = () => {
  const { visible } = useDocumentVisibility()

  return (
    <div>
      {visible && <HeavyComponent />}
    </div>
  )
}