Back to Content

IntersectionObserver: thresholds property

files/en-us/web/api/intersectionobserver/thresholds/index.md

latest1.5 KB
Original Source

{{APIRef("Intersection Observer API")}}

The thresholds read-only property of the {{domxref("IntersectionObserver")}} interface returns the list of intersection thresholds that was specified when the observer was instantiated with {{domxref("IntersectionObserver.IntersectionObserver", "IntersectionObserver()")}}.

If only one threshold ratio was provided when instantiating the object, this will be an array containing that single value.

See the Intersection Observer page to learn how thresholds work.

Value

An array of intersection thresholds, originally specified using the threshold property when instantiating the observer. If only one observer was specified, without being in an array, this value is a one-entry array containing that threshold. Regardless of the order your original threshold array was in, this one is always sorted in numerically increasing order.

If no threshold option was included when IntersectionObserver() was used to instantiate the observer, the value of thresholds is [0].

[!NOTE] Although the options object you can specify in the {{domxref("IntersectionObserver/IntersectionObserver","IntersectionObserver()")}} constructor has a field named threshold, this property is called thresholds. If you accidentally use thresholds as the name of the field in your options, the thresholds array will wind up being [0.0], which is likely not what you expect.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}