ShadowRoot: getHTML() メソッド

getHTML()ShadowRoot インターフェイスのメソッドで、シャドウルートの DOM を HTML 文字列にシリアライズするために使用します。

このメソッドは、options 引数を提供しており、シャドウルートである子ノードのシリアライズができるようにします。options を使用すると、シリアライズ可能なネストされたシャドウルートを含めることができます。また、ShadowRoot オブジェクトの指定された配列を含めることもできます。この配列は、開いているものも閉じているものも含みます。

引数がない場合、シャドウルートである子ノードはシリアライズされず、このメソッドは Element.innerHTML の値を読み取る場合と同じ動作をします。

構文

js
const html = shadowRoot.getHTML(options)

引数

options 省略可

次のオプションのパラメーターを持つオプションオブジェクトです。

serializableShadowRoots

論理値で、シリアライズ可能なシャドウルートを含めるかどうかを指定します。 既定値は false です。

shadowRoots

シリアライズする ShadowRoot オブジェクトの配列です。 これらは、serializable としてマークされているかどうか、または開かれているか閉じられたかに関係なく含まれます。 既定値は空の配列です。

返値

文字列で、シャドウルートの HTML シリアライズを表します。

例外

なし。

仕様書

Specification
HTML Standard
# dom-shadowroot-gethtml

ブラウザーの互換性

BCD tables only load in the browser

関連情報