intersection-observer-api v1.0.2

intersection-observer-api

A small helper library to help manage intersection obeservers specifically the window observer.

Installation

Using npm:

npm i intersection-observer-api

Usage:

If using the intersection observer with the window with no margin all that is needed is to import observe and call it. It takes an element as the first parameter, an array of numbers 0-1 as the second, and lastly a callback in the form of (Observer Entry, Observer State) => void. Returns a function to unobserve the element

Observer Entry:
  - target: Element
  - boundingClientRect: dom Rect
  - intersectionRatio : number
  - intersectionRect: dom rect
  - isIntersecting: boolean
  - rootBounds: dom rect
  - time: number

Observer State:
  - movingUp: boolean
  - movingDown: boolean
  - movingRight: boolean
  - movingLeft: boolean
  - ratioGrowing: boolean
  - ratioShrinking: boolean

The api itself is a little more complicated: First genereate a observer target list by calling addObserverTargetToList which takes an existing observer target list and adds the new observer target along with initial state and returns the new observer

Then create the observer with makeObserverFromList which takes the created list as the first parameter and any observer options as the second parameter. Returns the disconnect for the observer.

In the future, I will create more helper functions to assist in managing the observer list and creation/deletion of the observer like what is done with the window observer.

Observer Target:
  - target: element
  - thresholds: number[]
  - callback: (Observer Entry, Observer State) => void
  
Observer Options:
  - root: Element | Document | null // null is the window
  - rootMargin: string // same as margin css shorthand

## Contact:
- clupnyluke@gmail.com

If you are feeling generous feel free to buy me a coffee at [Paypal](https://www.paypal.com/donate?hosted_button_id=WVWGAVAC7ZA6Q)