Stable API

[kettanaito]

I suggest to introduce a stable API for the next major version 1.0.

Motivation

• Easier, intuitive usage
• Smaller internals due to efficient API setup
• Export some internal functions

API

• takeSnapshot(element: HTMLElement | HTMLCollection, options: SnapshotOptions): SnapshotResult

• observe({ bounds?: SnapshotBounds, snapshots?: SnapshotOptions[] }): ObserverEventHandlers

Usage

Basic usage

import { observe } from 'sentinel-dom'

const observer = observe({
  elements: document.getElementById('box')
})

observer.on('visible', (element) => {})
observer.once('visible', (element) => {})

Custom snapshots

import { observe } from 'sentinel-dom'

const observer = observe({
  elements: document.getElementsByClassName('target'),
  snapshots: {
    partiallyVisible: {
      thresholdY: 50,
    }
  }
})

observer.once('partiallyVisible', (element) => {})
observer.on('visible', (element) => {}) // default snapshots still available