Neverending Perpetual Motion
Wondering what’s next for npm?Check out our public roadmap! »

This package has been deprecated

Author message:

Deprecated in favor of react-intersection-observer

react-on-intersect

1.0.7 • Public • Published

react-on-intersect

npm version stability-unstable Build Status dependency status js-standard-style

React hook to do something when two elements intersect.

Hooks are an upcoming feature that lets you use state and other React features without writing a class. They’re currently in React v16.7.0-alpha.

Demo

Infinite Scroll

Installation

npm install react-on-intersect

Usage

import React, { useRef } from 'react'
import useIntersect from 'react-on-intersect'
 
export default function Example () {
  const element = useRef(null)
 
  function onEnter () {
    console.log('Hi!')
  }
 
  function onExit () {
    console.log('Bye!')
  }
 
  useIntersect({ onEnter, onExit, element })
 
  return (
    <>
      <h1
        ref={element}
        style={{ marginTop: '110vh', textAlign: 'center', fontSize: '4em' }}
      >
        Hello, Intersect!
      </h1>
    </>
  )
}

API

useIntersect({ onEnter, [onExit], element, [options] })

onEnter([entry])

A function which is called when elements start intersecting.

onExit([entry])

A function which is called when elements stop intersecting.

element

Target element to watch.

options

See Intersection Observer#Parameters for available options.

Prior art

on-intersect

Read more

Intersection Observer API

License

MIT

Install

npm i react-on-intersect

DownloadsWeekly Downloads

9

Version

1.0.7

License

MIT

Unpacked Size

6.16 kB

Total Files

4

Last publish

Collaborators

  • avatar