Der Vorteil von Webkomponenten ist ihre Wiederverwendbarkeit: Sie können ein UI-Widget einmal erstellen und mehrmals wiederverwenden. Sie benötigen zwar JavaScript, um Webkomponenten zu erstellen, aber keine JavaScript-Bibliothek. HTML und die zugehörigen APIs bieten alles, was Sie brauchen.
Der Webkomponentenstandard besteht aus drei Teilen: HTML-Vorlagen, benutzerdefinierten Elementen und dem Shadow DOM. In Kombination können Sie damit benutzerdefinierte, eigenständige (gekapselte) und wiederverwendbare Elemente erstellen, die sich nahtlos in vorhandene Anwendungen einbinden lassen, genau wie die anderen HTML-Elemente, die wir bereits behandelt haben.
In diesem Abschnitt erstellen wir das Element <star-rating>, eine Webkomponente, mit der Nutzer eine Bewertung auf einer Skala von einem bis fünf Sternen abgeben können. Beim Benennen eines benutzerdefinierten Elements wird empfohlen, nur Kleinbuchstaben zu verwenden. Verwenden Sie Bindestriche, um zwischen regulären und benutzerdefinierten Elementen zu unterscheiden.
Wir besprechen die Verwendung der Elemente <template> und <slot>, des Attributs slot und von JavaScript, um eine Vorlage mit einem gekapselten Shadow DOM zu erstellen. Wir verwenden das definierte Element wieder und passen einen Textabschnitt an, so wie Sie es mit jedem Element oder jeder Webkomponente tun würden. Außerdem wird kurz auf die Verwendung von CSS innerhalb und außerhalb des benutzerdefinierten Elements eingegangen.
Das <template>-Element
Mit dem <template>-Element werden HTML-Fragmente deklariert, die geklont und mit JavaScript in das DOM eingefügt werden sollen. Der Inhalt des Elements wird standardmäßig nicht gerendert. Stattdessen werden sie mit JavaScript instanziiert.
<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>
Da der Inhalt eines <template>-Elements nicht auf dem Bildschirm angezeigt wird, werden das <form>-Element und sein Inhalt nicht gerendert. Die Ausgabe des folgenden CodePen ist leer. Öffnen Sie den HTML-Tab, um das <template>-Markup zu sehen.
In diesem Beispiel ist das <form>-Element im DOM kein untergeordnetes Element eines <template>-Elements.
Vielmehr sind die Inhalte von <template>-Elementen untergeordnete Elemente eines DocumentFragment, das von der Property HTMLTemplateElement.content zurückgegeben wird. Damit sie sichtbar werden, muss JavaScript verwendet werden, um die Inhalte abzurufen und an das DOM anzuhängen.
Mit diesem JavaScript wurde kein benutzerdefiniertes Element erstellt. In diesem Beispiel wurde der Inhalt von <template> an <body> angehängt.
Der Inhalt ist jetzt Teil des sichtbaren, gestaltbaren DOM.

Es ist nicht sehr sinnvoll, JavaScript zu verwenden, um eine Vorlage für nur eine Sternebewertung zu implementieren. Es ist jedoch sinnvoll, eine Webkomponente für ein wiederholt verwendetes, anpassbares Sternebewertungs-Widget zu erstellen.
Das <slot>-Element
Wir fügen einen Slot für eine benutzerdefinierte Legende pro Vorkommen ein. HTML bietet ein <slot>-Element als Platzhalter in einem <template>, das, wenn ein Name angegeben wird, einen „benannten Slot“ erstellt. Ein benannter Slot kann verwendet werden, um Inhalte innerhalb einer Webkomponente anzupassen. Mit dem <slot>-Element können wir steuern, wo die untergeordneten Elemente eines benutzerdefinierten Elements in dessen Shadow-Baum eingefügt werden sollen.
In unserer Vorlage ändern wir <legend> in <slot>:
<template id="star-rating-template">
<form>
<fieldset>
<slot name="star-rating-legend">
<legend>Rate your experience:</legend>
</slot>
Mit dem Attribut name werden anderen Elementen Slots zugewiesen, wenn das Element ein slot-Attribut hat, dessen Wert mit dem Namen eines benannten Slots übereinstimmt. Wenn das benutzerdefinierte Element keine Übereinstimmung für einen Slot hat, wird der Inhalt des <slot> gerendert.
Deshalb haben wir ein <legend> mit generischem Inhalt eingefügt, das gerendert werden kann, wenn jemand <star-rating></star-rating> ohne Inhalt in seinen HTML-Code einfügt.
<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>
Das Attribut slot ist ein globales Attribut, mit dem der Inhalt des <slot> innerhalb eines <template> ersetzt wird. In unserem benutzerdefinierten Element ist das Element mit dem Slot-Attribut ein <legend>. Das muss aber nicht sein. In unserer Vorlage wird <slot name="star-rating-legend"> durch <anyElement slot="star-rating-legend"> ersetzt, wobei <anyElement> ein beliebiges Element sein kann, sogar ein anderes benutzerdefiniertes Element.
Nicht definierte Elemente
In unserem <template> haben wir ein <rating>-Element verwendet. Dies ist kein benutzerdefiniertes Element.
Es ist vielmehr ein unbekanntes Element. Browser stürzen nicht ab, wenn sie ein Element nicht erkennen. Nicht erkannte HTML-Elemente werden vom Browser als anonyme Inline-Elemente behandelt, die mit CSS formatiert werden können. Ähnlich wie bei <span> werden auf die Elemente <rating> und <star-rating> keine User-Agent-Stile oder -Semantiken angewendet.
In diesem CodePen werden das <template>-Element und die Inhalte nicht gerendert. <template> ist ein bekanntes Element, das Inhalte enthält, die nicht gerendert werden sollen. Das Element <star-rating> muss noch definiert werden. Bis wir ein Element definieren, wird es vom Browser wie alle nicht erkannten Elemente angezeigt. Derzeit wird das nicht erkannte <star-rating> als anonymes Inline-Element behandelt. Der Inhalt, einschließlich der Legenden und des <p> im dritten <star-rating>, wird also so angezeigt, als ob er sich in einem <span> befinden würde.
Wir definieren unser Element, um dieses nicht erkannte Element in ein benutzerdefiniertes Element umzuwandeln.
Benutzerdefinierte Elemente
JavaScript ist erforderlich, um benutzerdefinierte Elemente zu definieren. Wenn das Element <star-rating> definiert ist, wird sein Inhalt durch einen Shadow-Root ersetzt, der den gesamten Inhalt der damit verknüpften Vorlage enthält. Die <slot>-Elemente aus der Vorlage werden durch den Inhalt des Elements innerhalb des <star-rating> ersetzt, dessen slot-Attributwert mit dem Namenswert des <slot> übereinstimmt, falls vorhanden. Andernfalls wird der Inhalt der Slots der Vorlage angezeigt.
Inhalte innerhalb eines benutzerdefinierten Elements, die keinem Slot zugeordnet sind – das <p>Is this text visible?</p> in unserem dritten <star-rating> – sind nicht im Shadow-Root enthalten und werden daher nicht angezeigt.
Wir definieren das benutzerdefinierte Element mit dem Namen star-rating, indem wir die HTMLElement erweitern:
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));
}
});
Nachdem das Element definiert wurde, wird es jedes Mal, wenn der Browser auf ein <star-rating>-Element stößt, so gerendert, wie es durch das Element mit der #star-rating-template definiert ist, also durch unsere Vorlage. Der Browser hängt einen Shadow-DOM-Baum an den Knoten an und fügt diesem Shadow-DOM einen Klon des Vorlageninhalts hinzu.
const shadowRoot = this.attachShadow({mode: 'open'});
shadowRoot.appendChild(starRating.cloneNode(true));
Wenn Sie sich die Entwicklertools ansehen, sehen Sie, dass das <form> aus dem <template> Teil des Shadow-Roots jedes benutzerdefinierten Elements ist. In jedem benutzerdefinierten Element in den Entwicklertools ist ein Klon des Inhalts von <template> zu sehen und im Browser sichtbar, aber der Inhalt des benutzerdefinierten Elements selbst wird nicht auf dem Bildschirm gerendert.

Im Beispiel <template> haben wir den Inhalt der Vorlage an den Textkörper des Dokuments angehängt und den Inhalt dem regulären DOM hinzugefügt. In der customElements-Definition haben wir dieselbe appendChild() verwendet, aber der geklonte Vorlageninhalt wurde an ein gekapseltes Shadow-DOM angehängt.
Haben Sie bemerkt, dass die Sterne wieder zu unformatierten Optionsfeldern geworden sind? Da es sich um ein Shadow-DOM und nicht um das Standard-DOM handelt, wird das Styling auf dem CSS-Tab von CodePen nicht angewendet. Die CSS-Stile dieses Tabs sind auf das Dokument und nicht auf das Shadow DOM beschränkt. Daher werden die Stile nicht angewendet. Wir müssen gekapselte Stile erstellen, um unsere gekapselten Shadow-DOM-Inhalte zu formatieren.
Shadow DOM
Das Shadow DOM beschränkt CSS-Stile auf jeden Shadow Tree und isoliert ihn vom Rest des Dokuments. Das bedeutet, dass externes CSS nicht auf Ihre Komponente angewendet wird und Komponentenstile keine Auswirkungen auf den Rest des Dokuments haben, es sei denn, Sie legen dies ausdrücklich fest.
Da wir die Inhalte an ein Shadow DOM angehängt haben, können wir ein <style>-Element einfügen, das dem benutzerdefinierten Element gekapseltes CSS bereitstellt.
Da dies auf das benutzerdefinierte Element beschränkt ist, müssen wir uns keine Sorgen machen, dass die Stile auf den Rest des Dokuments übertragen werden. Wir können die Spezifität der Selektoren erheblich reduzieren. Da beispielsweise die einzigen Eingaben, die im benutzerdefinierten Element verwendet werden, Optionsfelder sind, können wir input anstelle von input[type="radio"] als Selektor verwenden.
<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>
Webkomponenten werden zwar mit <template>-Markup gekapselt und CSS-Stile sind auf das Shadow DOM beschränkt und vor allem außerhalb der Komponenten verborgen, aber der gerenderte Slot-Inhalt, der <anyElement slot="star-rating-legend">-Teil des <star-rating>, ist nicht gekapselt.
Stile außerhalb des aktuellen Bereichs
Es ist möglich, aber nicht einfach, das Dokument innerhalb eines Shadow DOM und den Inhalt eines Shadow DOM über die globalen Stile zu formatieren. Die Schattengrenze, an der das Shadow-DOM endet und das reguläre DOM beginnt, kann überschritten werden, aber nur sehr bewusst.
Der Shadow-Baum ist der DOM-Baum innerhalb des Shadow-DOM. Die Shadow-Root ist der Stammknoten des Shadow-Baums.
Die Pseudoklasse :host wählt das Shadow-Host-Element <star-rating> aus.
Der Shadow-Host ist der DOM-Knoten, an den das Shadow-DOM angehängt ist.
Wenn Sie nur bestimmte Versionen des Hosts ansprechen möchten, verwenden Sie :host().
Dadurch werden nur die Shadow-Host-Elemente ausgewählt, die mit dem übergebenen Parameter übereinstimmen, z. B. ein Klassen- oder Attributselektor. Wenn Sie alle benutzerdefinierten Elemente auswählen möchten, können Sie star-rating { /* styles */ } im globalen CSS oder :host(:not(#nonExistantId)) in den Vorlagenstilen verwenden. In Bezug auf die Spezifität gewinnt das globale CSS.
Das Pseudoelement ::slotted() überschreitet die Shadow-DOM-Grenze innerhalb des Shadow-DOM. Es wählt ein Slotted-Element aus, wenn es mit dem Selektor übereinstimmt. In unserem Beispiel entspricht ::slotted(legend) unseren drei Legenden.
Wenn Sie ein Shadow-DOM über CSS im globalen Bereich ansprechen möchten, muss die Vorlage bearbeitet werden. Das Attribut part kann jedem Element hinzugefügt werden, das Sie gestalten möchten. Verwenden Sie dann das Pseudoelement ::part(), um Elemente innerhalb eines Shadow-Trees abzugleichen, die mit dem übergebenen Parameter übereinstimmen. Der Anker oder das Ursprungselement für das Pseudoelement ist der Host oder der Name des benutzerdefinierten Elements, in diesem Fall star-rating. Der Parameter ist der Wert des Attributs part.
Wenn unser Vorlagen-Markup so beginnt:
<template id="star-rating-template">
<form part="formPart">
<fieldset part="fieldsetPart">
Wir könnten die <form> und <fieldset> mit Folgendem ansprechen:
star-rating::part(formPart) { /* styles */ }
star-rating::part(fieldsetPart) { /* styles */ }
Teilnamen funktionieren ähnlich wie Klassen: Ein Element kann mehrere durch Leerzeichen getrennte Teilnamen haben und mehrere Elemente können denselben Teilnamen haben.
Google hat eine fantastische Checkliste zum Erstellen benutzerdefinierter Elemente. Vielleicht interessieren Sie sich auch für deklarative Shadow-DOMs.
Dein Wissen wird getestet
Testen Sie Ihr Wissen zu Vorlagen, Slots und Schatten.
Standardmäßig werden Elemente innerhalb des Shadow-DOMs durch Stile außerhalb des Shadow-DOMs formatiert.
Welche Antwort ist eine korrekte Beschreibung des Elements <template>?