Element: getHTML() メソッド

Baseline 2024

Newly available

Since September 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

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

このメソッドは、シャドウルートに含まれる子ノードのシリアライズを有効にするオプション引数を提供します。 このオプションによって、serializable として設定されている入れ子のシャドウルートや、ShadowRoot オブジェクトの指定された配列を含めることができます。

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

構文

js
getHTML(options)

引数

options 省略可

以下のオプション引数を持つオプションオブジェクトです。

serializableShadowRoots

論理値で、serializable なシャドウルートを含めるかどうかを指定します。 既定値は false です。

shadowRoots

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

返値

要素の HTML シリアライズを表す文字列です。

例外

なし。

仕様書

Specification
HTML Standard
# dom-element-gethtml

ブラウザーの互換性

BCD tables only load in the browser

関連情報