Szablon, boks i cień

Zaletą komponentów internetowych jest możliwość ich wielokrotnego wykorzystania: możesz raz utworzyć widżet interfejsu i używać go wielokrotnie. Do tworzenia komponentów internetowych potrzebujesz JavaScriptu, ale nie biblioteki JavaScriptu. HTML i powiązane interfejsy API zapewniają wszystko, czego potrzebujesz.

Standard komponentów internetowych składa się z 3 części: szablonów HTML, elementów niestandardowych i modelu Shadow DOM. Po połączeniu tych technologii możesz tworzyć niestandardowe, samodzielne (hermetyzowane) elementy wielokrotnego użytku, które można płynnie zintegrować z istniejącymi aplikacjami, podobnie jak inne elementy HTML, które już omówiliśmy.

W tej sekcji utworzymy element <star-rating>, czyli komponent internetowy, który umożliwia użytkownikom ocenianie wrażeń w skali od 1 do 5 gwiazdek. Podczas nadawania nazwy elementowi niestandardowemu zalecamy używanie tylko małych liter. Uwzględnij łączniki, ponieważ ułatwiają one odróżnianie elementów standardowych od niestandardowych.

Omówimy użycie elementów <template> i <slot>, atrybutu slot oraz kodu JavaScript do utworzenia szablonu z zamkniętym Shadow DOM. Używamy ponownie zdefiniowanego elementu, dostosowując sekcję tekstu, tak jak w przypadku każdego elementu lub komponentu internetowego. Omówimy też krótko używanie CSS wewnątrz i na zewnątrz elementu niestandardowego.

Element <template>

Element <template> służy do deklarowania fragmentów kodu HTML, które mają zostać sklonowane i wstawione do modelu DOM za pomocą JavaScriptu. Zawartość elementu nie jest domyślnie renderowana. Są one tworzone za pomocą JavaScriptu.

<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>

Ponieważ zawartość elementu <template> nie jest wyświetlana na ekranie, element <form> i jego zawartość nie są renderowane. Dane wyjściowe poniższego CodePen wydają się puste. Otwórz kartę HTML, aby zobaczyć znaczniki <template>.

W tym przykładzie element <form> nie jest elementem podrzędnym elementu <template> w DOM. Zamiast tego zawartość elementów <template> jest elementami podrzędnymi elementu DocumentFragment zwracanego przez właściwość HTMLTemplateElement.content. Aby były widoczne, należy użyć JavaScriptu do pobrania zawartości i dołączenia jej do DOM.

Ten kod JavaScript nie utworzył elementu niestandardowego. W tym przykładzie zawartość <template> została dołączona do <body>. Treść stała się częścią widocznego modelu DOM, który można stylizować.

CodePen w postaci, w jakiej pojawia się w DOM.

Wymaganie JavaScriptu do wdrożenia szablonu tylko dla jednej oceny w gwiazdkach nie jest zbyt przydatne, ale utworzenie komponentu internetowego dla wielokrotnie używanego, dostosowywanego widżetu oceny w gwiazdkach jest przydatne.

Element <slot>

Dodaliśmy miejsce na niestandardową legendę dla każdego wystąpienia. HTML udostępnia element <slot> jako obiekt zastępczy w elemencie <template>, który po podaniu nazwy tworzy „nazwany slot”. Nazwany slot może służyć do dostosowywania treści w komponencie internetowym. Element <slot> pozwala nam kontrolować, gdzie elementy podrzędne elementu niestandardowego powinny być wstawiane w jego drzewie shadow.

W naszym szablonie zmieniamy <legend> na <slot>:

<template id="star-rating-template">
  <form>
    <fieldset>
      <slot name="star-rating-legend">
        <legend>Rate your experience:</legend>
      </slot>

Atrybut name służy do przypisywania boksów do innych elementów, jeśli element ma atrybut slot, którego wartość odpowiada nazwie nazwanego boksu. Jeśli element niestandardowy nie ma dopasowania do boksu, renderowana jest zawartość elementu <slot>. Dlatego dodaliśmy element <legend> z ogólną treścią, który może być renderowany, gdy ktoś doda element <star-rating></star-rating> bez treści w kodzie 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>

Atrybut slot jest atrybutem globalnym, który służy do zastępowania zawartości elementu <slot> w elemencie <template>. W naszym elemencie niestandardowym element z atrybutem slot to <legend>. Nie musi. W naszym szablonie <slot name="star-rating-legend"> jest zastępowany przez <anyElement slot="star-rating-legend">, gdzie <anyElement> może być dowolnym elementem, nawet innym elementem niestandardowym.

Niezdefiniowane elementy

W naszym <template> użyliśmy elementu <rating>. To nie jest element niestandardowy. Jest to nieznany element. Przeglądarki nie ulegają awarii, gdy nie rozpoznają elementu. Nierozpoznane elementy HTML są traktowane przez przeglądarkę jako anonimowe elementy wbudowane, które można stylizować za pomocą CSS. Podobnie jak w przypadku <span>, elementy <rating> i <star-rating> nie mają stylów ani semantyki stosowanych przez klienta użytkownika.

W tym CodePen element <template> i jego zawartość nie są renderowane. <template> to znany element, który zawiera treści, które nie mają być renderowane. Element <star-rating> nie został jeszcze zdefiniowany. Dopóki nie zdefiniujemy elementu, przeglądarka będzie go wyświetlać tak jak wszystkie nierozpoznane elementy. Na razie nierozpoznany element <star-rating> jest traktowany jako anonimowy element wbudowany, więc zawartość, w tym legendy i element <p> w trzecim elemencie <star-rating>, jest wyświetlana tak, jakby znajdowała się w elemencie <span>.

Zdefiniujmy nasz element, aby przekonwertować ten nierozpoznany element na element niestandardowy.

Elementy niestandardowe

Do definiowania elementów niestandardowych wymagany jest JavaScript. Po zdefiniowaniu zawartość elementu <star-rating> jest zastępowana przez shadow root zawierający całą zawartość powiązanego z nim szablonu. Elementy <slot> z szablonu są zastępowane zawartością elementu w <star-rating>, którego wartość atrybutu slot odpowiada wartości nazwy <slot>, jeśli taka istnieje. Jeśli nie, wyświetlana jest zawartość boksów szablonu.

Treść w elemencie niestandardowym, która nie jest powiązana z miejscem (<p>Is this text visible?</p> w naszym trzecim elemencie <star-rating>), nie jest uwzględniana w korzeniu shadow i dlatego nie jest wyświetlana.

Definiujemy element niestandardowy o nazwie star-rating, rozszerzając 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));
    }
  });

Po zdefiniowaniu elementu za każdym razem, gdy przeglądarka napotka element <star-rating>, renderuje go zgodnie z definicją elementu z atrybutem #star-rating-template, który jest naszym szablonem. Przeglądarka dołącza do węzła drzewo Shadow DOM, dodając do niego klon zawartości szablonu.

const shadowRoot = this.attachShadow({mode: 'open'});
shadowRoot.appendChild(starRating.cloneNode(true));

Jeśli przyjrzysz się narzędziom dla programistów, zobaczysz, że <form> z <template> jest częścią shadow root każdego elementu niestandardowego. Klon zawartości <template> jest widoczny w każdym elemencie niestandardowym w narzędziach dla programistów i w przeglądarce, ale zawartość samego elementu niestandardowego nie jest renderowana na ekranie.

Zrzut ekranu z Narzędzi deweloperskich przedstawiający sklonowaną zawartość szablonu w każdym elemencie niestandardowym.

W przykładzie <template> dołączyliśmy zawartość szablonu do treści dokumentu, dodając ją do zwykłego modelu DOM. W definicji customElements użyliśmy tego samego elementu appendChild(), ale sklonowana zawartość szablonu została dołączona do hermetyzowanego shadow DOM.

Czy zauważyliście, że gwiazdki znowu stały się zwykłymi przyciskami opcji? Ponieważ jest on częścią modelu Shadow DOM, a nie standardowego modelu DOM, stylizacja na karcie CSS CodePen nie ma zastosowania. Style CSS tej karty są ograniczone do dokumentu, a nie do shadow DOM, więc nie są stosowane. Aby nadać styl zawartości Shadow DOM, musimy utworzyć style hermetyzowane.

Shadow DOM

Shadow DOM ogranicza zakres stylów CSS do każdego drzewa shadow, izolując je od reszty dokumentu. Oznacza to, że zewnętrzny arkusz CSS nie ma zastosowania do komponentu, a style komponentu nie mają wpływu na resztę dokumentu, chyba że celowo je do tego skierujemy.

Ponieważ dodaliśmy zawartość do modelu Shadow DOM, możemy dołączyć element <style>, który dostarcza hermetyzowany kod CSS do elementu niestandardowego.

Ponieważ jest to ograniczone do elementu niestandardowego, nie musimy się martwić, że style przenikną do reszty dokumentu. Możemy znacznie zmniejszyć specyficzność selektorów. Na przykład, ponieważ jedynymi danymi wejściowymi używanymi w elemencie niestandardowym są opcje, jako selektora możemy użyć input zamiast input[type="radio"].

 <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>

Komponenty internetowe są hermetyzowane za pomocą znaczników <template>, a style CSS są ograniczone do modelu Shadow DOM i ukryte przed wszystkim, co znajduje się poza komponentami. Jednak renderowana zawartość gniazda, czyli część <anyElement slot="star-rating-legend"> elementu <star-rating>, nie jest hermetyzowana.

Stylizacja poza bieżącym zakresem

Można stylizować dokument z poziomu modelu Shadow DOM i stylizować zawartość modelu Shadow DOM za pomocą stylów globalnych, ale nie jest to proste. Granicę cienia, czyli miejsce, gdzie kończy się Shadow DOM, a zaczyna zwykły DOM, można przekroczyć, ale tylko w bardzo konkretnych przypadkach.

Drzewo shadow to drzewo DOM w modelu Shadow DOM. Korzeń shadow jest węzłem głównym drzewa shadow.

Pseudoklasa :host wybiera element hosta shadow <star-rating>. Host shadow to węzeł DOM, do którego jest dołączony shadow DOM. Aby kierować reklamy tylko na określone wersje hosta, użyj :host(). Spowoduje to wybranie tylko tych elementów hosta shadow, które pasują do przekazanego parametru, np. selektora klasy lub atrybutu. Aby wybrać wszystkie elementy niestandardowe, możesz użyć star-rating { /* styles */ } w globalnym arkuszu CSS lub :host(:not(#nonExistantId)) w stylach szablonu. Jeśli chodzi o specyfikę, globalny arkusz CSS ma pierwszeństwo.

Pseudoelement ::slotted() przekracza granicę Shadow DOM z poziomu Shadow DOM. Wybiera element z atrybutem slot, jeśli pasuje on do selektora. W naszym przykładzie ::slotted(legend) pasuje do 3 legend.

Aby kierować na shadow DOM z CSS w zakresie globalnym, należy zmodyfikować szablon. Atrybut part można dodać do dowolnego elementu, który chcesz sformatować. Następnie użyj pseudoelementu ::part(), aby dopasować elementy w drzewie cieni, które pasują do przekazanego parametru. Kotwicą lub elementem źródłowym pseudoelementu jest host lub nazwa elementu niestandardowego, w tym przypadku star-rating. Parametr jest wartością atrybutu part.

Jeśli nasz znacznik szablonu wyglądał tak:

<template id="star-rating-template">
  <form part="formPart">
    <fieldset part="fieldsetPart">

Możemy kierować reklamy na <form> i <fieldset> za pomocą:

star-rating::part(formPart) { /* styles */ }
star-rating::part(fieldsetPart) { /* styles */ }

Nazwy części działają podobnie do klas: element może mieć wiele nazw części rozdzielonych spacjami, a wiele elementów może mieć tę samą nazwę części.

Google udostępnia świetną listę kontrolną dotyczącą tworzenia elementów niestandardowych. Możesz też dowiedzieć się więcej o deklaratywnych modelach shadow DOM.

Sprawdź swoją wiedzę

Sprawdź swoją wiedzę na temat szablonu, slotu i cienia.

Domyślnie style spoza modelu Shadow DOM określają styl elementów wewnątrz niego.

Prawda
Spróbuj ponownie.
Fałsz
Dobrze!

Która odpowiedź prawidłowo opisuje element <template>?

Ogólny element służący do wyświetlania dowolnych treści na stronie.
Spróbuj ponownie.
Element zastępczy.
Spróbuj ponownie.
Element używany do deklarowania fragmentów kodu HTML, które domyślnie nie będą renderowane.
Dobrze!