L'avantage des composants Web est leur réutilisabilité : vous pouvez créer un widget d'interface utilisateur une seule fois et le réutiliser plusieurs fois. Bien que vous ayez besoin de JavaScript pour créer des composants Web, vous n'avez pas besoin d'une bibliothèque JavaScript. Le langage HTML et les API associées fournissent tout ce dont vous avez besoin.
La norme des composants Web se compose de trois parties : les modèles HTML, les éléments personnalisés et le Shadow DOM. En les combinant, vous pouvez créer des éléments personnalisés, autonomes (encapsulés) et réutilisables qui peuvent être intégrés de manière fluide dans des applications existantes, tout comme les autres éléments HTML que nous avons déjà abordés.
Dans cette section, nous allons créer l'élément <star-rating>, un composant Web qui permet aux utilisateurs d'évaluer une expérience sur une échelle de une à cinq étoiles. Lorsque vous nommez un élément personnalisé, nous vous recommandons d'utiliser uniquement des lettres minuscules. Incluez des tirets, car cela permet de distinguer les éléments standards des éléments personnalisés.
Nous verrons comment utiliser les éléments <template> et <slot>, l'attribut slot et JavaScript pour créer un modèle avec un Shadow DOM encapsulé. Nous réutilisons l'élément défini en personnalisant une section de texte, comme vous le feriez pour n'importe quel élément ou composant Web. Nous verrons également brièvement comment utiliser le CSS à l'intérieur et à l'extérieur de l'élément personnalisé.
L'élément <template>
L'élément <template> permet de déclarer des fragments de code HTML à cloner et à insérer dans le DOM avec JavaScript. Le contenu de l'élément n'est pas affiché par défaut. Ils sont plutôt instanciés à l'aide de JavaScript.
<template id="star-rating-template">
<form>
<fieldset>
<legend>Rate your experience:</legend>
<rating>
<input type="radio" name="rating" value="1" aria-label="1 star" required />
<input type="radio" name="rating" value="2" aria-label="2 stars" />
<input type="radio" name="rating" value="3" aria-label="3 stars" />
<input type="radio" name="rating" value="4" aria-label="4 stars" />
<input type="radio" name="rating" value="5" aria-label="5 stars" />
</rating>
</fieldset>
<button type="reset">Reset</button>
<button type="submit">Submit</button>
</form>
</template>
Comme le contenu d'un élément <template> n'est pas écrit à l'écran, l'élément <form> et son contenu ne sont pas affichés. Le résultat du CodePen suivant semble vide. Ouvrez l'onglet HTML pour afficher le balisage <template>.
Dans cet exemple, l'élément <form> n'est pas un enfant d'un élément <template> dans le DOM.
Le contenu des éléments <template> est plutôt un enfant d'un DocumentFragment renvoyé par la propriété HTMLTemplateElement.content. Pour qu'il soit visible, vous devez utiliser JavaScript pour récupérer le contenu et l'ajouter au DOM.
Ce code JavaScript n'a pas créé d'élément personnalisé. Cet exemple a plutôt ajouté le contenu de <template> à <body>.
Le contenu fait désormais partie du DOM visible et stylisable.

Il n'est pas très utile d'exiger JavaScript pour implémenter un modèle pour une seule note, mais il est utile de créer un composant Web pour un widget de note personnalisable utilisé à plusieurs reprises.
L'élément <slot>
Nous incluons un emplacement pour inclure une légende personnalisée par occurrence. Le langage HTML fournit un élément <slot> comme espace réservé dans un <template> qui, s'il est nommé, crée un "emplacement nommé". Un emplacement nommé peut être utilisé pour personnaliser le contenu d'un composant Web. L'élément <slot> nous permet de contrôler l'emplacement où les enfants d'un élément personnalisé doivent être insérés dans son shadow tree.
Dans notre modèle, nous remplaçons <legend> par <slot> :
<template id="star-rating-template">
<form>
<fieldset>
<slot name="star-rating-legend">
<legend>Rate your experience:</legend>
</slot>
L'attribut name permet d'attribuer des emplacements à d'autres éléments si l'élément possède un attribut slot dont la valeur correspond au nom d'un emplacement nommé. Si l'élément personnalisé ne correspond pas à un emplacement, le contenu de <slot> est affiché.
Nous avons donc inclus un <legend> avec un contenu générique qui peut être affiché lorsque quelqu'un ajoute <star-rating></star-rating>, sans contenu, dans son code HTML.
<star-rating>
<legend slot="star-rating-legend">Blendan Smooth</legend>
</star-rating>
<star-rating>
<legend slot="star-rating-legend">Hoover Sukhdeep</legend>
</star-rating>
<star-rating>
<legend slot="star-rating-legend">Toasty McToastface</legend>
<p>Is this text visible?</p>
</star-rating>
L'attribut slot est un attribut global utilisé pour remplacer le contenu de <slot> dans un <template>. Dans notre élément personnalisé, l'élément avec l'attribut slot est un <legend>. Ce n'est pas nécessaire. Dans notre modèle, <slot name="star-rating-legend"> est remplacé par <anyElement slot="star-rating-legend">, où <anyElement> peut être n'importe quel élément, même un autre élément personnalisé.
Éléments non définis
Dans notre <template>, nous avons utilisé un élément <rating>. Il ne s'agit pas d'un élément personnalisé.
Il s'agit plutôt d'un élément inconnu. Les navigateurs ne plantent pas lorsqu'ils ne reconnaissent pas un élément. Les éléments HTML non reconnus sont traités par le navigateur comme des éléments intégrés anonymes qui peuvent être stylisés avec CSS. Comme <span>, les éléments <rating> et <star-rating> n'ont pas de styles ni de sémantique appliqués par l'user-agent.
Dans ce CodePen, l'élément <template> et son contenu ne s'affichent pas. <template> est un élément connu qui contient du contenu qui ne doit pas être affiché. L'élément <star-rating> n'a pas encore été défini. Tant que nous n'avons pas défini un élément, le navigateur l'affiche comme tous les éléments non reconnus. Pour l'instant, l'élément <star-rating> non reconnu est traité comme un élément intégré anonyme. Par conséquent, le contenu, y compris les légendes et l'élément <p> du troisième élément <star-rating>, s'affiche comme s'il se trouvait dans un élément <span>.
Définissons notre élément pour convertir cet élément non reconnu en élément personnalisé.
Éléments personnalisés
JavaScript est requis pour définir des éléments personnalisés. Lorsqu'il est défini, le contenu de l'élément <star-rating> est remplacé par une racine shadow contenant tout le contenu du modèle auquel nous l'associons. Les éléments <slot> du modèle sont remplacés par le contenu de l'élément dans le <star-rating> dont la valeur de l'attribut slot correspond à la valeur du nom de <slot>, le cas échéant. Si ce n'est pas le cas, le contenu des emplacements du modèle s'affiche.
Le contenu d'un élément personnalisé qui n'est pas associé à un emplacement (le <p>Is this text visible?</p> dans notre troisième <star-rating>) n'est pas inclus dans la racine shadow et n'est donc pas affiché.
Nous définissons l'élément personnalisé nommé star-rating en étendant HTMLElement :
customElements.define('star-rating',
class extends HTMLElement {
constructor() {
super(); // Always call super first in constructor
const starRating = document.getElementById('star-rating-template').content;
const shadowRoot = this.attachShadow({
mode: 'open'
});
shadowRoot.appendChild(starRating.cloneNode(true));
}
});
Maintenant que l'élément est défini, chaque fois que le navigateur rencontre un élément <star-rating>, il l'affiche comme défini par l'élément avec l'ID #star-rating-template, qui est notre modèle. Le navigateur associe une arborescence Shadow DOM au nœud, en ajoutant un clone du contenu du modèle à ce Shadow DOM.
const shadowRoot = this.attachShadow({mode: 'open'});
shadowRoot.appendChild(starRating.cloneNode(true));
Si vous examinez les outils pour les développeurs, vous verrez que le <form> de <template> fait partie de la racine shadow de chaque élément personnalisé. Un clone du contenu <template> est visible dans chaque élément personnalisé des outils pour les développeurs et dans le navigateur, mais le contenu de l'élément personnalisé lui-même n'est pas affiché à l'écran.

Dans l'exemple <template>, nous avons ajouté le contenu du modèle au corps du document, en ajoutant le contenu au DOM standard. Dans la définition de customElements, nous avons utilisé le même appendChild(), mais le contenu du modèle cloné a été ajouté à un DOM fantôme encapsulé.
Avez-vous remarqué que les étoiles sont redevenues des cases d'option sans style ? Comme il fait partie d'un Shadow DOM plutôt que du DOM standard, le style de l'onglet CSS de CodePen ne s'applique pas. Les styles CSS de cet onglet sont limités au document, et non au shadow DOM. Les styles ne sont donc pas appliqués. Nous devons créer des styles encapsulés pour styliser notre contenu Shadow DOM encapsulé.
Shadow DOM
Le Shadow DOM limite les styles CSS à chaque Shadow Tree, en l'isolant du reste du document. Cela signifie que le CSS externe ne s'applique pas à votre composant et que les styles de composant n'ont aucun effet sur le reste du document, sauf si nous les dirigeons intentionnellement vers celui-ci.
Comme nous avons ajouté le contenu à un shadow DOM, nous pouvons inclure un élément <style> fournissant du CSS encapsulé à l'élément personnalisé.
Comme cela est limité à l'élément personnalisé, nous n'avons pas à nous soucier de la propagation des styles au reste du document. Nous pouvons réduire considérablement la spécificité des sélecteurs. Par exemple, comme les seules entrées utilisées dans l'élément personnalisé sont des cases d'option, nous pouvons utiliser input au lieu de input[type="radio"] comme sélecteur.
<template id="star-rating-template">
<style>
rating {
display: inline-flex;
}
input {
appearance: none;
margin: 0;
box-shadow: none;
}
input::after {
content: '\2605'; /* solid star */
font-size: 32px;
}
rating:hover input:invalid::after,
rating:focus-within input:invalid::after {
color: #888;
}
input:invalid::after,
rating:hover input:hover ~ input:invalid::after,
input:focus ~ input:invalid::after {
color: #ddd;
}
input:valid {
color: orange;
}
input:checked ~ input:not(:checked)::after {
color: #ccc;
content: '\2606'; /* hollow star */
}
</style>
<form>
<fieldset>
<slot name="star-rating-legend">
<legend>Rate your experience:</legend>
</slot>
<rating>
<input type="radio" name="rating" value="1" aria-label="1 star" required/>
<input type="radio" name="rating" value="2" aria-label="2 stars"/>
<input type="radio" name="rating" value="3" aria-label="3 stars"/>
<input type="radio" name="rating" value="4" aria-label="4 stars"/>
<input type="radio" name="rating" value="5" aria-label="5 stars"/>
</rating>
</fieldset>
<button type="reset">Reset</button>
<button type="submit">Submit</button>
</form>
</template>
Bien que les composants Web soient encapsulés avec le balisage <template> et que les styles CSS soient limités au Shadow DOM et masqués de tout ce qui se trouve en dehors des composants, le contenu de l'emplacement qui est affiché, la partie <anyElement slot="star-rating-legend"> de <star-rating>, n'est pas encapsulé.
Styliser en dehors du champ d'application actuel
Il est possible, mais pas simple, de styliser le document à partir d'un Shadow DOM et de styliser le contenu d'un Shadow DOM à partir des styles globaux. La limite de l'ombre, où le DOM fantôme se termine et où le DOM standard commence, peut être traversée, mais uniquement de manière très intentionnelle.
L'arborescence fantôme est l'arborescence DOM à l'intérieur du DOM fantôme. La racine du shadow DOM est le nœud racine de l'arborescence du shadow DOM.
La pseudo-classe :host sélectionne <star-rating>, l'élément hôte du shadow DOM.
L'hôte shadow est le nœud DOM auquel le shadow DOM est associé.
Pour cibler uniquement des versions spécifiques de l'hôte, utilisez :host().
Cela ne sélectionne que les éléments d'hôte fantôme qui correspondent au paramètre transmis, comme un sélecteur de classe ou d'attribut. Pour sélectionner tous les éléments personnalisés, vous pouvez utiliser star-rating { /* styles */ } dans le CSS global ou :host(:not(#nonExistantId)) dans les styles de modèle. En termes de spécificité, le CSS global l'emporte.
Le pseudo-élément ::slotted() traverse la limite du Shadow DOM depuis l'intérieur du Shadow DOM. Il sélectionne un élément d'emplacement s'il correspond au sélecteur. Dans notre exemple, ::slotted(legend) correspond à nos trois légendes.
Pour cibler un DOM fantôme à partir du CSS dans le champ d'application global, vous devez modifier le modèle. L'attribut part peut être ajouté à n'importe quel élément auquel vous souhaitez appliquer un style. Utilisez ensuite le pseudo-élément ::part() pour faire correspondre les éléments d'une arborescence fantôme qui correspondent au paramètre transmis. L'élément d'ancrage ou d'origine du pseudo-élément est l'hôte, ou le nom de l'élément personnalisé, dans ce cas star-rating. Le paramètre est la valeur de l'attribut part.
Si le balisage de notre modèle commençait ainsi :
<template id="star-rating-template">
<form part="formPart">
<fieldset part="fieldsetPart">
Nous pourrions cibler les éléments <form> et <fieldset> avec :
star-rating::part(formPart) { /* styles */ }
star-rating::part(fieldsetPart) { /* styles */ }
Les noms de parties fonctionnent de la même manière que les classes : un élément peut avoir plusieurs noms de parties séparés par des espaces, et plusieurs éléments peuvent avoir le même nom de partie.
Google propose une excellente checklist pour créer des éléments personnalisés. Vous pouvez également vous renseigner sur les DOM fantômes déclaratifs.
Vérifiez vos connaissances
Testez vos connaissances sur les modèles, les emplacements et l'ombre.
Par défaut, les styles extérieurs au shadow DOM s'appliquent aux éléments qu'il contient.
Quelle réponse décrit correctement l'élément <template> ?