Web Components

Web Components è una suite di tecnologie che permettono di creare elementi personalizzati, la cui funzionalità è incapsulata e separata dal resto del codice sorgente, per uso in applicazioni web.

Concetti e uso

Riutilizzare una porzione di codice il più possibile è desiderabile. In passato, questo non è sempre stato facile per i linguaggi di markup: si pensi ad esempio al complesso HTML e CSS (con script associati) necessari per personalizzare i controlli dell'interfaccia utente, e a come sia necessario riutilizzarli all'interno della stessa pagina.

I Web Component hanno l'obiettivo di risolvere questi problemi. Consistono di tre tecnologie principali che possono essere usate in combinazione per creare elementi personalizzati versatili con funzionalità incapsulata che possono essere riutilizzati senza dover temere collisioni nel codice.

  • Elementi personalizzati: Un insieme di API per JavaScript che permettono di definire elementi personalizzati ed il loro comportamento.
  • Shadow DOM: Un insieme di API per JavaScript per assegnare un albero DOM "nascosto" ad un elemento, e controllare la funzionalità associata. In questo modo, è possibile mantenere le caratteristiche dell'elemento private ed evitare collisioni con altre parti del documento.
  • Template HTML: Gli elementi <template> e <slot> permettono di scrivere template di markup che non vengono visualizzati nella pagina. Questi template possono essere riutilizzati più volte come struttura base di un elemento personalizzato.

L'approccio all'implementazione di un web component è di solito la seguente:

  1. Creare una classe o funzione in cui si specifica la funzionalità del componente. Se si usa una classe, è solito usare la sintassi ECMAScript 2015.
  2. Registrare l'elemento tramite il metodo CustomElementRegistry.define() passando come parametro il nome dell'elemento, la classe o funzione che specifica la funzionalità del componente, e (opzionalmente) l'elemento da cui eredita.
  3. Se richiesto, assegnare un shadow DOM all'elemento tramite il metodo Element.attachShadow() e aggiungere elementi figli, event listener eccetera allo shadow DOM tramite metodi standard del DOM.
  4. Se richiesto, definire un template HTML usando <template> e <slot>. Usare i normali metodi del DOM per clonare il template e assegnarlo allo shadow DOM.
  5. Usare l'elemento personalizzato dove necessario nella pagina, come un qualsiasi elemento HTML.

Tutorial

Usare elementi personalizzati
Una guida che mostra come usare elementi personalizzati per creare componenti web, istruzioni sui lifecycle callbacks, ed altre funzionalità avanzate.
Usare lo shadow DOM
Una guida che spiega i fondamenti dello shadow DOM, mostrando come aggiungerlo a un elemento, aggiungere elementi all'albero shadow DOM, stilizzarlo, ed altro.
Usare templates e slot
Una guida che spiega come definire una struttura HTML riutilizzabile usando gli elementi <template> e <slot>, e come usera la struttura in un web component.

Glossario

Elementi personalizzati

CustomElementRegistry
Contiene funzionalità relativa a elementi personalizzati, in particolare il metodo CustomElementRegistry.define() usato per registrare nuovi elementi personalizzati in modo che possano essere usati nel documento.
Window.customElements
Returns a reference to the CustomElementRegistry object.
Life cycle callbacks
Special callback functions defined inside the custom element's class definition, which affect its behavior:
  • connectedCallback: Invoked when the custom element is first connected to the document's DOM.
  • disconnectedCallback: Invoked when the custom element is disconnected from the document's DOM.
  • adoptedCallback: Invoked when the custom element is moved to a new document.
  • attributeChangedCallback: Invoked when one of the custom element's attributes is added, removed, or changed.
Extensions for creating custom built-in elements
  • The is global HTML attribute: Allows you to specify that a standard HTML element should behave like a registered custom built-in element.
  • The "is" option of the Document.createElement() method: Allows you to create an instance of a standard HTML element that behaves like a given registered custom built-in element.
CSS pseudo-classes
Pseudo-classes relating specifically to custom elements:
  • :defined: Matches any element that is defined, including built in elements and custom elements defined with CustomElementRegistry.define()).
  • :host: Selects the shadow host of the shadow DOM containing the CSS it is used inside.
  • :host(): Selects the shadow host of the shadow DOM containing the CSS it is used inside (so you can select a custom element from inside its shadow DOM) — but only if the selector given as the function's parameter matches the shadow host.
  • :host-context(): Selects the shadow host of the shadow DOM containing the CSS it is used inside (so you can select a custom element from inside its shadow DOM) — but only if the selector given as the function's parameter matches the shadow host's ancestor(s) in the place it sits inside the DOM hierarchy.

Shadow DOM

ShadowRoot
Represents the root node of a shadow DOM subtree.
DocumentOrShadowRoot
A mixin defining features that are available across document and shadow roots.
Element extensions
Extensions to the Element interface related to shadow DOM:
  • The Element.attachShadow() method attaches a shadow DOM tree to the specified element.
  • The Element.shadowRoot property returns the shadow root attached to the specified element, or null if there is no shadow root attached.
Relevant Node additions
Additions to the Node interface relevant to shadow DOM:
  • The Node.getRootNode() method returns the context object's root, which optionally includes the shadow root if it is available.
  • The Node.isConnected property returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.
Event extensions
Extensions to the Event interface related to shadow DOM:
  • Event.composed: Returns a Boolean which indicates whether the event will propagate across the shadow DOM boundary into the standard DOM (true), or not  (false).
  • Event.composedPath: Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with ShadowRoot.mode closed.

HTML templates

<template>
Contains an HTML fragment that is not rendered when a containing document is initially loaded, but can be displayed at runtime using JavaScript, mainly used as the basis of custom element structures. The associated DOM interface is HTMLTemplateElement.
<slot>
A placeholder inside a web component that you can fill with your own markup, which lets you create separate DOM trees and present them together. The associated DOM interface is HTMLSlotElement.
The slot global HTML attribute
Assigns a slot in a shadow DOM shadow tree to an element.
Slotable
A mixin implemented by both Element and Text nodes, defining features that allow them to become the contents of an <slot> element. The mixin defines one attribute, Slotable.assignedSlot, which returns a reference to the slot the node is inserted in.
Element extensions
Extensions to the Element interface related to slots:
  • Element.slot: Returns the name of the shadow DOM slot attached to the element.
CSS pseudo-elements
Pseudo-elements relating specifically to slots:
  • ::slotted: Matches any content that is inserted into a slot.
The slotchange event
Fired on an HTMLSlotElement instance (<slot> element) when the node(s) contained in that slot change.

Examples

We are building up a number of examples in our web-components-examples GitHub repo. More will be added as time goes on.

Specifications

Specification Status Comment
HTML Living Standard
The definition of '<template> element' in that specification.
Living Standard The definition of <template>.
HTML Living Standard
The definition of 'custom elements' in that specification.
Living Standard The definition of HTML Custom Elements.
DOM
The definition of 'shadow trees' in that specification.
Living Standard The definition of Shadow DOM.
HTML Imports Working Draft Initial HTML Imports definition.
Shadow DOM Obsolete Initial Shadow DOM definition.

Browser compatibility

In general:

  • Web components are supported by default in Firefox (version 63), Chrome, and Opera.
  • Safari supports a number of web component features, but less than the above browsers.
  • Edge is working on an implementation.

For detailed browser support of specific features, you'll have to consult the reference pages listed above.

See also

  • webcomponents.org — site featuring web components examples, tutorials, and other information.
  • Hybrids — Open source web components library, which favors plain objects and pure functions over class and this syntax. It provides a simple and functional API for creating custom elements.
  • Polymer — Google's web components framework — a set of polyfills, enhancements, and examples. Currently the easiest way to use web components cross-browser.
  • Snuggsi — Easy Web Components in ~1kB Including polyfill — All you need is a browser and basic understanding of HTML, CSS, and JavaScript classes to be productive.
  • Slim.js — Open source web components library — a high-performant library for rapid and easy component authoring; extensible and pluggable and cross-framework compatible.
  • Stencil — Toolchain for building reusable, scalable design systems in web components.