micro_utils.dokka/dev.inmo.micro_utils.common/IntersectionObserver

IntersectionObserver

external class IntersectionObserver(callback: IntersectionObserverCallback)(source)

This is just an implementation from this commentary of Kotlin JS issue related to the absence of Intersection Observer API

Constructors

constructor(callback: IntersectionObserverCallback, options: IntersectionObserverOptions)

constructor(callback: IntersectionObserverCallback)

Properties

root

val root: Element

The Element or Document whose bounds are used as the bounding box when testing for intersection. If no root value was passed to the constructor or its value is null, the top-level document's viewport is used.

rootMargin

val rootMargin: String

An offset rectangle applied to the root's bounding box when calculating intersections, effectively shrinking or growing the root for calculation purposes. The value returned by this property may not be the same as the one specified when calling the constructor as it may be changed to match internal requirements. Each offset can be expressed in pixels (px) or as a percentage (%). The default is "0px 0px 0px 0px".

thresholds

val thresholds: Array<Number>

A list of thresholds, sorted in increasing numeric order, where each threshold is a ratio of intersection area to bounding box area of an observed target. Notifications for a target are generated when any of the thresholds are crossed for that target. If no value was passed to the constructor, 0 is used.

Functions

disconnect

fun disconnect()

Stops the IntersectionObserver object from observing any target.

observe

fun observe(targetElement: Element)

Tells the IntersectionObserver a target element to observe.

takeRecords

fun takeRecords(): Array<IntersectionObserverEntry>

Returns an array of IntersectionObserverEntry objects for all observed targets.

unobserve

fun unobserve(targetElement: Element)

Tells the IntersectionObserver to stop observing a particular target element.