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

Shadow DOM v1 - 自己完結型のウェブコンポーネント

ウェブデベロッパーは Shadow DOM を使用して、ウェブコンポーネント用の区分化された DOM と CSS を作成できます。

Eric Bidelman

概要

Shadow DOM は、ウェブアプリ構築における扱いにくさを取り除きます。扱いにくさは、HTML、CSS、および JS がグローバルであるという性質から生じます。この問題を回避するために、何年もかけて数多くのツールを開発してきました。たとえば、新しい HTML の id や class を使用するときに、ページで使用されている既存の名前と競合するかどうかは通知されません。些細なバグが少しずつ増えたり、CSS の特殊性が大きな問題となったり（!important による指定のすべて）、スタイルセレクターが制御不可能になったり、パフォーマンスが損なわれたりします。他にもまだまだあります。

Shadow DOM は CSS と DOM を修正します。ウェブプラットフォームにスコープ設定スタイルを導入します。ツールや命名規則がなくても、Vanilla JavaScript で CSS とマークアップをバンドルし、実装の詳細を非表示にして、自己完結型のコンポーネントを作成できます。

はじめに

Shadow DOM は、HTML テンプレート、Shadow DOM、カスタム要素という 3 つのウェブコンポーネント標準のうちの一つです。HTML インポートは以前はリストに含まれていましたが、現在は非推奨と見なされています。

Shadow DOM を使用するウェブコンポーネントを作成する必要はありません。ただし、作成する場合は、そのメリット（CSS スコープ、DOM カプセル化、コンポジション）を活用し、弾力性があり、適合性と再利用性が非常に高い再利用可能なカスタム要素を作成します。（JS API を使用して）新しい HTML を作成する方法としてカスタム要素を使用する場合、Shadow DOM はその HTML と CSS を提供する方法です。2 つの API を組み合わせて、自己完結型の HTML、CSS、および JavaScript でコンポーネントを作成します。

Shadow DOM は、コンポーネントベースのアプリを構築するためのツールとして設計されています。このため、ウェブ開発に共通の問題に、次のような解決策を提供します。

分離された DOM: コンポーネントの DOM は自己完結型です（たとえば、document.querySelector() はコンポーネントの Shadow DOM 内のノードを返しません）。
Scoped CSS: Shadow DOM 内で定義された CSS のスコープは、その Shadow DOM に設定されます。スタイルルールは DOM 外には適用されず、ページのスタイルが外部から適用されることもありません。
コンポジション: コンポーネント用の宣言型のマークアップベースの API を設計します。
CSS の簡素化 - スコープが設定された DOM とは、単純な CSS セレクター、より汎用的な id または class 名を使用することができ、名前の競合を心配する必要がないことを意味します。
生産性 - 1 つの大きな（グローバル）ページではなく、複数の DOM のチャンクでアプリを考えます。

`fancy-tabs` デモ

この記事では、デモコンポーネント（<fancy-tabs>）とそのコードスニペットについて説明します。お使いのブラウザが API をサポートしている場合は、すぐ下に API のライブデモが表示されます。表示されない場合は、GitHub で完全なソースを確認してください。

GitHub でソースを見る

Shadow DOM とは

DOM の背景

ウェブは HTML の使いやすさにより発展してきました。タグをいくつか宣言するだけで、表示と構造の両方を備えたページを数秒で作成できます。ただし、HTML だけではそれほど便利ではありません。人間にとって、テキストベースの言語を理解するのは簡単ですが、機械には助けが必要です。そこで登場するのがドキュメントオブジェクトモデル（DOM）です

ブラウザはウェブページを読み込む際、さまざまな特別な処理を行います。そのような処理の 1 つは、作成者の HTML をライブドキュメントに変換することです。基本的に、ブラウザは、ページの構造を理解するために、HTML（テキストの静的文字列）を解析してデータモデル（オブジェクトまたはノード）にします。ブラウザはこれらのノードのツリー、つまり DOM を作成して、HTML の階層を維持します。DOM の優れた点は、ページがライブで表現されていることです。私たちが作成する静的 HTML とは異なり、ブラウザによって生成されるノードには、プロパティとメソッドが含まれます。また、何よりもよいのは、プログラムで操作できることです。これが、JavaScript を使用して、直接 DOM 要素を作成できる理由です。

const header = document.createElement('header');
const h1 = document.createElement('h1');
h1.textContent = 'Hello DOM';
header.appendChild(h1);
document.body.appendChild(header);

このコードは、以下の HTML マークアップになります。

<body>
    <header>
    <h1>Hello DOM</h1>
    </header>
</body>

それで十分です。では、Shadow DOM とは一体なのでしょうか。

隠された DOM

Shadow DOM は単なる通常の DOM ですが、次の 2 つの点が異なっています。1）作成方法と使用方法、および 2）ページの残りの部分との関係でどのように動作するかです。通常は、DOM ノードを作成し、ノードを別の要素の子として追加します。Shadow DOM では、要素に追加されているが、その実際の子とは分離されている、スコープが設定された DOM ツリーを作成します。このスコープが設定されたサブツリーは、シャドーツリーと呼ばれます。Shadow ツリーが追加されている要素はShadow ホストです。<style> を含め、シャドウに追加したものはすべてホスティング要素に対してローカルになります。Shadow DOM はこのようにして CSS スタイルのスコープを設定します。

Shadow DOM の作成

Shadow ルートは、「ホスト」要素に追加されるドキュメントフラグメントです。Shadow ルートをアタッチすると、要素が Shadow DOM を取得します。要素の Shadow DOM を作成するには、element.attachShadow() を呼び出します。

const header = document.createElement('header');
const shadowRoot = header.attachShadow({mode: 'open'});
shadowRoot.innerHTML = '<h1>Hello Shadow DOM</h1>'; // Could also use appendChild().

// header.shadowRoot === shadowRoot
// shadowRoot.host === header

ここでは .innerHTML を使用して Shadow ルートに値を入力していますが、他の DOM API を使用することもできます。これがウェブです。選択肢はあります。

仕様では、Shadow ツリーをホストできない要素のリストが定義されています。要素がこのリストに含まれる理由は複数あります。

ブラウザには、要素用に独自の内部 Shadow DOM（<textarea>、<input>）がすでにホストされています。
その要素が Shadow DOM をホストするのは合理的でない（<img>）。

たとえば、これはうまくいきません。

    document.createElement('input').attachShadow({mode: 'open'});
    // Error. `<input>` cannot host shadow dom.

カスタム要素用に Shadow DOM を作成する

Shadow DOM は、カスタム要素を作成するときに特に役立ちます。Shadow DOM を使用して要素の HTML、CSS、および JS を区分化することで、「ウェブコンポーネント」を生成します。

例 - カスタム要素は Shadow DOM をそれ自体にアタッチし、DOM/CSS をカプセル化します。

// Use custom elements API v1 to register a new HTML tag and define its JS behavior
// using an ES6 class. Every instance of <fancy-tab> will have this same prototype.
customElements.define('fancy-tabs', class extends HTMLElement {
    constructor() {
    super(); // always call super() first in the constructor.

    // Attach a shadow root to <fancy-tabs>.
    const shadowRoot = this.attachShadow({mode: 'open'});
    shadowRoot.innerHTML = `
        <style>#tabs { ... }</style> <!-- styles are scoped to fancy-tabs! -->
        <div id="tabs">...</div>
        <div id="panels">...</div>
    `;
    }
    ...
});

興味深いことがいくつかあります。1 つ目は、<fancy-tabs> のインスタンスの作成時に、カスタム要素が独自の Shadow DOM を作成する点です。これは constructor() で行います。2 つ目は、Shadow ルートを作成しているため、<style> 内の CSS ルールのスコープが <fancy-tabs> に設定されることです。

コンポジションとスロット

コンポジションは、最もよく理解されていない Shadow DOM の機能の 1 つですが、間違いなく最も重要なものです。

ウェブ開発の世界では、コンポジションとは HTML から宣言的にアプリを構築する方法のことです。さまざまな構成要素（<div>、<header>、<form>、<input>）が集まって、アプリを構成します。これらのタグの中には、連携して動作するものもあります。<select>、<details>、<form>、<video> などのネイティブ要素の柔軟性が非常に高い理由は、コンポジションにあります。これらのタグはそれぞれ、特定の HTML を子として受け入れ、それらに特別な処理を行います。たとえば、<select> は <option> と <optgroup> をドロップダウンウィジェットと複数選択ウィジェットにレンダリングする方法を知っています。<details> 要素は、<summary> を展開可能な矢印としてレンダリングします。<video> でさえも、特定の子を処理することができます。<source> 要素はレンダリングされませんが、動画の動作に影響します。魔法のようですね！

用語: Light DOM と Shadow DOM

Shadow DOM のコンポジションにより、ウェブ開発に新しい基礎が加わりました。詳細を説明する前に、使用する用語を統一しておきましょう。

Light DOM

コンポーネントのユーザーが作成するマークアップです。この DOM は、コンポーネントの Shadow DOM の外側にあります。これは要素の実際の子です。

<better-button>
    <!-- the image and span are better-button's light DOM -->
    <img src="gear.svg" slot="icon">
    <span>Settings</span>
</better-button>

Shadow DOM

コンポーネント作成者が作成する DOM。Shadow DOM はコンポーネントにローカルで、その内部構造と Scoped CSS を定義し、実装の詳細をカプセル化します。また、コンポーネントの使用者が作成したマークアップをレンダリングする方法を定義することもできます。

#shadow-root
    <style>...</style>
    <slot name="icon"></slot>
    <span id="wrapper">
    <slot>Button</slot>
    </span>

フラット化された DOM ツリー

ブラウザが Shadow DOM の中にユーザーの Light DOM を配置した結果で、これにより最終生成物がレンダリングされます。フラット化されたツリーが、DevTools で最終的に表示され、ページにレンダリングされます。

<better-button>
    #shadow-root
    <style>...</style>
    <slot name="icon">
        <img src="gear.svg" slot="icon">
    </slot>
    <span id="wrapper">
        <slot>
        <span>Settings</span>
        </slot>
    </span>
</better-button>

<slot> 要素

Shadow DOM は、<slot> 要素を使用して複数の異なる DOM ツリーを合成します。スロットはコンポーネント内にあるプレースホルダで、ユーザーはこれに独自のマークアップを入力できます。1 つ以上のスロットを定義して、外部マークアップをコンポーネントの Shadow DOM 内でレンダリングされるように呼び込みます。基本的には、「ユーザーのマックアップをここでレンダリングしてください」と言っているのと同じです。

要素は、<slot> によって呼び込まれていれば、Shadow DOM の境界を「越える」ことができます。このような要素は分散ノードと呼ばれます。概念的には、分散ノードは少し奇妙に見えるかもしれません。スロットは物理的には DOM を動かさず、Shadow DOM 内の別の場所でレンダリングします。

コンポーネントはその Shadow DOM 内でゼロ個以上のスロットを定義できます。スロットは空にすることも、フォールバックコンテンツを提供することもできます。ユーザーが Light DOM コンテンツを提供していない場合、スロットはそのフォールバックコンテンツをレンダリングします。

<!-- Default slot. If there's more than one default slot, the first is used. -->
<slot></slot>

<slot>fallback content</slot> <!-- default slot with fallback content -->

<slot> <!-- default slot entire DOM tree as fallback -->
    <h2>Title</h2>
    <summary>Description text</summary>
</slot>

名前付きスロットを作成することもできます。名前付きスロットは、ユーザーが名前で参照する Shadow DOM の特定の穴です。

例 - <fancy-tabs> の Shadow DOM 内のスロット:

#shadow-root
    <div id="tabs">
    <slot id="tabsSlot" name="title"></slot> <!-- named slot -->
    </div>
    <div id="panels">
    <slot id="panelsSlot"></slot>
    </div>

コンポーネントユーザーは <fancy-tabs> を次のように宣言します。

<fancy-tabs>
    <button slot="title">Title</button>
    <button slot="title" selected>Title 2</button>
    <button slot="title">Title 3</button>
    <section>content panel 1</section>
    <section>content panel 2</section>
    <section>content panel 3</section>
</fancy-tabs>

<!-- Using <h2>'s and changing the ordering would also work! -->
<fancy-tabs>
    <h2 slot="title">Title</h2>
    <section>content panel 1</section>
    <h2 slot="title" selected>Title 2</h2>
    <section>content panel 2</section>
    <h2 slot="title">Title 3</h2>
    <section>content panel 3</section>
</fancy-tabs>

フラット化されるツリーは次のようになります。

<fancy-tabs>
    #shadow-root
    <div id="tabs">
        <slot id="tabsSlot" name="title">
        <button slot="title">Title</button>
        <button slot="title" selected>Title 2</button>
        <button slot="title">Title 3</button>
        </slot>
    </div>
    <div id="panels">
        <slot id="panelsSlot">
        <section>content panel 1</section>
        <section>content panel 2</section>
        <section>content panel 3</section>
        </slot>
    </div>
</fancy-tabs>

コンポーネントは複数の異なる構成を処理できますが、フラット化された DOM ツリーは変わらないことに注意してください。<button> から <h2> に切り替えることもできます。このコンポーネントは、<select> と同様に、異なる種類の子を処理するために作成されたものです。

スタイル設定

ウェブコンポーネントのスタイル設定には多数のオプションがあります。Shadow DOM を使用するコンポーネントのスタイルは、メインページで設定することも、独自のスタイルを定義することも、ユーザーが規定値をオーバーライドできるように、フックを（CSS カスタムプロパティの形式で）提供することもできます。

コンポーネント定義のスタイル

Shadow DOM の最も便利な機能は間違いなく Scoped CSS です。

外部ページからの CSS セレクターは、コンポーネント内部には適用されません。
内部で定義したスタイルは反映されない。これらのスコープはホスト要素に設定されています。

Shadow DOM 内で使用される CSS セレクタは、コンポーネントにローカルに適用されます。実際には、この場合もまた、ページの他の場所との競合を気にせずに、一般的な id または class 名を使用できるということです。CSS セレクターをより単純にすることが Shadow DOM 内でのベストプラクティスです。これはパフォーマンスの面でも優れています。

例 - Shadow ルートで定義されたスタイルはローカル

#shadow-root
    <style>
    #panels {
        box-shadow: 0 2px 2px rgba(0, 0, 0, .3);
        background: white;
        ...
    }
    #tabs {
        display: inline-flex;
        ...
    }
    </style>
    <div id="tabs">
    ...
    </div>
    <div id="panels">
    ...
    </div>

Shadow ツリーにはスタイルシートのスコープも適用されます。

#shadow-root
    <link rel="stylesheet" href="styles.css">
    <div id="tabs">
    ...
    </div>
    <div id="panels">
    ...
    </div>

multiple 属性を追加したときに、<select> 要素がどのように（プルダウンではなく）複数選択ウィジェットをレンダリングするのか、不思議に思ったことがあるかもしれません。

<select multiple>
  <option>Do</option>
  <option selected>Re</option>
  <option>Mi</option>
  <option>Fa</option>
  <option>So</option>
</select>

<select> は、宣言された属性に基づいて、それ自体を異なるスタイルに設定できます。ウェブコンポーネントも、:host セレクターを使用してそれ自身にスタイルを設定できます。

例 - それ自身にスタイルを設定するコンポーネント

<style>
:host {
    display: block; /* by default, custom elements are display: inline */
    contain: content; /* CSS containment FTW. */
}
</style>

:host に関する問題点の 1 つは、親ページのルールによる指定の優先度が、要素で定義されている :host ルールよりも高いことです。つまり、外部のスタイルが優先されます。このため、ユーザーは外部から最上位のスタイルをオーバーライドできます。また、:host は Shadow ルートのコンテキストでのみ機能するため、Shadow DOM の外部では使用できません。

:host(<selector>) の形式の関数を使用すると、ホストが <selector> に一致する場合に、ホストをターゲットにすることができます。これは、ホストに基づいてユーザー操作または状態、またはスタイルの内部ノードに反応する動作をコンポーネントがカプセル化するための優れた方法です。

<style>
:host {
    opacity: 0.4;
    will-change: opacity;
    transition: opacity 300ms ease-in-out;
}
:host(:hover) {
    opacity: 1;
}
:host([disabled]) { /* style when host has disabled attribute. */
    background: grey;
    pointer-events: none;
    opacity: 0.4;
}
:host(.blue) {
    color: blue; /* color host when it has class="blue" */
}
:host(.pink) > #tabs {
    color: pink; /* color internal #tabs node when host has class="pink". */
}
</style>

コンテキストに基づくスタイル設定

:host-context(<selector>) は、コンポーネントまたはそのいずれかの祖先が <selector> に一致する場合に、コンポーネントに一致します。一般的な用途は、コンポーネントの周囲に基づいたテーマ設定です。たとえば、多くの人が <html> または <body> にクラスを適用することで、テーマを設定しています。

<body class="darktheme">
    <fancy-tabs>
    ...
    </fancy-tabs>
</body>

:host-context(.darktheme) は、.darktheme の子孫である場合に <fancy-tabs> にスタイルを設定します。

:host-context(.darktheme) {
    color: white;
    background: black;
}

:host-context() はテーマの設定に役立ちますが、より優れた方法は、CSS カスタムプロパティを使用してスタイルフックを作成することです。

分散ノードのスタイル設定

::slotted(<compound-selector>) は、<slot> に分散されるノードに一致します。

名バッジコンポーネントを作成したとします。

<name-badge>
    <h2>Eric Bidelman</h2>
    <span class="title">
    Digital Jedi, <span class="company">Google</span>
    </span>
</name-badge>

コンポーネントの Shadow DOM は、ユーザーの <h2> と .title にスタイルを設定できます。

<style>
::slotted(h2) {
    margin: 0;
    font-weight: 300;
    color: red;
}
::slotted(.title) {
    color: orange;
}
/* DOESN'T WORK (can only select top-level nodes).
::slotted(.company),
::slotted(.title .company) {
    text-transform: uppercase;
}
*/
</style>
<slot></slot>

前述したように、<slot> はユーザーの Light DOM を移動しません。ノードが <slot> に分散されると、<slot> はその DOM をレンダリングしますが、ノードの実際の位置は変わりません。配信前に適用したスタイルは、配信後も引き続き適用されます。ただし、Light DOM が分散されている場合は、別のスタイル（Shadow DOM で定義されているスタイル）を使用できます。

<fancy-tabs> のより詳細な別の例を以下に示します。

const shadowRoot = this.attachShadow({mode: 'open'});
shadowRoot.innerHTML = `
    <style>
    #panels {
        box-shadow: 0 2px 2px rgba(0, 0, 0, .3);
        background: white;
        border-radius: 3px;
        padding: 16px;
        height: 250px;
        overflow: auto;
    }
    #tabs {
        display: inline-flex;
        -webkit-user-select: none;
        user-select: none;
    }
    #tabsSlot::slotted(*) {
        font: 400 16px/22px 'Roboto';
        padding: 16px 8px;
        ...
    }
    #tabsSlot::slotted([aria-selected="true"]) {
        font-weight: 600;
        background: white;
        box-shadow: none;
    }
    #panelsSlot::slotted([aria-hidden="true"]) {
        display: none;
    }
    </style>
    <div id="tabs">
    <slot id="tabsSlot" name="title"></slot>
    </div>
    <div id="panels">
    <slot id="panelsSlot"></slot>
    </div>
`;

この例では、タブのタイトル用の名前付きスロットと、タブパネルのコンテンツ用のスロットの 2 つのスロットがあります。ユーザーがタブを選択すると、選択されたタブが太字になり、そのパネルが表示されます。これは、selected 属性を持つ分散ノードを選択することによって行われます。カスタム要素の JS（ここには示していません）は、その属性を適切な時に追加します。

外部からのコンポーネントのスタイル設定

外部からコンポーネントのスタイルを設定するには、いくつかの方法があります。最も簡単な方法は、タグ名をセレクタとして使用する方法です。

fancy-tabs {
    width: 500px;
    color: red; /* Note: inheritable CSS properties pierce the shadow DOM boundary. */
}
fancy-tabs:hover {
    box-shadow: 0 3px 3px #ccc;
}

外側のスタイルは常に Shadow DOM で定義されたスタイルより優先されます。たとえば、ユーザーがセレクター fancy-tabs { width: 500px; } を作成すると、これがコンポーネントのルール :host { width: 650px;} より優先されます。

コンポーネント自体にスタイルを設定しても、コンポーネントにしか適用されません。コンポーネントの内部にスタイルを設定するには、どうすればよいでしょうか。これには、CSS カスタムプロパティが必要です。

CSS カスタムプロパティを使用してスタイルフックを作成する

コンポーネントの作成者が CSS カスタムプロパティを使用してスタイルフックを提供している場合、ユーザーは内部スタイルを調整できます。概念的には、このアイデアは <slot> に似ています。ユーザーがオーバーライドする「スタイルプレースホルダ」を作成する。

例 - <fancy-tabs> を使用すると、ユーザーが背景色をオーバーライドできます。

<!-- main page -->
<style>
    fancy-tabs {
    margin-bottom: 32px;
    --fancy-tabs-bg: black;
    }
</style>
<fancy-tabs background>...</fancy-tabs>

Shadow DOM の内部:

:host([background]) {
    background: var(--fancy-tabs-bg, #9E9E9E);
    border-radius: 10px;
    padding: 10px;
}

この場合、コンポーネントはユーザーが指定した値であるため、black を背景の値として使用します。それ以外の場合は、デフォルトで #9E9E9E になります。

高度なトピック

クローズド Shadow ルートの作成（非推奨）

Shadow DOM の別の特長は、「クローズド」モードと呼ばれます。クローズド Shadow ツリーを作成すると、外部の JavaScript はコンポーネントの内部 DOM にアクセスできなくなります。これは、<video> などのネイティブ要素の仕組みに似ています。JavaScript は <video> の Shadow DOM にアクセスできません。ブラウザは Shadow DOM をクローズドモードの Shadow ルートを使用して実装しているためです。

例 - クローズド Shadow ツリーの作成:

const div = document.createElement('div');
const shadowRoot = div.attachShadow({mode: 'closed'}); // close shadow tree
// div.shadowRoot === null
// shadowRoot.host === div

その他の API もクローズドモードの影響を受けます。

Element.assignedSlot / TextNode.assignedSlot で null が返されます
Shadow DOM 内の要素に関連付けられたイベントの Event.composedPath() が、[] を返します。

{mode: 'closed'} を使用してウェブコンポーネントを作成すべきではない理由を以下にまとめます。

うわべだけのセキュリティ。攻撃者が Element.prototype.attachShadow をハイジャックするのを止めることはできません。

クローズドモードでは、カスタム要素コードが独自の Shadow DOM にアクセスできないようにします。これは完全な間違いです。querySelector() などの要素を後で使用する必要がある場合は、その参照を隠しておかなければなりません。これはクローズドモードの本来の目的を完全に損なうものです。

    customElements.define('x-element', class extends HTMLElement {
    constructor() {
    super(); // always call super() first in the constructor.
    this._shadowRoot = this.attachShadow({mode: 'closed'});
    this._shadowRoot.innerHTML = '<div class="wrapper"></div>';
    }
    connectedCallback() {
    // When creating closed shadow trees, you'll need to stash the shadow root
    // for later if you want to use it again. Kinda pointless.
    const wrapper = this._shadowRoot.querySelector('.wrapper');
    }
    ...
});

クローズドモードでは、エンドユーザーに対するコンポーネントの柔軟性が低下します。ウェブコンポーネントを構築する際に、機能の追加を忘れることがいつかあります。構成オプション。ユーザーが希望するユースケース。内部ノード用の適切なスタイル設定フックを用意し忘れるケースがよく発生します。クローズドモードでは、ユーザーが既定値をオーバーライドしてスタイルを調整する方法はありません。コンポーネントの内部にアクセスできることは、非常に有用です。コンポーネントにユーザーの希望する機能がない場合、ユーザーは最終的に、コンポーネントをフォークするか、別のコンポーネントを探すか、自分自身でコンポーネントを作成するでしょう。

JS でのスロットの使用

Shadow DOM API は、スロットや分散ノードを使用するためのユーティリティを提供します。これは、カスタム要素を作成するときに役立ちます。

slotchange イベント

slotchange イベントは、スロットの分散ノードが変更されたときに発生します。たとえば、ユーザーが Light DOM から子を追加または削除した場合です。

const slot = this.shadowRoot.querySelector('#slot');
slot.addEventListener('slotchange', e => {
    console.log('light dom children changed!');
});

注: コンポーネントのインスタンスが最初に初期化されたときに、slotchange は呼び出されません。

Light DOM への他の種類の変更を監視するには、要素のコンストラクタで MutationObserver を設定します。

スロットでレンダリングされる要素

どの要素がスロットに関連付けられているのかを把握しておくと、便利な場合があります。スロットでレンダリングされる要素を確認するには、slot.assignedNodes() を呼び出します。{flatten: true} オプションでも、スロットのフォールバックコンテンツが返されます（分散されているノードがない場合）。

例として、次のような Shadow DOM があるとしましょう。

<slot><b>fallback content</b></slot>

用途	電話	結果
<my-component>コンポーネントテキスト</my-component>	`slot.assignedNodes();`	`[component text]`
<my-component></my-component>	`slot.assignedNodes();`	`[]`
<my-component></my-component>	`slot.assignedNodes({flatten: true});`	`[<b>fallback content</b>]`

要素が割り当てられているスロット

逆の質問に答えることもできます。element.assignedSlot を使用すると、要素が割り当てられているコンポーネントスロットがわかります。

Shadow DOM イベントモデル

イベントが発生して Shadow DOM の外に出ると、Shadow DOM が提供するカプセル化を維持するように、イベントのターゲットが調整されます。つまり、イベントは、Shadow DOM 内の内部要素ではなく、コンポーネントから発生したかのようにターゲットが再設定されます。イベントによっては、Shadow DOM の外には伝播しないものもあります。

シャドウ境界を越えるイベントは次のとおりです。

フォーカスイベント: blur、focus、focusin、focusout
マウスイベント: click、dblclick、mousedown、mouseenter、mousemove など
ホイールイベント: wheel
入力イベント: beforeinput、input
キーボードイベント: keydown、keyup
コンポジションイベント: compositionstart、compositionupdate、compositionend
DragEvent: dragstart、drag、dragend、drop など

ヒント

Shadow ツリーが開いている場合、event.composedPath() を呼び出すと、イベントが通過するノードの配列が返されます。

カスタムイベントを使用する

Shadow ツリーの内部ノードで呼び出されるカスタム DOM イベントは、そのイベントが composed: true フラグを使用して作成されたものでない限り、Shadow 境界の外には出てきません。

// Inside <fancy-tab> custom element class definition:
selectTab() {
    const tabs = this.shadowRoot.querySelector('#tabs');
    tabs.dispatchEvent(new Event('tab-select', {bubbles: true, composed: true}));
}

composed: false（デフォルト）の場合は、ユーザーは Shadow ルートの外部でイベントをリッスンできません。

<fancy-tabs></fancy-tabs>
<script>
    const tabs = document.querySelector('fancy-tabs');
    tabs.addEventListener('tab-select', e => {
    // won't fire if `tab-select` wasn't created with `composed: true`.
    });
</script>

フォーカスの処理

Shadow DOM のイベントモデルで説明したように、Shadow DOM 内で呼び出されるイベントは、ホスト要素から発生したように調整されます。たとえば、シャドールート内の <input> をクリックするとします。

<x-focus>
    #shadow-root
    <input type="text" placeholder="Input inside shadow dom">

focus イベントは、<input> ではなく <x-focus> から発生したかのように見えます。同様に、document.activeElement は <x-focus> になります。Shadow ルートが mode:'open' で作成された場合（クローズドモードを参照）、フォーカスされた内部ノードにもアクセスできます。

document.activeElement.shadowRoot.activeElement // only works with open mode.

出現する Shadow DOM のレベルが複数ある場合は（別のカスタム要素内のカスタム要素など）、activeElement を検出するために Shadow ルートを再帰的にドリルする必要があります。

function deepActiveElement() {
    let a = document.activeElement;
    while (a && a.shadowRoot && a.shadowRoot.activeElement) {
    a = a.shadowRoot.activeElement;
    }
    return a;
}

フォーカスの別のオプションとして delegatesFocus: true オプションがあります。これは、Shadow ツリー内の要素のフォーカス動作を展開します。

Shadow DOM 内のノードをクリックし、そのノードがフォーカス可能な領域でない場合、最初のフォーカス可能な領域がフォーカスされます。
Shadow DOM 内のノードがフォーカスされると、フォーカスされる要素に加え、ホストにも :focus が適用されます。

例 - delegatesFocus: true がフォーカス動作を変更する方法

<style>
    :focus {
    outline: 2px solid red;
    }
</style>

<x-focus></x-focus>

<script>
customElements.define('x-focus', class extends HTMLElement {
    constructor() {
    super(); // always call super() first in the constructor.

    const root = this.attachShadow({mode: 'open', delegatesFocus: true});
    root.innerHTML = `
        <style>
        :host {
            display: flex;
            border: 1px dotted black;
            padding: 16px;
        }
        :focus {
            outline: 2px solid blue;
        }
        </style>
        <div>Clickable Shadow DOM text</div>
        <input type="text" placeholder="Input inside shadow dom">`;

    // Know the focused element inside shadow DOM:
    this.addEventListener('focus', function(e) {
        console.log('Active element (inside shadow dom):',
                    this.shadowRoot.activeElement);
    });
    }
});
</script>

結果

上記は、<x-focus> がフォーカスされた場合（ユーザーによるクリック、タブ付き、focus() など）の結果です。「クリック可能な Shadow DOM テキスト」がクリックされているか、内部の <input>（autofocus を含む）がフォーカスされています。

delegatesFocus: false を設定した場合は、代わりに次のように表示されます。

delegatesFocus: false で、内部入力がフォーカスされています。 — `delegatesFocus: false` と内部の `<input>` がフォーカスされます。

delegatesFocus: false で、x-focus はフォーカスを取得します（tabindex='0' など）。 — `delegatesFocus: false` と `<x-focus>` がフォーカスを獲得します（例: `tabindex="0"` があります）。

delegatesFocus: false で、「クリック可能な Shadow DOM テキスト」がクリックされます（または要素の Shadow DOM 内の他の空の領域がクリックされます）。 — `delegatesFocus: false` と「クリック可能な Shadow DOM テキスト」がクリックされます（または要素の Shadow DOM 内の他の空の領域がクリックされます）。

ヒントとアドバイス

私は何年にもわたり、ウェブコンポーネントの作成について学んできました。これらのヒントは、コンポーネントの作成や Shadow DOM のデバッグに役立ちます。

CSS Containment を使用する

通常、ウェブコンポーネントのレイアウト、スタイル、ペイントはかなり自己完結型です。パフォーマンスを改善するために、:host で CSS 制限を使用します。

<style>
:host {
    display: block;
    contain: content; /* Boom. CSS containment FTW. */
}
</style>

継承可能なスタイルのリセット

継承可能なスタイル（background、color、font、line-height など）は、Shadow DOM でも引き続き継承されます。つまり、これらは既定で Shadow DOM の境界を越えます。新しい状態で開始する必要がある場合は、all: initial; を使用して、継承可能なスタイルが Shadow 境界を越えたときにスタイルを初期値にリセットします。

<style>
    div {
    padding: 10px;
    background: red;
    font-size: 25px;
    text-transform: uppercase;
    color: white;
    }
</style>

<div>
    <p>I'm outside the element (big/white)</p>
    <my-element>Light DOM content is also affected.</my-element>
    <p>I'm outside the element (big/white)</p>
</div>

<script>
const el = document.querySelector('my-element');
el.attachShadow({mode: 'open'}).innerHTML = `
    <style>
    :host {
        all: initial; /* 1st rule so subsequent properties are reset. */
        display: block;
        background: white;
    }
    </style>
    <p>my-element: all CSS properties are reset to their
        initial value using <code>all: initial</code>.</p>
    <slot></slot>
`;
</script>

ページで使用されるすべてのカスタム要素の検出

ページで使用されているカスタム要素を検出すると便利な場合があります。これを行うには、ページで使用されているすべての要素の Shadow DOM を再帰的に走査する必要があります。

const allCustomElements = [];

function isCustomElement(el) {
    const isAttr = el.getAttribute('is');
    // Check for <super-button> and <button is="super-button">.
    return el.localName.includes('-') || isAttr && isAttr.includes('-');
}

function findAllCustomElements(nodes) {
    for (let i = 0, el; el = nodes[i]; ++i) {
    if (isCustomElement(el)) {
        allCustomElements.push(el);
    }
    // If the element has shadow DOM, dig deeper.
    if (el.shadowRoot) {
        findAllCustomElements(el.shadowRoot.querySelectorAll('*'));
    }
    }
}

findAllCustomElements(document.querySelectorAll('*'));

<template> からの要素の作成

.innerHTML を使用してシャドウルートを設定する代わりに、宣言型の <template> を使用できます。テンプレートは、ウェブコンポーネントの構造を宣言するために理想的なプレースホルダです。

カスタム要素: 再利用可能なウェブコンポーネントの構築の例をご覧ください。

履歴とブラウザのサポート

過去数年間にわたりウェブコンポーネントを使用していれば、しばらく前から Chrome 35+ と Opera に古いバージョンの Shadow DOM が付属していたことをご存じでしょう。Blink はしばらくの間、両方のバージョンのサポートを続けます。v0 仕様では、Shadow ルートを作成するための異なるメソッド（v1 の element.attachShadow ではなく element.createShadowRoot）が提供されていました。古いメソッドを呼び出すと、引き続き v0 セマンティックで Shadow ルートが作成されるため、既存の v0 コードに問題は発生しません。

古い v0 の仕様に興味がある場合は、html5rocks の記事（1、2、3）をご覧ください。Shadow DOM v0 と v1 の違いを説明した優れた記事もあります。

ブラウザサポート

Shadow DOM v1 は、Chrome 53（ステータス）、Opera 40、Safari 10、Firefox 63 でリリースされています。Edge では開発が開始しています。

Shadow DOM の機能を検出するには、attachShadow が存在するかどうかを確認します。

const supportsShadowDOMV1 = !!HTMLElement.prototype.attachShadow;

ポリフィル

ブラウザサポートが広く普及するまでは、shadydom と shadycss のポリフィルを使用して v1 機能を使用できます。Shady DOM は Shadow DOM の DOM スコープの設定、shadycss Polyfill の CSS カスタムプロパティ、ネイティブ API が提供するスタイルのスコープ設定を模倣します。

Polyfill をインストールします。

bower install --save webcomponents/shadydom
bower install --save webcomponents/shadycss

Polyfill の使用:

function loadScript(src) {
    return new Promise(function(resolve, reject) {
    const script = document.createElement('script');
    script.async = true;
    script.src = src;
    script.onload = resolve;
    script.onerror = reject;
    document.head.appendChild(script);
    });
}

// Lazy load the polyfill if necessary.
if (!supportsShadowDOMV1) {
    loadScript('/bower_components/shadydom/shadydom.min.js')
    .then(e => loadScript('/bower_components/shadycss/shadycss.min.js'))
    .then(e => {
        // Polyfills loaded.
    });
} else {
    // Native shadow dom v1 support. Go to go!
}

スタイルのシムやスコープの設定方法の詳細については、https://github.com/webcomponents/shadycss#usage をご覧ください。

まとめ

初めて、適切な CSS スコープと DOM スコープを設定し、真のコンポジションを持つ API プリミティブが完成しました。カスタム要素などの他のウェブコンポーネント API と組み合わせることで、Shadow DOM は、ハックや <iframe> などの古い要素を使用することなく、真にカプセル化されたコンポーネントを作成する方法を提供します。

誤解しないでください。Shadow DOM は、間違いなく複雑で、使いこなすのは大変です。しかし、努力して使い方を習得するだけの価値はあります。しばらく使ってみてください。使い方を学んで、質問しましょう。

よくある質問

今すぐ Shadow DOM v1 を使用できますか？

ポリフィルを使えば可能です。ブラウザのサポートをご覧ください。

Shadow DOM にはどのようなセキュリティ機能がありますか。

Shadow DOM はセキュリティ機能ではありません。CSS のスコープを設定し、コンポーネントの DOM ツリーを非表示にするための軽量なツールです。真のセキュリティ境界が必要な場合は、<iframe> を使用します。

ウェブコンポーネントでは Shadow DOM を使用しなければならないのですか？

いいえ。Shadow DOM を使用するウェブコンポーネントを作成する必要はありません。ただし、Shadow DOM を使用するカスタム要素を作成すると、CSS スコープ、DOM のカプセル化、コンポジションといった機能を利用できるようになります。

開いている Shadow ツリーと閉じた Shadow ツリーの違いは何ですか？

クローズド Shadow ルートをご覧ください。