この翻訳は不完全です。英語から この記事を翻訳 してください。

Web Components は、再利用可能なカスタム要素を作成し、ウェブアプリの中で利用するための、一連のテクノロジーです。コードの他の部分から独立した、カプセル化された機能を使って実現します。 

概念と使用法

 

開発者ならご存知でしょうが、可能な限りコードを再利用することは良い考えです。しかし、以前から、カスタムのマークアップ構造体にとって、コードの再利用はそれほど簡単なことではありませんでした。複雑な HTML (と一連のスタイルやスクリプト) を考えてみて下さい。ときに、カスタム UI の制御をレンダリングするために、コードを書かなければなりません。それに、注意していないと、それらの制御をどう使い回すかで、ページが複雑なものになってしまいます。

Web Components は、上記の問題の解決を目指しています。 Web Components は、3 つの主要な技術からなり、それらを組み合わせて、多目的なカスタム要素を作成します。カプセル化された機能を使うことで、コードの重複を恐れることなく、どこでも再利用することができます。

  • カスタム要素: カスタム要素とその動作を定義するための、一連の JavaScript API です。以降、ユーザーインターフェースの中で好きなだけ使用することができます。
  • Shadow DOM: カプセル化された "Shadow" DOM ツリーを要素に紐付け、関連する機能を制御するための、一連の JavaScript API です。 Shadow DOM ツリーは、メインドキュメントの DOM とは別にレンダリングされます。こうして、要素の機能を公開せずに済み、ドキュメントの他の部分との重複を恐れることなく、スクリプト化やスタイル化できます。
  • HTML テンプレート: <template> と <slot> 要素によって、レンダリングされたページ内に表示されないマークアップのテンプレートを書くことができます。カスタム要素の構造体の基礎として、それらを何度も再利用できます。

Web Component を実装する基本的な流れは、以下に挙げてある通りです。

  1. Web Component の機能を明示したクラスもしくは関数を作成します。クラスを使用するなら、ECMAScript 2015 のクラスの文法に従って下さい。 (詳細はクラスを参照して下さい。)
  2. 新しく作成したカスタム要素を登録します。CustomElementRegistry.define() メソッドに、要素の名前、機能が明示されているクラスもしくは関数、またオプションでどの要素を継承するかを渡して下さい。
  3. 必要なら、Element.attachShadow() メソッドを使って、Shadow DOM をカスタム要素に紐付けます。通常の DOM メソッドを使って、子要素やイベントリスナーなどをShadow DOM に追加して下さい。
  4. 必要なら、<template> と <slot> を使って、HTML テンプレートを定義します。通常の DOM メソッドを再度使って、テンプレートをクローンし、Shadow DOM に紐付けてください。
  5. ページ内のお好きな場所で、通常の HTML 要素のように、カスタム要素を使って下さい。

チュートリアル

カスタム要素を使ってみよう
単純な Web Component を作成するために、カスタム要素の機能の使い方を紹介したガイドラインです。それ以外にも、ライフサイクルコールバックやその他の高度な機能の中を覗いていきます。
Shadow DOM を使ってみよう
Shadow DOM の基礎を眺めるガイドラインです。 Shadow DOM を要素にどう紐付けるか、Shadow DOM ツリーにどう追加するか、どうスタイルするかなどを紹介しています。
テンプレートとスロットを使ってみよう
<template> と <slot> 要素を使って、再利用可能な HTML 構造体の定義と使用方法を紹介したガイドラインです。 

リファレンス

カスタム要素

CustomElementRegistry
カスタム要素に関わる機能が含まれています。中でも注目すべきは、 CustomElementRegistry.define() メソッドで、新しいカスタム要素を登録するために用います。それにより、カスタム要素をドキュメント内で使用できるようになります。
Window.customElements
CustomElementRegistry オブジェクトへの参照を返します。
Life cycle callbacks
カスタム要素のクラス定義の中で定義された特別なコールバック関数で、挙動に影響を与えます。
  • connectedCallback: カスタム要素がドキュメントの DOM に初めて接続したときに呼び出されます。
  • disconnectedCallback: カスタム要素がドキュメントの DOM から切断されたときに呼び出されます。
  • adoptedCallback: カスタム要素が新しいドキュメントに移動したときに呼び出されます。
  • attributeChangedCallback: カスタム要素の属性のひとつが追加、削除、もしくは変更されたときに呼び出されます。
カスタムビルトイン要素を作成するための拡張機能
  • is グローバル HTML 属性: 標準の HTML 要素が、カスタムビルトイン要素のように振る舞うべきかを指定できます。
  • Document.createElement() メソッドの "is" オプション: カスタムビルトイン要素のように振る舞う標準の HTML 要素のインスタンスを作成できます。
CSS の擬似クラス
カスタム要素に関連する擬似クラス:
  • :defined: ビルトイン要素と CustomElementRegistry.define() で定義されるカスタム要素を含む、あらゆる定義済みの要素にマッチします。
  • :host: 使われている CSS を含む、Shadow DOM のシャドーホストを選択します。
  • :host(): 使われている CSS を含む、Shadow DOM のシャドーホストを選択します。 (Shadow DOM の内側からカスタム要素を選択することができます。) ただし、関数のパラメータとして渡されるセレクタがシャドーホストに一致している場合に限ります。
  • :host-context(): 使われている CSS を含む、Shadow DOM のシャドーホストを選択します。 (Shadow DOM の内側からカスタム要素を選択することができます。) ただし、関数のパラメータとして渡されるセレクタが DOM 階層内のシャドーホストの先祖要素に一致している場合に限ります。

Shadow DOM

ShadowRoot
Represents the root node of a shadow DOM subtree.
DocumentOrShadowRoot
A mixin defining features that are available across document and shadow roots.
Element extensions
Extensions to the Element interface related to shadow DOM:
  • The Element.attachShadow() method attaches a shadow DOM tree to the specified element.
  • The Element.shadowRoot property returns the shadow root attached to the specified element, or null if there is no shadow root attached.
Relevant Node additions
Additions to the Node interface relevant to shadow DOM:
  • The Node.getRootNode() method returns the context object's root, which optionally includes the shadow root if it is available.
  • The Node.isConnected property returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.
Event extensions
Extensions to the Event interface related to shadow DOM:
  • Event.composed: Returns a Boolean which indicates whether the event will propagate across the shadow DOM boundary into the standard DOM (true), or not  (false).
  • Event.composedPath: Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with ShadowRoot.mode closed.

HTML templates

<template>
Contains an HTML fragment that is not rendered when a containing document is initially loaded, but can be displayed at runtime using JavaScript, mainly used as the basis of custom element structures. The associated DOM interface is HTMLTemplateElement.
<slot>
A placeholder inside a web component that you can fill with your own markup, which lets you create separate DOM trees and present them together. The associated DOM interface is HTMLSlotElement.
The slot global HTML attribute
Assigns a slot in a shadow DOM shadow tree to an element.
Slotable
A mixin implemented by both Element and Text nodes, defining features that allow them to become the contents of an <slot> element. The mixin defines one attribute, Slotable.assignedSlot, which returns a reference to the slot the node is inserted in.
Element extensions
Extensions to the Element interface related to slots:
  • Element.slot: Returns the name of the shadow DOM slot attached to the element.
CSS pseudo-elements
Pseudo-elements relating specifically to slots:
  • ::slotted: Matches any content that is inserted into a slot.
The slotchange event
Fired on an HTMLSlotElement instance (<slot> element) when the node(s) contained in that slot change.

web-components-examples の GitHub レポジトリに、いくつかの例を用意してあります。時間とともに、より多くの例が追加されることでしょう。

仕様

仕様 ステータス コメント
HTML Living Standard
<template> element の定義
現行の標準 <template> の定義です。
HTML Living Standard
custom elements の定義
現行の標準 HTML Custom Elements の定義です。
DOM
shadow trees の定義
現行の標準 Shadow DOM の定義です。
HTML Imports 草案 HTML Imports の最初の定義です。
Shadow DOM 廃止された Shadow DOM の最初の定義です。

ブラウザのサポート

 

一般に、

  • Web Components は、Firefox (バージョン 63、現在のところ 開発者エディション)、Chrome そして Opera でサポートされています。 
  • Safari では、いくつかの Web Components の機能がサポートされていますが、上記のブラウザほどではありません。
  • Edge では、現在実装中です。

特定の機能のブラウザでの実装状況は、上記のページを調べるようにして下さい。

 

参考

  • webcomponents.org — site featuring web components examples, tutorials, and other information.
  • Polymer — Google's web components framework — a set of polyfills, enhancements, and examples. Currently the easiest way to use web components cross-browser.
  • Slim.js — Open source web components library — a high-performant library for rapid and easy component authoring; extensible and pluggable and cross-framework compatible. 

 

 

ドキュメントのタグと貢献者

このページの貢献者: toVersus, momdo, albatrosary, maybe
最終更新者: toVersus,