テンプレート、スロット、シャドウ

ウェブ コンポーネントのメリットは再利用性にあります。UI ウィジェットを一度作成すれば、何度も再利用できます。ウェブ コンポーネントを作成するには JavaScript が必要ですが、JavaScript ライブラリは必要ありません。HTML と関連する API には、必要なものがすべて揃っています。

ウェブ コンポーネント標準は、HTML テンプレート、カスタム要素、Shadow DOM の 3 つの部分で構成されています。これらを組み合わせることで、カスタマイズされた、自己完結型(カプセル化された)の再利用可能な要素を構築できます。これらの要素は、すでに説明した他の HTML 要素と同様に、既存のアプリケーションにシームレスに統合できます。

このセクションでは、ユーザーが 1 ~ 5 つ星でエクスペリエンスを評価できるウェブ コンポーネントである <star-rating> 要素を作成します。カスタム要素に名前を付けるときは、すべて小文字を使用することをおすすめします。ダッシュを含めると、通常の要素とカスタム要素を区別するのに役立ちます。

<template> 要素と <slot> 要素、slot 属性、JavaScript を使用して、カプセル化された Shadow DOM を含むテンプレートを作成する方法について説明します。定義済みの要素を再利用し、テキストのセクションをカスタマイズします。これは、他の要素やウェブ コンポーネントの場合と同じです。また、カスタム要素の内外から CSS を使用する方法についても簡単に説明します。

<template> 要素

<template> 要素は、JavaScript でクローンを作成して DOM に挿入する HTML のフラグメントを宣言するために使用されます。要素の内容はデフォルトではレンダリングされません。代わりに、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> は DOM 内の <template> の子ではありません。<template> 要素のコンテンツは、HTMLTemplateElement.content プロパティによって返される DocumentFragment の子です。表示するには、JavaScript を使用してコンテンツを取得し、それらのコンテンツを DOM に追加する必要があります。

この JavaScript ではカスタム要素が作成されませんでした。この例では、<template> の内容を <body> に追加しています。コンテンツは、表示可能でスタイル設定可能な DOM の一部になりました。

DOM に表示される CodePen。

1 つの評価のテンプレートを実装するために JavaScript を必要とすることはあまり有用ではありませんが、繰り返し使用されるカスタマイズ可能な評価ウィジェットのウェブ コンポーネントを作成することは有用です。

<slot> 要素

発生ごとにカスタマイズされた凡例を含めるスロットが含まれています。HTML には、<template> 内のプレースホルダとして <slot> 要素が用意されています。名前を指定すると、「名前付きスロット」が作成されます。名前付きスロットを使用すると、ウェブ コンポーネント内のコンテンツをカスタマイズできます。<slot> 要素を使用すると、カスタム要素の子をシャドウツリー内のどこに挿入するかを制御できます。

テンプレートで、<legend> を <slot> に変更します。

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

name 属性は、要素に slot 属性があり、その値が名前付きスロットの名前と一致する場合に、スロットを他の要素に割り当てるために使用されます。カスタム要素にスロットの一致がない場合、<slot> の内容がレンダリングされます。そのため、HTML にコンテンツなしで <star-rating></star-rating> を追加したときにレンダリングできる一般的なコンテンツを含む <legend> を含めました。

<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 属性は、<template> 内の <slot> の内容を置き換えるために使用されるグローバル属性です。カスタム要素では、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> は匿名のインライン要素として扱われるため、凡例を含むコンテンツと 3 番目の <star-rating> の <p> は、<span> にある場合と同様に表示されます。

この認識されない要素をカスタム要素に変換するために、要素を定義しましょう。

カスタム要素

カスタム要素を定義するには JavaScript が必要です。定義すると、<star-rating> 要素の内容は、関連付けたテンプレートのすべての内容を含むシャドウルートに置き換えられます。テンプレートの <slot> 要素は、slot 属性値が <slot> の名前値と一致する <star-rating> 内の要素の内容に置き換えられます(存在する場合)。そうでない場合は、テンプレートのスロットの内容が表示されます。

スロットに関連付けられていないカスタム要素内のコンテンツ(3 番目の <star-rating> の <p>Is this text visible?</p>)は、シャドウルートに含まれないため、表示されません。

HTMLElement を拡張して、star-rating という名前のカスタム要素を定義します。

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 を持つ要素(テンプレート)で定義されたとおりに要素がレンダリングされます。ブラウザはシャドウ DOM ツリーをノードにアタッチし、テンプレート コンテンツのクローンをそのシャドウ DOM に追加します。

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

デベロッパー ツールを見ると、<template> の <form> が各カスタム要素のシャドウルートの一部であることがわかります。<template> のコンテンツのクローンは、デベロッパー ツールの各カスタム要素に表示され、ブラウザに表示されますが、カスタム要素自体のコンテンツは画面にレンダリングされません。

各カスタム要素にクローンされたテンプレートの内容を示す DevTools のスクリーンショット。

<template> の例では、テンプレートの内容をドキュメント本文に追加し、通常の DOM にコンテンツを追加しました。customElements の定義では、同じ appendChild() を使用しましたが、クローン作成されたテンプレートの内容はカプセル化された Shadow DOM に追加されました。

星がスタイルの設定されていないラジオボタンに戻ったことに気づきましたか?標準の DOM ではなく Shadow DOM の一部であるため、CodePen の CSS タブ内のスタイル設定は適用されません。そのタブの CSS スタイルは、シャドウ DOM ではなくドキュメントを対象としているため、スタイルは適用されません。カプセル化された Shadow DOM コンテンツのスタイルを設定するには、カプセル化されたスタイルを作成する必要があります。

シャドウ DOM

Shadow DOM は、CSS スタイルのスコープを各シャドウツリーに設定し、ドキュメントの他の部分から分離します。つまり、外部 CSS はコンポーネントに適用されず、コンポーネントのスタイルは、意図的に指示しない限り、ドキュメントの残りの部分に影響しません。

コンテンツを Shadow DOM に追加したため、カプセル化された CSS をカスタム要素に提供する <style> 要素を含めることができます。

これはカスタム要素にスコープされているため、スタイルがドキュメントの他の部分に漏れる心配はありません。セレクタの特異性を大幅に低減できます。たとえば、カスタム要素で使用される入力はラジオボタンのみであるため、セレクタとして input[type="radio"] の代わりに input を使用できます。

 <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 にスコープ設定され、コンポーネント外のすべてから隠されますが、レンダリングされるスロット コンテンツ(<star-rating> の <anyElement slot="star-rating-legend"> 部分)はカプセル化されません。

現在のスコープ外のスタイル設定

Shadow DOM 内からドキュメントのスタイルを設定したり、グローバル スタイルから Shadow DOM のコンテンツのスタイルを設定したりすることは可能ですが、簡単ではありません。シャドウ境界(シャドウ DOM が終了し、通常の DOM が開始する場所)はトラバースできますが、非常に意図的に行う必要があります。

シャドウツリーは、シャドウ DOM 内の DOM ツリーです。シャドウルートは、シャドウツリーのルートノードです。

:host 疑似クラスは、シャドウホスト要素である <star-rating> を選択します。シャドウホストは、シャドウ DOM がアタッチされている DOM ノードです。ホストの特定のバージョンのみをターゲットにするには、:host() を使用します。これにより、クラスや属性セレクタなど、渡されたパラメータに一致するシャドウホスト要素のみが選択されます。すべてのカスタム要素を選択するには、グローバル CSS で star-rating { /* styles */ } を使用するか、テンプレート スタイルで :host(:not(#nonExistantId)) を使用します。詳細度の観点から、グローバル CSS が優先されます。

::slotted() 疑似要素は、Shadow DOM 内から Shadow DOM の境界を越えます。セレクタに一致するスロット付き要素を選択します。この例では、::slotted(legend) は 3 つの凡例と一致します。

グローバル スコープの CSS からシャドウ DOM をターゲットにするには、テンプレートを編集する必要があります。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 */ }

part 名はクラスと同様に機能します。1 つの要素に複数の part 名をスペースで区切って指定でき、複数の要素に同じ part 名を指定できます。

Google には、カスタム要素を作成するための優れたチェックリストがあります。宣言型 Shadow DOM についても確認することをおすすめします。

理解度をチェックしましょう

テンプレート、スロット、シャドウに関する知識をテストします。

デフォルトでは、Shadow DOM の外側のスタイルが内側の要素に適用されます。

正しい。
もう一度お試しください。
誤り。
正解です。

<template> 要素の説明として正しいものはどれですか。

ページにコンテンツを表示するために使用される汎用要素。
もう一度お試しください。
プレースホルダ要素。
もう一度お試しください。
HTML のフラグメントを宣言するために使用される要素。デフォルトではレンダリングされません。
正解です。