Skip to content

About

A page lifecycle hook for react

Topics

Resources

Stars

4 stars

Watchers

2 watching

Forks

Latest commit

 

History

17 Commits

Folders and files

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

About

A page lifecycle hook for react

Topics

Resources

Stars

4 stars

Watchers

2 watching

Forks

Packages

Used by

Contributors

Languages