React Page Visibility

Declarative, nested, stateful, isomorphic page visibility for React

Motivation

Are you polling your Backend on an interval basis? Are you running animations? What do you do if your tab is no longer visible?

See more classic use-cases in MDN Page Visibility API.

Well now you can react (Pun intended) to your app being in the background and invisible by conserving bandwidth and GPU calculations with ease. Introduction React Page Visibility:

• A React higher order component that wraps the page visibility API
• Cross-browser support (Yes, even IE and Safari)
• Safe fallback if browser does not support it
• Can be used multiple times anywhere in your application without side effects
• Lets you decide how to handle the page being invisible and turning visible again

Why use a React component and not a helper function?

Because React is cool. 'Nuff said.

But really, why not use a helper function? Because you will then need to

addEventListener

removeEventListener

Also, every time you use it you will need to check if your user's browser supports it and that gets tedious too.

Instead with

react-page-visibility

Installation

$ npm install --save react-page-visibility

Usage

A rotating carousel component that will be passed down a prop of whether to rotate the images or not based on whether page is visible.

Using the

usePageVisibility

hook

import React from 'react';
import { usePageVisibility } from 'react-page-visibility';

const AppContainer = () => {
    const isVisible = usePageVisibility()
return <rotatingcarousel rotate="{isVisible}"></rotatingcarousel>
}

Using

onChange

callback

import React from 'react';
import PageVisibility from 'react-page-visibility';

class AppContainer extends React.Component {
    state = {
        rotate: true
    };
handleVisibilityChange = isVisible => {
    this.setState({ rotate: !isVisible });
}

render() {
    return (
        <pagevisibility onchange="{this.handleVisibilityChange}">
            <rotatingcarousel rotate="{this.state.rotate}"></rotatingcarousel>
        </pagevisibility>
    );
}
}

Using

children

as function callback

import React from 'react';
import PageVisibility from 'react-page-visibility';

const AppContainer = () => {
    return (
        
            { isVisible =>  }
        
    );
}

API

react-page-visibility

onChange

onChange(handler)

Where

handler

visibilityState

Function handler( isVisible,  visibilityState)

• isVisible

  is a Boolean indicating whether document is considered visible to the user or not.

• visibilityState

  is a String and can be one of

  visible

  ,

  hidden

  ,

  prerender

  ,

  unloaded

  (if your browser supports those)

Notice: previous versions had different arguments in the

handler

Or you can use function as children pattern, where

children

visibilityState

Function children( isVisible,  visibilityState)

See MDN Page Visibility API Properties overview

License

MIT © Gilad Peleg