Qué es el Shadow DOM

El Document Object Model (Modelo de Objetos del Documento), más conocido por las siglas DOM, es una interfaz de programación de aplicaciones multiplataforma que trata la estructura de documentos HTML, XHTML y XML como un árbol donde cada nodo es un objeto que representa una parte del documento.

Objetos DOM para formularios

Con el paso del tiempo y el avance la web, el DOM ha presentado algunos problemas, entre otros problemas de rendimiento a la hora de desarrollar webs y aplicaciones altamente dinámicas. A lo largo de este artículo repasaremos que es el DOM y como el Shadow DOM, junto al Virtual DOM, intentan resolver estos problemas.

Recordatorio: ¿Qué es el DOM?

De forma muy básica, si tenemos este documento HTML:

<!doctype html>
<html lang="es">
 <head>
   <title>Mi Web</title>
  </head>
 <body>
    <h1>¡Hola mundo!</h1>
    <p>Mi nombre es Jhon</p>
  </body>
</html>

El navegador leerá este lenguaje de texto, lo analizará y lo pasará a un modelo de datos creando un árbol jerárquico con objetos/nodos que representan el HTML original:

Árbol DOM

Con este modelo de datos ya es posible trabajar de forma programática: representar el documento en pantalla, darle estilo o modificarlo de forma dinámica.

La estandarización del DOM es responsabilidad del W3C (World Wide Web Consortium), si bien el desarrollo es realizado por WHATWG de forma constante y el W3C publica versiones estables del estándar WHATWG.

En estos estándares se incluyen las reglas de comportamiento de cada tipo de nodo, las reglas sobre cómo se pueden combinar entre sí y los métodos para acceder a ellos, esto es, los métodos para añadir, eliminar o modificar el DOM.

Además, el DOM permite vincular eventos a cada nodo y vincular funciones a estos eventos, de modo que cuando el evento tenga lugar se ejecuten dichas funciones (event handlers). Por ejemplo, el click o el tap sobre un elemento del DOM es un evento al que se pueden vincular funciones:

<a onclick='dosomething()'>Anchor</a>

El principal lenguaje de programación utilizado para trabajar con el DOM es jаvascript, pero no es el único, ya que el DOM, además de ser una interfaz multiplataforma, es una especificación independiente de lenguajes de programación. Por ejemplo, también se puede trabajar desde PHP con la clase DOMDocument. Incluso afectamos a la representación del DOM con CSS.

¡Tan bueno, tan genial!

Sin embargo, manipular el DOM suele ser una tarea cara en cuanto a recursos y rendimiento, sobre todo en el contexto del frontend, el renderizado de los documentos y su modificación dinámica, algo que está a la orden del día en las aplicaciones web actuales.

Estos problemas se deben principalmente a que HTML, CSS y JS tienen un ámbito global de forma predeterminada. Todo es global. Inyectar o modificar las propiedades de un nodo puede provocar un nuevo análisis de todo el árbol DOM construido previamente, incluyendo un nuevo cálculo completo de su representación visual, lo que se suele referir como «repintado».

Para solucionar este problema y tener elementos encapsulados que no afecten al resto de elementos de una página, una técnica muy popular ha sido el uso de <iframe>, un elemento HTML que permite cargar un documento independiente del documento principal pero dentro de él:

Un iframe permite insertar un documento «encapsulado» dentro de otro

Pero hay una solución mejor: el Shadow DOM, frecuentemente llamado en español como DOM Oculto.

Introducción al Shadow DOM

Se puede pensar en el Shadow DOM como un DOM dentro del DOM. Si el DOM creaba un árbol DOM global, el Shadow DOM crea un sub-árbol dentro del DOM regular. Y dentro del sub-árbol, los nodos HTML, el CSS y el JS son independientes, siendo esta su principal ventaja, ya que permite la encapsulación de pequeñas partes del documento.

Pensemos por ejemplo en CSS. Si queremos dar estilo a un elemento y que no afecte a elementos con la misma etiqueta HTML, tenemos que utilizar clases. A medida que nuestro proyecto crece, las colisiones entre clases y elementos comenzarán a aparecer y nos veremos tentados a utilizar !important.

El mantenimiento a largo plazo se vuelve cada vez más complicado y empezamos a pensar en como deberíamos construir los nombres de las clases, por ejemplo utilizado el método BEM, para crear bloques y elementos más o menos reutilizables y de fácil mantenimiento.

Con Shadow DOM no tenemos estos problemas. No tenemos que pensar en colisión de clases ni en colisión de estilos. Todo queda encapsulado. Incluso se puede encapsular jаvascript dentro del Shadow DOM.

De hecho, la encapsulación del Shadow DOM, junto a otras tecnologías como los Custom Elements, los HTML templates y los HTML imports, son la base de los Web Components, componentes independientes y reutilizables con los que construir páginas webs de una forma mucho más eficiente.

Uso básico de Shadow DOM

Para trabajar con Shadow DOM hay que tener claros estos conceptos:

Shadow host: es el nodo del DOM regular al que se ancla el Shadow DOM.
Shadow root: es el nodo raíz del Shadow Tree.
Shadow boundary: límites entre el DOM Tree y el Document Tree o DOM regular.
Shadow tree: es el árbol DOM que hay dentro de nuestro Shadow DOM, el sub-árbol dentro del árbol DOM regular.

El Shadow DOM permite encapsular piezas de un documento HTML

El Shadow DOM siempre hay que anclarlo a un nodo del DOM regular. Este elemento o nodo será el Shadow host. Añadir el Shadow DOM a un elemento del DOM regular es tan fácil como utilizar el método element.attachShadow().

Por ejemplo, si tenemos este elemento que hará de shadow host:

<div class="shadow-host"></div>

Podemos añadir el Shadow DOM de este modo:

const myElement = document.querySelector('.shadow-host');
const shadow = myElement.attachShadow({mode: 'open'});

El nodo raíz del Shadow DOM creado quedará así:

Ejemplo de Shadow root modo open

El modo «open» del Shadow root permite que se pueda acceder al Shadow DOM desde fuera, desde código en el resto del documento, por ejemplo con la propiedad shadowRoot del elemento que hace de Shadow host:

myShadowDom = myElement.shadowRoot;

Si se añade el Shadow root en modo «closed» no se podrá acceder al Shadow DOM desde fuera:

// No se podrá acceder al Shadow root desde fuera
const shadow = myElement.attachShadow({mode: 'closed'});

Ahora que tenemos creado el Shadow root, podemos añadir elementos que quedarán encapsulados en el Shadow Tree. Por ejemplo:

const quoteEl = document.createElement('blockquote');
quoteEl.innerText = 'Haz el amor y no la guerra (John Lennon)';
shadow.appendChild(quoteEl);

Dará como resultado este Shadow Tree:

El blockquote queda dentro del DOM Tree en la sombra

Y ahora podemos introducir CSS o jаvascript dentro del Shadow DOM sin que afecte al DOM regular. Por ejemplo:

const styles = document.createElement("style");
styles.textContent = `
    blockquote {
        color: white;
        background: #000;
        padding: 20px;
        display: block;
        font-family: san-serif;
        font-size: 2rem;
     }
`;
    
shadow.appendChild(styles);

Por ponerlo todo en perspectiva, este sería un código completo de ejemplo:

<blockquote>Esta cita no se ve afectada por los estilos dentro del Shadow DOM.</blockquote>
<div class="shadow-host"></div>
<script>
    const myElement = document.querySelector(".shadow-host");
    const shadow = myElement.attachShadow({mode: 'open'});
    
    const quoteEl = document.createElement('blockquote');
    quoteEl.innerText = 'Haz el amor y no la guerra (John Lennon)';
    shadow.appendChild(quoteEl);
    
    const styles = document.createElement("style");
    styles.textContent = `
        blockquote {
            color: white;
            background: #000;
            padding: 10px;
            display: block;
            font-family: san-serif;
            font-size: 2rem;
        }
    `;
     shadow.appendChild(styles);
 </script>

Que generaría este Shadow DOM:

CSS en la sombra

Y se vería de la siguiente forma (nota como el blockquote del DOM regular no se ve afectado por el CSS declarado dentro del Shadow DOM):

Blockquote con CSS en la sombra

DOM, Shadow DOM y Virtual DOM

Aunque este tutorial quería centrarlo en el Shadow DOM, no podía terminar sin dar unas breves referencias sobre Virtual DOM y las principales diferencias entre ellos.

Como se ha descrito al comienzo del tutorial, el DOM es una representación de un documento HTML completo que se utiliza para determinar los elementos que se van a renderizar y que además permite la manipulación de estos elementos de forma programática.

El Shadow DOM, por el contrario, no representa un documento completo, sino una parte o pieza que siempre estará anclada a un elemento del DOM regular. El Shadow DOM no puede existir sin el DOM regular.

El Virtual DOM, por su parte, es otra herramienta utilizada para mejorar el rendimiento de la manipulación del DOM regular pero que, a diferencia del Shadow DOM, sí representa un documento completo, pero es una representación virtual.

El Virtual DOM es utilizado por algunas bibliotecas, como React o Vue, de modo que modifican el Virtual DOM acumulando cambios y cuando estos están listos los inyectan de una vez en el DOM regular. Dicho de otra forma, realizan múltiples tareas de forma virtual pero una sola tarea (o unas pocas) en el DOM regular.

Referencias

Shadow DOM. W3C Editor’s Draft 06 March 2019
Shadow DOM. W3C Working Group Note 01 March 2018
Eric Bidelman. Shadow DOM v1: Componentes web independientes. Google Web Fundamentals.
Learn the differences between Shadow DOM and Virtual DOM. Vuejs Feed.