Package Exports

react-use-viewability

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-use-viewability) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-use-viewability

React hook for tracking component viewability, based on IntersectionObserver.

Installation

$ npm install react-use-viewability --save-dev

Usage

The hook accepts the standard IntersectionObserver options and returns an array containing an inView value that always reflects the component's viewability, and an inViewRef ref that must be passed to the element you want to track.

Example (try the live version):

import React from 'react';
import useViewability from 'react-use-viewability';

const Box = props => {
  // Consider the element viewable when at least half of it is in the viewport
  const [inView, inViewRef] = useViewability({ threshold: 0.5 });

  return (
    <div
      // Pass the received ref to the element
      ref={inViewRef}
      // Change background color when entering or leaving the viewport
      style={{
        backgroundColor: inView ? 'green' : 'red',
      }}
    />
  );
};

export default Box;

License

MIT License