Intersection Observer API
La API Observador de Intersección provee una vía asíncrona para observar cambios en la intersección de un elemento con un elemento ancestro o con el viewport del documento de nivel superior.
Históricamente, detectar la visibilidad de un elemento, o la visibilidad relativa de dos elementos, uno respecto del otro, ha sido una tarea difícil para la cual las soluciones no han sido muy fiables y propensas a causar que el navegador y los sitios a los que el usuario accede lleguen a ser lentos. A medida que la web ha madurado, la necesidad para este tipo de información ha ido en aumento. La información sobre intersección es necesaria por muchas razones, tales como:
- Carga en diferido de imágenes u otro contenido a medida que la página se desplaza.
- Implementación del desplazamiento infinito en sitios web, donde más y más contenido se carga y muestra a medida que se desplaza la página, de forma que el usuario no tiene que pasar páginas.
- Informes de visualizaciones de anuncios para calcular ingresos por publicidad.
- Decidir si deben realizarse tareas o procesos de animación basados en si el usuario verá o no el resultado.
Implementar la detección de intersecciones en el pasado implicaba manejadores de eventos y bucles llamando a métodos como Element.getBoundingClientRect()
para reunir la información necesaria para cada elemento afectado. Dado que todo este código corre sobre el hilo principal, incluso uno de estos puede causar problemas de rendimiento. Cuando un sitio es cargado con estos tests, las cosas pueden ponerse muy feas.
Considere una página web que usa scroll infinito. Usa una librería de terceros para manejar los anuncios situados periódicamente en la página, que tiene gráficos animados aquí y allá, y usa una librería personalizada que muestra cajas de notificación y similares. Cada uno de estos tiene sus propias rutinas de detección de intersecciones, todas corriendo en el hilo principal. El autor del sitio web puede no darse cuenta de que esto está pasando, ya que están usando dos librerías de las que quizás conocen muy poco acerca de su funcionamiento interno. A medida que el usuario desplaza la página, estas rutinas de detección de intersecciones están disparando código constantemente durante el scroll, lo que resulta en una experiencia que deja al usuario frustrado con el navegador, el sitio web y su ordenador.
El API Intersection Observer deja al código registrar una función callback que se ejecuta si un elemento que se desea monitorizar entra o sale de otro elemento (o del viewport), o cuando la cantidad por la que ambos elementos se intersecan cambia en una cantidad requerida. De esta manera, los sitios no necesitan hacer nada sobre el hilo principal para mirar este tipo de intersección entre elementos, y el navegador está libre para optimizar la gestión de intersecciones como le parezca conveniente.
Una cosa que el API Intersection Observer no puede decirle es: el número exacto de pixels que se solapan o específicamente cuales son; sin embargo, cubre el caso de uso mucho más común de "Si se intersecan por algún lugar alrededor del N%, necesito hacer algo."
Intersection observer conceptos y uso
La API Intersection Observer le permite configurar una función callback que es llamada cuando alguna de las siguientes circunstancias ocurren:
- Un elemento target intersecta ya sea al viewport del dispositivo o un elemento especificado. Ese elemento especificado es llamado el elemento root o root a los propósitos de la API Intersection Observer.
- La primera vez que se pide inicialmente al observador que observe un elemento target.
Típicamente, usted querrá observar los cambios en las intersecciones con respecto al ancestro scrollable más cercano al elemento, o, si el elemento no desciende de un ancestro scrollable, al viewport. Para observar la intersección relativa al elemento root, especifique null;
Tanto si está usted usando el viewport o algún otro elemento como root, el API funciona de la misma manera, ejecutando una función callback que usted le proporciona cuando la visibilidad del elemento target cambia al cruzar en la cantidad de intersección deseada con el elemento root.
El grado de intersección entre el elemento target y su elemento root es el intersection ratio. Esto es una representación del porcentaje del elemento target que es visible, indicado como un valor entre 0.0 y 1.0.
Creando un intersection observer
Cree el intersection observer llamando a su constructor y pasándole una función callback para que se ejecute cuando se cruce un umbral (threshold) en una u otra dirección:
let options = {
root: document.querySelector('#scrollArea'),
rootMargin: '0px',
threshold: 1.0
}
let observer = new IntersectionObserver(callback, options);
Un umbral de 1.0 significa que cuando el 100% del elemento target está visible dentro del elemento especificado por la opción root
, la función callback es invocada.
Opciones de Intersection observer
El objeto options
pasado al constructor IntersectionObserver()
(en-US) le deja controlar las circunstancias bajo las cuales la función callback es invocada. Tiene los siguientes campos:
root
-
El elemento que es usado como viewport para comprobar la visibilidad de elemento target. Debe ser ancestro de target. Por defecto es el viewport del navegador si no se especifica o si es
null
. rootMargin
-
Margen alrededor del elemento root. Puede tener valores similares a los de CSS
margin
property, e.g. "10px 20px 30px 40px"
(top, right, bottom, left). Los valores pueden ser porcentajes. Este conjunto de valores sirve para aumentar o encoger cada lado del cuadro delimitador del elemento root antes de calcular las intersecciones. Por defecto son todos cero. threshold
-
Es un número o un array de números que indican a que porcentaje de visibilidad del elemento target, la función callback del observer debería ser ejecutada. Si usted quiere que se detecte cuando la visibilidad pasa la marca del 50%, debería usar un valor de 0.5. Si quiere ejecutar la función callback cada vez que la visibilidad pase otro 25%, usted debería especificar el array [0, 0.25, 0.5, 0.75, 1]. El valor por defecto es 0 (lo que significa que tan pronto como un píxel sea visible, la función callback será ejecutada). Un valor de 1.0 significa que el umbral no se considera pasado hasta que todos los pixels son visibles.
Determinando un elemento para ser observado
Una vez usted ha creado el observer, necesita darle un elemento target para observar:
var target = document.querySelector('#listItem');
observer.observe(target);
// el callback que indicamos al observador será ejecutado ahora por primera vez
// espera hasta que le asignemos un target a nuestro observador (aún si el target no está actualmente visible)
Cuando el elemento target encuentra un threshold especificado por el IntersectionObserver
, la función callback es invocada. La función callback recibe una lista de objetos IntersectionObserverEntry
(en-US) y el observer:
var callback = function(entries, observer) {
entries.forEach(entry => {
// Cada entry describe un cambio en la intersección para
// un elemento observado
// entry.boundingClientRect
// entry.intersectionRatio
// entry.intersectionRect
// entry.isIntersecting
// entry.rootBounds
// entry.target
// entry.time
});
};
Asegúrese de que su función callback se ejecute sobre el hilo principal. Debería operar tan rápidamente como sea posible; si alguna cosa necesita tiempo extra para ser realizada, use Window.requestIdleCallback()
.
También, note que si especifica la opción root
, el elemento target debe ser un descendiente del elemento root.
Cómo se calcula la intersección
Todas las áreas consideradas por la API de Intersection Observer son rectángulos; los elementos que su forma es irregular se considera que están ocupando el rectángulo más pequeño que encierra todas las partes del elemento. De forma similar, si la porción visible de un elemento no es un rectángulo, entonces el rectángulo de intersección del elemento se interpreta como el rectángulo más pequeño que contiene todas las partes visibles del elemento.
Es útil entender un poco sobre cómo las diferentes propiedades proporcionadas por IntersectionObserverEntry
(en-US) describe una intersección.
La intersección entre el elemento root y su margen
Antes de poder realizar un seguimiento de la intersección de un elemento en un contenedor, necesitamos saber qué cuál es contendor. Este contenedor se le conoce como intersection root, o root element. Este puede ser un elemento del documento, que es ascendiente del elemento observado, o null
, que usará el viewport del documento como contenedor.
El rectángulo usado como los límites de la intersección del intersection root pueden ser ajustados configurando la opción root margin, rootMargin
, cuando creamos el IntersectionObserver
(en-US). Los valores en rootMargin
define los espacios añadidos a cada lado del cuadro delimitador que sirve de contenedor, creando los límites definitivos del contenedor, o intersection root (los cuáles están explicados en IntersectionObserverEntry.rootBounds
(en-US) cuando la función callback es ejecutada).
Umbrales
En lugar de reportar cada mínimo cambio indicando cómo de visible es el elemento que observamos, la Intersection Observer API usa umbrales. Cuando creamos un observable, puedes proporcionar uno o más valores númericos representando, en porcentaje, cuán visible es el elemento observado. Entonces, la API reporta sólo los cambios de visibilidad que cruza este umbral.
Por ejemplo, si te gustaría ser informado cada vez que la visibilidad del elemento pasa, hacia delante o hacía atrás, una marca de un 25%, entonces puedes especificar el array [0, 0.25, 0.5, 0.75, 1] como una lista de umbrales a la hora de crear el observable. Puedes saber incluso en qué dirección la visibilidad ha cambiado (esto es, saber si el elemento ha pasado a ser más o menos visible) comprobando el valor de la propiedad isIntersecting
(en-US) disponible en el IntersectionObserverEntry
(en-US) que tienes disponible en la función callback cada vez que la visibilidad cambia. Si isIntersecting
es true
, el elemento se ha vuelto al menos tan visibile como el umbral que pasó. Si es false
, el elemento entonces ha dejado de ser tan visible como el umbral que sobrepasó.
Para entender cómo funciona el concepto de umbral (threshold), pruebe a hacer scroll en el siguiente ejemplo. Cada caja coloreada muestra dentro de ella el porcentaje que tiene visible de cada una de las cuadro esquinas, de forma que podrá ver cómo cambian los porcentajes conforme va haciendo scroll. Cada caja tiene diferentes valores configurado de umbrales.
- La primera caja tiene un umbral para cada punto del porcentaje de visibilidad posible en el array que se le pasa a
IntersectionObserver.thresholds
(en-US), siendo su valor el array[0.00, 0.01, 0.02, ..., 0.99, 1.00]
. - La segunda caja sólo tiene un umbral que se marca en el 50%.
- La tercera caja tiene un umbral cada 10% de visibilidad (0%, 10%, 20%, etc.).
- La última tiene el umbral cada 25%.
Acotamiento y el rectángulo de intersección
El navegador computa el rectángulo de intersección final de la siguiente forma; la API hace todo esto por usted, pero puede ser útil entender estos pasos para comprender mejor cuando ocurrirán exactamente las intersecciones.
- El rectangulo delimitador del elemento target (el rectangulo mas pequeño, que encierra por completo los componentes que conforman el elemento) es obtenido llamando
getBoundingClientRect()
en el target. Este es el rectangulo de intersección mas grande que puede ser. Los pasos restantes removeran las porciones que no intersectan. - Starting at the target's immediate parent block and moving outward, each containing block's clipping (if any) is applied to the intersection rectangle. A block's clipping is determined based on the intersection of the two blocks and the clipping mode (if any) specified by the
overflow
property. Settingoverflow
to anything butvisible
causes clipping to occur. - If one of the containing elements is the root of a nested browsing context (such as the document contained in an
<iframe>
, the intersection rectangle is clipped to the containing context's viewport, and recursion upward through the containers continues with the container's containing block. So if the top level of an<iframe>
is reached, the intersection rectangle is clipped to the frame's viewport, then the frame's parent element is the next block recursed through toward the intersection root. - When recursion upward reaches the intersection root, the resulting rectangle is mapped to the intersection root's coordinate space.
- The resulting rectangle is then updated by intersecting it with the root intersection rectangle.
- This rectangle is, finally, mapped to the coordinate space of the target's
document
.
Callbacks de cambio de intersección
Cuando la cantidad del elemento target que es visible dentro del elemento root cruza uno de los umbrales de visibilidad, el callback del objeto IntersectionObserver
(en-US) es ejecutado. El callback recibe como input un array de todos los objetos IntersectionObserverEntry
(en-US), uno por cada umbral que haya sido cruzado, y una referencia al objeto IntersectionObserver
mismo.
Cada entrada en la lista de umbrales es un objeto IntersectionObserverEntry
(en-US) que describe un umbral que ha sido cruzado; esto es, cada entrada describe qué porción de un elemento dado se está intersectando con el elemento root, sea que el elemento se considere en intersección o no, y la dirección en la cual ocurrió la transición.
The code snippet below shows a callback which keeps a counter of how many times elements transition from not intersecting the root to intersecting by at least 75%. For a threshold value of 0.0 (default) the callback is called approximately upon transition of the boolean value of isIntersecting
(en-US). The snippet thus first checks that the transition is a positive one, then determines whether intersectionRatio
(en-US) is above 75%, in which case it increments the counter.
intersectionCallback(entries) => { entries.forEach(entry => { if (entry.isIntersecting) { let elem = entry.target; if (entry.intersectionRatio >= 0.75) { intersectionCounter++; } } }); }
Interfaces
IntersectionObserver
(en-US)-
The primary interface for the Intersection Observer API. Provides methods for creating and managing an observer which can watch any number of target elements for the same intersection configuration. Each observer can asynchronously observe changes in the intersection between one or more target elements and a shared ancestor element or with their top-level
Document
's viewport. The ancestor or viewport is referred to as the root. IntersectionObserverEntry
(en-US)-
Describes the intersection between the target element and its root container at a specific moment of transition. Objects of this type can only be obtained in two ways: as an input to your
IntersectionObserver
callback, or by callingIntersectionObserver.takeRecords()
(en-US).
Un ejemplo sencillo
Este ejemplo causa que el elemento que queremos observar cambia de color y transparencia conforme se va haciendo más o menos visible. En la página Timing element visibility with the Intersection Observer API (en-US), puedes encontrar un ejemplo más extenso que muestra cómo calcular cuanto tiempo que una serie de elementos, como anuncios, son visibles para el usuario y reaccionar a esa información guardando estadísticas.
HTML
El HTML para este ejemplo es muy simple, con un elemento primario que será la caja que querremos observar (con la creativa ID de "box"
) y algo de contenido para dentro de la caja.
<div id="box">
<div class="vertical">
Welcome to <strong>The Box!</strong>
</div>
</div>
CSS
El CSS del ejemplo no es muy importante para el propósito de este ejemplo: pinta el elemento y establece que los atributos background-color
y border
puedan participar en las CSS transitions, los cuáles usaremos para afectar los cambios al elemento conforme este es más o menos visible.
#box {
background-color: rgba(40, 40, 190, 255);
border: 4px solid rgb(20, 20, 120);
transition: background-color 1s, border 1s;
width: 350px;
height: 350px;
display: flex;
align-items: center;
justify-content: center;
padding: 20px;
}
.vertical {
color: white;
font: 32px "Arial";
}
.extra {
width: 350px;
height: 350px;
margin-top: 10px;
border: 4px solid rgb(20, 20, 120);
text-align: center;
padding: 20px;
}
JavaScript
Finalmente, vamos a mirar el código JavaScript que usa la API Intersection Observer API para hacer que las cosas ocurran.
Preparación
Primero, necesitamos preparar algunas variables e instalar el observador.
var numSteps = 20.0;
var boxElement;
var prevRatio = 0.0;
var increasingColor = "rgba(40, 40, 190, ratio)";
var decreasingColor = "rgba(190, 40, 40, ratio)";
// Set things up.
window.addEventListener("load", function(event) {
boxElement = document.querySelector("#box");
createObserver();
}, false);
Las constantes y variables que establecimos aquí son:
numSteps
-
A constant which indicates how many thresholds we want to have between a visibility ratio of 0.0 and 1.0.
prevRatio
-
This variable will be used to record what the visibility ratio was the last time a threshold was crossed; this will let us figure out whether the target element is becoming more or less visible.
increasingColor
-
A string defining a color we'll apply to the target element when the visibility ratio is increasing. The word "ratio" in this string will be replaced with the target's current visibility ratio, so that the element not only changes color but also becomes increasingly opaque as it becomes less obscured.
decreasingColor
-
Similarly, this is a string defining a color we'll apply when the visibility ratio is decreasing.
We call Window.addEventListener()
to start listening for the load
event; once the page has finished loading, we get a reference to the element with the ID "box"
using querySelector()
, then call the createObserver()
method we'll create in a moment to handle building and installing the intersection observer.
Creating the intersection observer
The createObserver()
method is called once page load is complete to handle actually creating the new IntersectionObserver
(en-US) and starting the process of observing the target element.
function createObserver() {
var observer;
var options = {
root: null,
rootMargin: "0px",
threshold: buildThresholdList()
};
observer = new IntersectionObserver(handleIntersect, options);
observer.observe(boxElement);
}
This begins by setting up an options
object containing the settings for the observer. We want to watch for changes in visibility of the target element relative to the document's viewport, so root
is null
. We need no margin, so the margin offset, rootMargin
, is specified as "0px". This causes the observer to watch for changes in the intersection between the target element's bounds and those of the viewport, without any added (or subtracted) space.
The list of visibility ratio thresholds, threshold
, is constructed by the function buildThresholdList()
. The threshold list is built programmatically in this example since there are a number of them and the number is intended to be adjustable.
Once options
is ready, we create the new observer, calling the IntersectionObserver()
(en-US) constructor, specifying a function to be called when intersection crosses one of our thresholds, handleIntersect()
, and our set of options. We then call observe()
(en-US) on the returned observer, passing into it the desired target element.
We could opt to monitor multiple elements for visibility intersection changes with respect to the viewport by calling observer.observe()
for each of those elements, if we wanted to do so.
Building the array of threshold ratios
The buildThresholdList()
function, which builds the list of thresholds, looks like this:
function buildThresholdList() {
var thresholds = [];
for (var i=1.0; i<=numSteps; i++) {
var ratio = i/numSteps;
thresholds.push(ratio);
}
thresholds.push(0);
return thresholds;
}
This builds the array of thresholds—each of which is a ratio between 0.0 and 1.0, by pushing the value i/numSteps
onto the thresholds
array for each integer i
between 1 and numSteps
. It also pushes 0 to include that value. The result, given the default value of numSteps
(20), is the following list of thresholds:
# | Ratio | # | Ratio |
---|---|---|---|
1 | 0.05 | 11 | 0.55 |
2 | 0.1 | 12 | 0.6 |
3 | 0.15 | 13 | 0.65 |
4 | 0.2 | 14 | 0.7 |
5 | 0.25 | 15 | 0.75 |
6 | 0.3 | 16 | 0.8 |
7 | 0.35 | 17 | 0.85 |
8 | 0.4 | 18 | 0.9 |
9 | 0.45 | 19 | 0.95 |
10 | 0.5 | 20 | 1.0 |
We could, of course, hard-code the array of thresholds into our code, and often that's what you'll end up doing. But this example leaves room for adding configuration controls to adjust the granularity, for example.
Handling intersection changes
When the browser detects that the target element (in our case, the one with the ID "box"
) has been unveiled or obscured such that its visibility ratio crosses one of the thresholds in our list, it calls our handler function, handleIntersect()
:
function handleIntersect(entries, observer) {
entries.forEach(function(entry) {
if (entry.intersectionRatio > prevRatio) {
entry.target.style.backgroundColor = increasingColor.replace("ratio", entry.intersectionRatio);
} else {
entry.target.style.backgroundColor = decreasingColor.replace("ratio", entry.intersectionRatio);
}
prevRatio = entry.intersectionRatio;
});
}
For each IntersectionObserverEntry
(en-US) in the list entries
, we look to see if the entry's intersectionRatio
(en-US) is going up; if it is, we set the target's background-color
to the string in increasingColor
(remember, it's "rgba(40, 40, 190, ratio)"
), replaces the word "ratio" with the entry's intersectionRatio
. The result: not only does the color get changed, but the transparency of the target element changes, too; as the intersection ratio goes down, the background color's alpha value goes down with it, resulting in an element that's more transparent.
Similarly, if the intersectionRatio
is going up, we use the string decreasingColor
and replace the word "ratio" in that with the intersectionRatio
before setting the target element's background-color
.
Finally, in order to track whether the intersection ratio is going up or down, we remember the current ratio in the variable prevRatio
.
Resultado
Abajo se encuentra el contenido resultante. Desplace ésta página hacia arriba y abajo y note como la apariencia de la caja cambia mientras lo hace.
Hay un ejemplo aún más extensivo en Cronometrando la visibilidad de un elemento con la API Intersection Observer (en-US).
Especificaciones
Specification |
---|
Intersection Observer # intersection-observer-interface |
Compatibilidad con navegadores
BCD tables only load in the browser