2日 五月 2020

Shadow DOMとイベント

shadow ツリーの背後にあるアイデアは、コンポーネント内部の実装の詳細をカプセル化することにあります。

例えば、クリックイベントがshadow DOMの<user-card>コンポーネント内で発生したとします。しかしメインドキュメント内のスクリプトはshadow DOM内部については何も知りません。特にコンポーネントがサードパーティライブラリから来たものである場合はなおさらです。

なので、詳細をカプセル化したままにするために、ブラウザはイベントをリターゲティングします。

shadow DOM内で発生するイベントがコンポーネントの外でキャッチされると、そのイベントはターゲットとしてShadowホスト要素を持ちます。

<user-card></user-card>

<script>
customElements.define('user-card', class extends HTMLElement {
  connectedCallback() {
    this.attachShadow({mode: 'open'});
    this.shadowRoot.innerHTML = `<p>
      <button>Click me</button>
    </p>`;
    this.shadowRoot.firstElementChild.onclick =
      e => alert("Inner target: " + e.target.tagName);
  }
});

document.onclick =
  e => alert("Outer target: " + e.target.tagName);
</script>

ボタンをクリックした場合、そのメッセージは:

  1. 内部ターゲット: BUTTON – 内部イベントハンドラーは適切なターゲット、shadow DOM内の要素を取得します。

  2. 外部ターゲット: USER-CARD – ドキュメントイベントハンドラーはターゲットとしてShadow ホストを取得します。

イベントリターゲティングは、外部ドキュメントがコンポーネントの内部について知らなくてもいいので、素晴らしいものです。この観点から、イベントは<user-card>に起こります。

リターゲティングは、物理的にlight DOM内に存在するスロット化された要素上でイベントが起こった場合には発生しません。 例えば、ユーザーが以下の例の<span slot="username">をクリックした場合、shadowハンドラー とlightハンドラーの両方で、イベントターゲットはまさにこのspan要素になります。

<user-card id="userCard">
  <span slot="username">John Smith</span>
</user-card>

<script>
customElements.define('user-card', class extends HTMLElement {
  connectedCallback() {
    this.attachShadow({mode: 'open'});
    this.shadowRoot.innerHTML = `<div>
      <b>Name:</b> <slot name="username"></slot>
    </div>`;

    this.shadowRoot.firstElementChild.onclick =
      e => alert("Inner target: " + e.target.tagName);
  }
});

userCard.onclick = e => alert(`Outer target: ${e.target.tagName}`);
</script>

クリックが"John Smith"で起こった場合は、内部と外部のハンドラーのターゲットは<span slot="username">になります。それはlight DOMからの要素なので、リターゲティングはありません。 その一方で、クリックが<b>Name</b>のような shadow DOMにある要素で発生した場合, shadow DOMの外にバブルするので、そのevent.target<user-card>にセットし直されます。

バブリング、 event.composedPath()

イベントバブリングでは、フラット化されたDOMが使用されます。 したがって、スロット化された要素が存在し、その中のどこかでイベントが発生した場合、そのイベントは<slot>まで上方にバブリングします。 全てのshadow要素を含む、オリジナルのイベントターゲットへの絶対パスは、event.composedPath()を使用して取得できます。このメソッドの名前から分かる通り、そのパスは合成後に取得されます。

上記の例では、フラット化されたDOMは:

<user-card id="userCard">
  #shadow-root
    <div>
      <b>Name:</b>
      <slot name="username">
        <span slot="username">John Smith</span>
      </slot>
    </div>
</user-card>

なので、<span slot="username">のクリックで、event.composedPath()の呼び出しは配列[span, slot, div, shadow-root, user-card, body, html, document, window]を返します。これがまさに合成後のフラット化されたDOM内でのターゲット要素から親へのチェーンのことです。

Shadow ツリーの詳細は {mode:'open'} ツリーにのみ提供されます

Shadow ツリーが{mode: 'closed'}で作られた場合、その合成パスはホスト: user-cardとその上部から始まります。 これはshadow DOMと作用する他のメソッドと同様の原理です。閉じたツリーの内部は完璧に隠されています。

event.composed

ほとんどのイベントはshadow DOMの境界を通してバブルします。しかしイベントの中にはこのルールに従わないものもあります。

これはcomposedイベントオブジェクトプロパティによって管理されます。trueの場合は、イベントは境界を超えます。そうでない場合は、shadow DOM内からのみ取得できます。 UI Events 仕様をご覧いただくと、ほとんどのイベントはcomposed: trueです。:

  • blur, focus, focusin, focusout,
  • click, dblclick,
  • mousedown, mouseup mousemove, mouseout, mouseover,
  • wheel,
  • beforeinput, input, keydown, keyup.

全てのタッチイベントとポインターは、composed: trueです。

イベントの中にはcomposed: falseのものもありますが:

  • mouseenter, mouseleave (これらは全くバブルしません),
  • load, unload, abort, error,
  • select,
  • slotchange.

これらのイベントはイベントターゲットが属する同じDOM内の要素でのみキャッチされます。

カスタムイベント

カスタムイベントをディスパッチすると、コンポーネントの外にバブルさせるためにbubblescomposedの両方のプロパティをtrueに設定する必要があります。

例えば、ここではdiv#outerのshadow DOMにdiv#innerを作成し、二つのイベントを発火します。composed: trueをもつイベントのみがドキュメントの外にバブルします。:

<div id="outer"></div>

<script>
outer.attachShadow({mode: 'open'});

let inner = document.createElement('div');
outer.shadowRoot.append(inner);

/*
div(id=outer)
  #shadow-dom
    div(id=inner)
*/

document.addEventListener('test', event => alert(event.detail));

inner.dispatchEvent(new CustomEvent('test', {
  bubbles: true,
  composed: true,
  detail: "composed"
}));

inner.dispatchEvent(new CustomEvent('test', {
  bubbles: true,
  composed: false,
  detail: "not composed"
}));
</script>

サマリ

composedフラグがtrueに設定されている場合にのみ、イベントはshadow DOM境界を超えます。 組み込みのイベントは、関連する仕様に記載されている通り、ほとんどの場合composed: trueです:

組み込みイベントの中にはcomposed: falseのものもあります:

  • mouseenter, mouseleave (バブルしません),
  • load, unload, abort, error,
  • select,
  • slotchange.

これらのイベントは同じDOM内の要素でのみキャッチできます。

CustomEventをディスパッチする場合は、明確にcomposed: trueを設定するべきです。

ネストされたコンポーネント、ある shadow DOM が別の shadow DOM にネストされる場合があることに注意してください。この場合、合成されたイベントはすべての shadow DOM 境界をバブルします。したがって、もしイベントが直接囲んでいるコンポーネントだけを意図している場合は、そのイベントを shadow ホストにディスパッチして、composed: false にすることもできます。すると、イベントはコンポーネントのシャドウDOMの外にありますが、上位レベルのDOMにバブルすることはありません。

チュートリアルマップ

コメント

コメントをする前に読んでください…
  • 自由に記事への追加や質問を投稿をしたり、それらに回答してください。
  • 数語のコードを挿入するには、<code> タグを使ってください。複数行の場合は <pre> を、10行を超える場合にはサンドボックスを使ってください(plnkr, JSBin, codepen…)。
  • 記事の中で理解できないことがあれば、詳しく説明してください。