Шаблон, рекламное место и тень

Преимущество веб-компонентов заключается в возможности их повторного использования: вы можете создать виджет пользовательского интерфейса один раз и использовать его многократно. Для создания веб-компонентов вам понадобится JavaScript, но библиотека JavaScript не нужна. HTML и связанные с ним API предоставляют всё необходимое.

Стандарт веб-компонентов состоит из трех частей: HTML-шаблоны, пользовательские элементы и Shadow DOM. Вместе они позволяют создавать настраиваемые, автономные (инкапсулированные) и многократно используемые элементы, которые можно тесно интегрировать в существующие приложения, как и другие элементы HTML, о которых мы уже говорили.

В этом разделе мы создадим элемент <star-rating> – веб-компонент, который позволяет пользователям оценивать что-либо по пятибалльной шкале. При присвоении имени пользовательскому элементу рекомендуется использовать все строчные буквы. Включайте в названия дефисы, чтобы отличать обычные элементы от специальных.

Мы обсудим, как использовать элементы <template> и <slot>, атрибут slot и JavaScript, чтобы создать шаблон с инкапсулированным Shadow DOM. Мы повторно используем определенный элемент, настраивая раздел текста, как и любой другой элемент или веб-компонент. Мы также кратко обсудим использование CSS внутри и снаружи пользовательского элемента.

Элемент <template>

Элемент <template> используется для объявления фрагментов HTML, которые будут клонированы и вставлены в DOM с помощью JavaScript. По умолчанию содержимое элемента не отображается. Они создаются с помощью 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>

Поскольку содержимое элемента <template> не выводится на экран, элемент <form> и его содержимое не отображаются. Выходные данные CodePen ниже пустые. Откройте вкладку HTML, чтобы посмотреть разметку <template>.

В этом примере <form> не является дочерним элементом <template> в DOM. Вместо этого содержимое элементов <template> является дочерними элементами DocumentFragment, возвращаемого свойством HTMLTemplateElement.content. Чтобы сделать его видимым, необходимо использовать JavaScript для захвата содержимого и добавления его в DOM.

Этот код JavaScript не создал специальный элемент. Вместо этого в примере содержимое <template> добавляется в <body>. Контент становится частью видимой, стилизуемой DOM.

CodePen в DOM.

Использовать JavaScript для реализации шаблона только для одной оценки не очень полезно, но создание веб-компонента для многократно используемого настраиваемого виджета оценки полезно.

Элемент <slot>

Мы добавили слот, в который можно включить настраиваемую легенду для каждого случая. В HTML есть элемент <slot>, который используется как плейсхолдер внутри <template>. Если задать ему имя, получится именованный слот. Именованный слот можно использовать для настройки контента в веб-компоненте. Элемент <slot> позволяет нам контролировать, куда должны быть вставлены дочерние элементы пользовательского элемента в его теневом дереве.

В нашем шаблоне мы меняем <legend> на <slot>:

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

Атрибут name используется для назначения слотов другим элементам, если у элемента есть атрибут slot, значение которого совпадает с названием именованного слота. Если у специального элемента нет совпадения для слота, отображается содержимое <slot>. Поэтому мы добавили <legend> с общим контентом, который может отображаться, когда кто-то добавляет <star-rating></star-rating> без контента в свой 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>

Атрибут slot является глобальным и используется для замены содержимого элемента <slot> в элементе <template>. В нашем пользовательском элементе элемент с атрибутом slot – это <legend>. Это не обязательно. В нашем шаблоне <slot name="star-rating-legend"> заменяется на <anyElement slot="star-rating-legend">, где <anyElement> может быть любым элементом, даже другим пользовательским элементом.

Неопределенные элементы

В нашем <template> мы использовали элемент <rating>. Это не специальный элемент. Это неизвестный элемент. Браузеры не дают сбой, когда не распознают элемент. Нераспознанные элементы HTML обрабатываются браузером как анонимные встроенные элементы, стиль которых можно задать с помощью CSS. Как и в случае с <span>, к элементам <rating> и <star-rating> не применяются стили или семантика агента пользователя.

В этом примере CodePen тег <template> и его содержимое не отображаются. Элемент <template> содержит контент, который не нужно отображать. Элемент <star-rating> ещё не определен. Пока мы не определим элемент, браузер будет отображать его как все нераспознанные элементы. Пока что нераспознанный элемент <star-rating> обрабатывается как анонимный встроенный элемент, поэтому контент, включая легенды и <p> в третьем <star-rating>, отображается так, как если бы он находился в <span>.

Давайте определим наш элемент, чтобы преобразовать этот нераспознанный элемент в пользовательский.

Специальные элементы

Для определения настраиваемых элементов требуется JavaScript. После этого содержимое элемента <star-rating> заменяется теневым корнем, содержащим все элементы связанного с ним шаблона. Элементы <slot> из шаблона заменяются содержимым элемента в <star-rating>, значение атрибута slot которого совпадает со значением названия <slot>, если оно есть. В противном случае показывается содержимое слотов шаблона.

Контент в пользовательском элементе, который не связан с областью (<p>Is this text visible?</p> в третьем элементе <star-rating>), не включается в теневой корень и поэтому не показывается.

Определяем пользовательский элемент с именем star-rating, расширяя 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));
    }
  });

Теперь, когда элемент определен, каждый раз, когда браузер встречает элемент <star-rating>, он отображает его так, как определено элементом с #star-rating-template, который является нашим шаблоном. Браузер прикрепляет дерево Shadow DOM к узлу, добавляя клон содержимого шаблона к этому Shadow DOM.

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

Если вы откроете инструменты разработчика, то увидите, что <form> из <template> является частью теневого корня каждого пользовательского элемента. Копия содержимого <template> видна в каждом пользовательском элементе в инструментах разработчика и в браузере, но содержимое самого пользовательского элемента не отображается на экране.

Скриншот DevTools, показывающий клонированное содержимое шаблона в каждом пользовательском элементе.

В примере с <template> мы добавили содержимое шаблона в тело документа, то есть в обычную модель DOM. В определении customElements мы использовали тот же appendChild(), но клонированное содержимое шаблона было добавлено в инкапсулированную теневую модель DOM.

Вы заметили, что звезды снова стали нестилизованными переключателями? Поскольку он является частью теневой модели DOM, а не стандартной, стили на вкладке CSS в CodePen не применяются. Стили CSS этой вкладки относятся к документу, а не к теневой модели DOM, поэтому они не применяются. Чтобы стилизовать инкапсулированный контент Shadow DOM, нужно создать инкапсулированные стили.

Shadow DOM

Теневое дерево DOM ограничивает область действия стилей CSS каждым теневым деревом, изолируя его от остальной части документа. Это означает, что внешние таблицы стилей CSS не применяются к компоненту, а стили компонента не влияют на остальную часть документа, если только мы намеренно не укажем это.

Поскольку мы добавили контент в Shadow DOM, мы можем включить элемент <style>, предоставляющий инкапсулированный CSS для специального элемента.

Поскольку стили применяются только к пользовательскому элементу, они не будут влиять на остальную часть документа. Мы можем существенно снизить специфичность селекторов. Например, поскольку в качестве входных данных в специальном элементе используются только переключатели, мы можем использовать input вместо 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>

Веб-компоненты инкапсулируются в разметку <template>, а стили CSS ограничены Shadow DOM и скрыты от всего, что находится за пределами компонентов. Однако содержимое слота, которое отображается (часть <anyElement slot="star-rating-legend"> элемента <star-rating>), не инкапсулируется.

Стилизация за пределами текущей области видимости

Оформить документ из Shadow DOM и оформить содержимое Shadow DOM с помощью глобальных стилей возможно, но непросто. Границу тени, где заканчивается теневое дерево DOM и начинается обычное, можно пересечь, но только намеренно.

Теневое дерево – это дерево DOM внутри теневой модели DOM. Корень тени – это корневой узел теневого дерева.

Псевдокласс :host выбирает <star-rating>, главный элемент теневого дерева. Теневой хост – это узел DOM, к которому прикреплено теневое дерево DOM. Чтобы настроить таргетинг только на определенные версии хоста, используйте :host(). Выбирает только те элементы shadow host, которые соответствуют переданному параметру, например селектору класса или атрибута. Чтобы выбрать все пользовательские элементы, можно использовать star-rating { /* styles */ } в глобальном CSS или :host(:not(#nonExistantId)) в стилях шаблона. С точки зрения специфичности глобальный CSS имеет приоритет.

Псевдоэлемент ::slotted() пересекает границу Shadow DOM изнутри. Он выбирает элемент в слоте, если тот соответствует селектору. В нашем примере ::slotted(legend) соответствует трем легендам.

Чтобы настроить таргетинг на теневую модель DOM из CSS в глобальной области видимости, необходимо изменить шаблон. Атрибут part можно добавить к любому элементу, стиль которого вы хотите изменить. Затем используйте псевдоэлемент ::part(), чтобы сопоставить элементы в теневом дереве, соответствующие переданному параметру. Якорным или исходным элементом для псевдоэлемента является хост или название пользовательского элемента, в данном случае star-rating. Параметр – это значение атрибута part.

Если разметка шаблона выглядит следующим образом:

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

Мы можем настроить таргетинг на <form> и <fieldset> с помощью:

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

Названия частей действуют аналогично классам: элемент может иметь несколько названий частей, разделенных пробелами, и несколько элементов могут иметь одно и то же название части.

У Google есть отличный контрольный список для создания пользовательских элементов. Рекомендуем также ознакомиться с информацией о декларативных Shadow DOM.

Проверьте себя

Проверьте свои знания о шаблонах, слотах и теневом DOM.

По умолчанию стили, заданные за пределами теневого дерева DOM, применяются к элементам внутри него.

Верно
Повторите попытку.
Неверно
Верно!

Какой ответ правильно описывает элемент <template>?

Общий элемент, используемый для показа любого контента на странице.
Повторите попытку.
Элемент-плейсхолдер.
Повторите попытку.
Элемент, используемый для объявления фрагментов HTML, которые не будут отображаться по умолчанию.
Верно!