npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@react-hook/intersection-observer

v3.1.2

Published

A React hook for the IntersectionObserver API that uses a polyfill when the native API is not available

Downloads

719,572

Readme

A React hook for the IntersectionObserver API that uses a polyfill when the native API is not available

The Intersection Observer API provides a way to asynchronously observe changes in the intersection of a target element with an ancestor element or with a top-level document's viewport. The ancestor element or viewport is referred to as the root.

When an IntersectionObserver is created, it's configured to watch for given ratios of visibility within the root. The configuration cannot be changed once the IntersectionObserver is created, so a given observer object is only useful for watching for specific changes in degree of visibility.

Quick Start

import * as React from 'react'
import useIntersectionObserver from '@react-hook/intersection-observer'

const Component = () => {
  const [ref, setRef] = React.useState()
  const {isIntersecting} = useIntersectionObserver(ref)
  return <div ref={setRef}>Is intersecting? {isIntersecting}</div>
}

API

useIntersectionObserver(target, options)

function useIntersectionObserver<T extends HTMLElement = HTMLElement>(
  target: React.RefObject<T> | T | null,
  options: IntersectionObserverOptions = {}
): IntersectionObserverEntry

Arguments

| Argument | Type | Required? | Description | | -------- | ------------------------------------------------------------- | --------- | ---------------------------------------------------- | | target | React.RefObject | T | null | Yes | A React ref created by useRef() or an HTML element | | options | IntersectionObserverOptions | No | Configuration options for the IntersectionObserver |

IntersectionObserverOptions

| Property | Type | Default | Description | | --------------------- | --------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | root | DOMElement | document | A specific ancestor of the target element being observed. If no value was passed to the constructor or this is null, the top-level document's viewport is used | | rootMargin | string | "0 0 0 0" | Margin around the root. Can have values similar to the CSS margin property, e.g. "10px 20px 30px 40px" (top, right, bottom, left). The values can be percentages. This set of values serves to grow or shrink each side of the root element's bounding box before computing intersections. | | threshold | number|number[] | 0 | 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. If you only want to detect when visibility passes the 50% mark, you can use a value of 0.5. If you want the callback to run every time visibility passes another 25%, you would specify the array [0, 0.25, 0.5, 0.75, 1]. The default is 0 (meaning as soon as even one pixel is visible, the callback will be run). A value of 1.0 means that the threshold isn't considered passed until every pixel is visible. | | pollInterval | number | null | The frequency in which the polyfill polls for intersection changes. | | useMutationObserver | bool | true | You can also choose to not check for intersections in the polyfill when the DOM changes by setting this to false | | initialIsIntersecting | bool | false | Changes the default value of isIntersecting for use in places like SSR |

Returns IntersectionObserverEntry

| Type | Description | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | IntersectionObserverEntry | This is the IntersectionObserverEntry object returned by the IntersectionObserver callback. |

LICENSE

MIT