Skip to content

dubenskiy/use-page-lifecycle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

usePageLifecycle

The hook returns the current state of the page's lifecycle and whether the page has been removed from a hidden tab.

According to the Page Lifecycle API, a page can have one of the following states at any given time:

  • Active
  • Passive
  • Hidden
  • Frozen
  • Terminated
  • Discarded

Install

To install package run:

npm install --save use-page-lifecycle

Usage

import { useEffect } from 'react'
import { LifecycleState, usePageLifecycle } from 'use-page-lifecycle'

export default () => {
  const [lifecycleState] = usePageLifecycle()

  useEffect(() => {
      if (lifecycleState === LifecycleState.FROZEN) {
        // some action
      }
  }, [lifecycleState])
    
  return (
    <div>
      <h1>use-page-lifecycle</h1>
    </div>
  )
}

License

MIT