Skip to content

adamc151/react-viewport-observer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-in-viewport-observer

A React npm package that uses intersection observer api to tell you when your component is in the viewport.

URL: https://www.npmjs.com/package/react-in-viewport-observer

Intersection information is needed for many reasons, such as:

  • Lazy-loading of images or other content as a page is scrolled.
  • Implementing "infinite scrolling" web sites
  • Reporting of visibility of advertisements in order to calculate ad revenues.
  • Deciding whether or not to perform tasks or animation processes based on whether or not the user will see the result.

Package Size

3.8kB MINIFIED
1.5kB MINIFIED + GZIPPED

https://bundlephobia.com/result?p=react-in-viewport-observer

Installing

npm i --save react-in-viewport-observer

Usage

ViewportObserver

import React from "react";
import ViewportObserver from "react-viewport-observer";

const Component = () => {
  return (
    <ViewportObserver>
      {(intersected) => {
        return intersected && <div>My Lazy loaded component</div>;
      }}
    </ViewportObserver>
  );
};

Props

rootMargin - Margin around the root (Default "0px 0px 0px 0px" (top, right, bottom, left))

threshold - Either a single number or an array of numbers which indicate at what percentage of the target's visibility the observer's callback should be executed.

More information can be found in https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published