このページは Cloud Translation API によって翻訳されました。

宣言型の Shadow DOM

Jason Miller

Mason Freed

宣言型 Shadow DOM は、標準のウェブプラットフォーム機能であり、Chrome バージョン 90 以降でサポートされています。この機能の仕様は 2023 年に変更されました（shadowroot の shadowrootmode への名前変更など）。この機能のすべての部分の最新の標準化されたバージョンは Chrome バージョン 124 でリリースされています。

対応ブラウザ

ソース

Shadow DOM は 3 つの Web Components 標準の一つであり、HTML テンプレートとカスタム要素によって丸められています。Shadow DOM は、CSS スタイルのスコープを特定の DOM サブツリーに制限し、そのサブツリーをドキュメントの他の部分から分離する方法を提供します。<slot> 要素を使用すると、カスタム要素の子をシャドウツリー内のどこに挿入するかを制御できます。これらの機能を組み合わせることで、組み込みの HTML 要素と同様に、既存のアプリケーションにシームレスに統合される、自己完結型の再利用可能なコンポーネントを構築できます。

これまでは、Shadow DOM を使用するには、JavaScript を使用して Shadow ルートを構築する必要がありました。

const host = document.getElementById('host');
const shadowRoot = host.attachShadow({mode: 'open'});
shadowRoot.innerHTML = '<h1>Hello Shadow DOM</h1>';

このような命令型 API は、クライアントサイドレンダリングに適しています。カスタム要素を定義する JavaScript モジュールがシャドウルートを作成し、コンテンツを設定します。ただし、多くのウェブアプリケーションでは、コンテンツをサーバーサイドでレンダリングするか、ビルド時に静的 HTML にレンダリングする必要があります。これは、JavaScript を実行できない可能性のあるユーザーに適切なエクスペリエンスを提供するうえで重要な要素となります。

サーバーサイドレンダリング（SSR）を行う理由は、プロジェクトによって異なります。ウェブサイトによっては、ユーザー補助ガイドラインを満たすために、完全に機能するサーバーレンダリング HTML を提供する必要があります。また、低速の接続やデバイスで優れたパフォーマンスを確保するために、JavaScript を使用しない基本的なエクスペリエンスを提供することを選択するウェブサイトもあります。

サーバーで生成された HTML に Shadow Root を表現する方法が組み込まれていなかったため、従来は Shadow DOM とサーバーサイドレンダリングを組み合わせて使用することは困難でした。Shadow ルートなしですでにレンダリングされている DOM 要素に Shadow Root をアタッチする場合も、パフォーマンスに影響します。これにより、ページの読み込み後にレイアウトがずれたり、Shadow Root のスタイルシートの読み込み中に、スタイルが設定されていないコンテンツ（「FOUC」）が一時的に表示される原因となったりすることがあります。

宣言型 Shadow DOM（DSD）では、この制限が解除され、Shadow DOM がサーバーに移行されます。

宣言型シャドウルートを作成する方法

宣言型シャドウルートは、shadowrootmode 属性を持つ <template> 要素です。

<host-element>
  <template shadowrootmode="open">
    <slot></slot>
  </template>
  <h2>Light content</h2>
</host-element>

shadowrootmode 属性を持つテンプレート要素が HTML パーサーによって検出され、親要素のシャドウルートとしてすぐに適用されます。上記のサンプルの純粋な HTML マークアップを読み込むと、次のような DOM ツリーが生成されます。

<host-element>
  #shadow-root (open)
  <slot>
    ↳
    <h2>Light content</h2>
  </slot>
</host-element>

このコードサンプルは、Shadow DOM コンテンツを表示するための Chrome DevTools の [Elements] パネルの規則に従っています。たとえば、↳ 文字はスロット化された Light DOM コンテンツを表します。

これにより、静的 HTML で Shadow DOM のカプセル化とスロット投影のメリットが得られます。シャドウルートを含むツリー全体を生成するために JavaScript は必要ありません。

成分水分補給

宣言型 Shadow DOM は、スタイルをカプセル化したり、子要素の配置をカスタマイズしたりする方法として単独で使用できますが、カスタム要素と組み合わせて使用すると最も強力です。カスタム要素を使用して作成されたコンポーネントは、静的 HTML から自動的にアップグレードされます。宣言型 Shadow DOM の導入により、アップグレード前にカスタム要素に Shadow ルートを設定できるようになりました。

宣言型シャドウルートを含む HTML からアップグレードされるカスタム要素には、そのシャドウルートがすでにアタッチされています。つまり、コードで明示的に作成しなくても、要素のインスタンス化の時点では、すでに利用可能な shadowRoot プロパティが要素に含まれます。要素のコンストラクタで、既存のシャドールートがあるかどうか this.shadowRoot で確認することをおすすめします。値がすでにある場合、このコンポーネントの HTML には宣言型シャドウルートがあります。値が null の場合は、HTML に宣言型 Shadow Root が存在しないか、ブラウザで宣言型 Shadow DOM がサポートされていません。

<menu-toggle>
  <template shadowrootmode="open">
    <button>
      <slot></slot>
    </button>
  </template>
  Open Menu
</menu-toggle>
<script>
  class MenuToggle extends HTMLElement {
    constructor() {
      super();

      // Detect whether we have SSR content already:
      if (this.shadowRoot) {
        // A Declarative Shadow Root exists!
        // wire up event listeners, references, etc.:
        const button = this.shadowRoot.firstElementChild;
        button.addEventListener('click', toggle);
      } else {
        // A Declarative Shadow Root doesn't exist.
        // Create a new shadow root and populate it:
        const shadow = this.attachShadow({mode: 'open'});
        shadow.innerHTML = `<button><slot></slot></button>`;
        shadow.firstChild.addEventListener('click', toggle);
      }
    }
  }

  customElements.define('menu-toggle', MenuToggle);
</script>

カスタム要素は以前から存在していますが、これまでは attachShadow() を使用して作成する前に、既存のシャドウルートを確認する理由はありませんでした。宣言型 Shadow DOM には、既存のコンポーネントが機能できるようにするための小さな変更が含まれています。既存の宣言型 Shadow Root を持つ要素で attachShadow() メソッドを呼び出しても、エラーはスローされません。代わりに、宣言型シャドウルートが空にされて返されます。これにより、宣言型 Shadow DOM 用にビルドされていない古いコンポーネントも引き続き動作します。これは、命令型の置換が作成されるまで宣言型ルートが保持されるためです。

新たに作成されたカスタム要素では、新しい ElementInternals.shadowRoot プロパティを使用して、要素の既存の宣言型シャドウルート（開いた状態と閉じた状態の両方）への参照を明示的に取得できます。これを使用すると、宣言型シャドウルートを確認して使用できますが、宣言型ルートが指定されていない場合は attachShadow() にフォールバックできます。

class MenuToggle extends HTMLElement {
  constructor() {
    super();

    const internals = this.attachInternals();

    // check for a Declarative Shadow Root:
    let shadow = internals.shadowRoot;

    if (!shadow) {
      // there wasn't one. create a new Shadow Root:
      shadow = this.attachShadow({
        mode: 'open'
      });
      shadow.innerHTML = `<button><slot></slot></button>`;
    }

    // in either case, wire up our event listener:
    shadow.firstChild.addEventListener('click', toggle);
  }
}

customElements.define('menu-toggle', MenuToggle);

ルートごとに 1 つのシャドウ

宣言型シャドウルートは、その親要素にのみ関連付けられます。つまり、シャドウルートは常に関連する要素と同じ場所に配置されます。この設計上の決定により、シャドウルートも HTML ドキュメントの他の部分と同じようにストリーミング可能になります。また、要素にシャドウルートを追加する際に、既存のシャドウルートのレジストリを維持する必要がないため、作成と生成にも便利です。

シャドウルートを親要素に関連付けるトレードオフは、同じ宣言型シャドウルート <template> から複数の要素を初期化できないことです。ただし、宣言型 Shadow DOM が使用されているほとんどのケースでは、各 Shadow ルートの内容がほとんど同一ではないため、この点で問題が生じる可能性はほとんどありません。サーバーでレンダリングされる HTML は多くの場合、繰り返しの要素構造を含みますが、テキストや属性がわずかに異なるなど、通常はコンテンツが多少異なります。シリアル化された宣言型シャドウルートのコンテンツは完全に静的であるため、1 つの宣言型シャドウルートから複数の要素をアップグレードできるのは、要素が偶然同じである場合のみです。最後に、類似したシャドウルートの繰り返しがネットワーク転送サイズに与える影響は、圧縮の影響により比較的小さくなります。

将来的には、共有シャドウルートを再検討できるようになる可能性があります。DOM が組み込みのテンプレートをサポートしている場合、宣言型シャドウルートは、特定の要素のシャドウルートを構築するためにインスタンス化されるテンプレートとして扱うことができます。現在の宣言型 Shadow DOM の設計では、シャドウルートの関連付けを単一の要素に限定することで、将来的にこの可能性を実現できます。

ストリーミングは便利

宣言型シャドウルートを親要素に直接関連付けると、アップグレードしてその要素にアタッチするプロセスが簡単になります。宣言型シャドウルートは HTML の解析中に検出され、開始 <template> タグが検出されるとすぐに添付されます。<template> 内で解析された HTML は Shadow ルートに直接解析されるため、「ストリーミング」できます。つまり、受信された順にレンダリングされます。

<div id="el">
  <script>
    el.shadowRoot; // null
  </script>

  <template shadowrootmode="open">
    <!-- shadow realm -->
  </template>

  <script>
    el.shadowRoot; // ShadowRoot
  </script>
</div>

パーサーのみ

宣言型 Shadow DOM は HTML パーサーの機能です。つまり、宣言型シャドウルートは、HTML 解析時に存在する shadowrootmode 属性を持つ <template> タグに対してのみ解析され、添付されます。つまり、宣言型シャドウルートを HTML の最初の解析中に作成できます。

<some-element>
  <template shadowrootmode="open">
    shadow root content for some-element
  </template>
</some-element>

<template> 要素の shadowrootmode 属性を設定しても何も起こらず、テンプレートは通常のテンプレート要素のままです。

const div = document.createElement('div');
const template = document.createElement('template');
template.setAttribute('shadowrootmode', 'open'); // this does nothing
div.appendChild(template);
div.shadowRoot; // null

重要なセキュリティ上の考慮事項を回避するため、宣言型シャドウルートを innerHTML や insertAdjacentHTML() などのフラグメント解析 API を使用して作成することもできません。宣言型シャドウルートが適用された HTML を解析する唯一の方法は、setHTMLUnsafe() または parseHTMLUnsafe() を使用することです。

<script>
  const html = `
    <div>
      <template shadowrootmode="open"></template>
    </div>
  `;
  const div = document.createElement('div');
  div.innerHTML = html; // No shadow root here
  div.setHTMLUnsafe(html); // Shadow roots included
  const newDocument = Document.parseHTMLUnsafe(html); // Also here
</script>

スタイルを使用したサーバーレンダリング

インラインスタイルシートと外部スタイルシートは、標準の <style> タグと <link> タグを使用する宣言型シャドウルート内で完全にサポートされています。

<nineties-button>
  <template shadowrootmode="open">
    <style>
      button {
        color: seagreen;
      }
    </style>
    <link rel="stylesheet" href="/comicsans.css" />
    <button>
      <slot></slot>
    </button>
  </template>
  I'm Blue
</nineties-button>

この方法で指定するスタイルは高度に最適化されています。つまり、同じスタイルシートが複数の宣言型シャドウルートに存在する場合でも、読み込みと解析は一度だけ実行されます。ブラウザは、すべてのシャドールートによって共有される単一のバッキング CSSStyleSheet を使用するため、メモリの重複オーバーヘッドがなくなります。

構成可能なスタイルシートは宣言型 Shadow DOM ではサポートされていません。これは、現在のところ、コンストラクタブルスタイルシートを HTML でシリアル化する方法がなく、adoptedStyleSheets の入力時にそれらを参照する方法がないためです。

スタイル設定されていないコンテンツのフラッシュを回避する方法

宣言型 Shadow DOM にまだ対応していないブラウザでは、「スタイル化されていないコンテンツのフラッシュ」（FOUC）が回避される可能性があります。これは、まだアップグレードされていないカスタム要素に未加工のコンテンツが表示されることです。宣言型 Shadow DOM が導入される前は、FOUC を回避する一般的な手法の 1 つとして、まだ読み込まれていないカスタム要素に display:none スタイルルールを適用していました。カスタム要素には Shadow ルートが追加されておらず、データが入力されていないためです。これにより、コンテンツが「準備完了」になるまで表示されなくなります。

<style>
  x-foo:not(:defined) > * {
    display: none;
  }
</style>

宣言型 Shadow DOM の導入により、カスタム要素を HTML でレンダリングまたは作成できるため、クライアントサイドコンポーネントの実装が読み込まれる前に、シャドウコンテンツが配置され、準備が整います。

<x-foo>
  <template shadowrootmode="open">
    <style>h2 { color: blue; }</style>
    <h2>shadow content</h2>
  </template>
</x-foo>

この場合、display:none の「FOUC」ルールにより、宣言型シャドウルートのコンテンツが表示されなくなります。ただし、このルールを削除すると、宣言型 Shadow DOM のサポートがないブラウザでは、宣言型 Shadow DOM のポリフィルが読み込まれて実際の Shadow ルートに変換されるまで、誤ったコンテンツやスタイルが設定されていないコンテンツが表示されます。

幸い、FOUC スタイルルールを変更することで、CSS でこの問題を解決できます。宣言型 Shadow DOM をサポートするブラウザでは、<template shadowrootmode> 要素はすぐに Shadow ルートに変換されるため、DOM ツリーに <template> 要素は残りません。宣言型 Shadow DOM をサポートしていないブラウザでは、<template> 要素が保持されます。この要素を使用して FOUC を防ぐことができます。

<style>
  x-foo:not(:defined) > template[shadowrootmode] ~ *  {
    display: none;
  }
</style>

改訂された「FOUC」ルールでは、まだ定義されていないカスタム要素を非表示にする代わりに、<template shadowrootmode> 要素の後に続く子要素を非表示にします。カスタム要素が定義されると、そのルールは一致しなくなります。HTML 解析中に <template shadowrootmode> の子が削除されるため、宣言型 Shadow DOM をサポートしているブラウザでは、このルールは無視されます。

機能検出とブラウザサポート

宣言型 Shadow DOM は Chrome 90 と Edge 91 以降で利用できますが、標準化された shadowrootmode 属性ではなく、shadowroot という標準以外の古い属性が使用されていました。新しい shadowrootmode 属性とストリーミング動作は、Chrome 111 と Edge 111 で使用できます。

宣言型 Shadow DOM は新しいウェブプラットフォーム API であるため、まだすべてのブラウザで広くサポートされていません。ブラウザのサポートは、HTMLTemplateElement のプロトタイプに shadowRootMode プロパティが存在するかどうかをチェックすることで検出できます。

function supportsDeclarativeShadowDOM() {
  return HTMLTemplateElement.prototype.hasOwnProperty('shadowRootMode');
}

ポリフィル

ポリフィルは、ブラウザ実装が懸念するタイミングのセマンティクスやパーサー専用特性を完全に再現する必要がないため、宣言型 Shadow DOM 用の簡素なポリフィルを構築するのは比較的簡単です。宣言型 Shadow DOM をポリフィルするには、DOM をスキャンしてすべての <template shadowrootmode> 要素を見つけ、親要素に付加された Shadow ルートに変換します。このプロセスは、ドキュメントの準備ができたら実行することも、カスタム要素のライフサイクルなど、より具体的なイベントによってトリガーすることもできます。

(function attachShadowRoots(root) {
  root.querySelectorAll("template[shadowrootmode]").forEach(template => {
    const mode = template.getAttribute("shadowrootmode");
    const shadowRoot = template.parentNode.attachShadow({ mode });

    shadowRoot.appendChild(template.content);
    template.remove();
    attachShadowRoots(shadowRoot);
  });
})(document);