HTMLElement: attachInternals() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年3月以降、すべてのブラウザーで利用可能です。
HTMLElement.attachInternals() メソッドは、 ElementInternals オブジェクトを返します。このメソッドにより、カスタム要素が HTML フォームに参加することができるようになります。 ElementInternals インターフェイスは、標準的な HTML フォーム要素と同じようにこれらの要素を扱うためのユーティリティを提供し、また、要素に対してアクセシビリティオブジェクトモデルを公開します。
構文
js
attachInternals()
引数
なし。
返値
ElementInternals オブジェクト。
例外
NotSupportedErrorDOMException-
この要素がカスタム要素でなかった場合に発生します。
NotSupportedErrorDOMException-
この要素の定義の一部で「内部」の機能が無効になっていた場合に発生します。
NotSupportedErrorDOMException-
同じ要素に対してこのメソッドを 2 度呼び出したときに発生します。
例
次の例では、カスタムフォームに関連する要素を HTMLElement.attachInternals で作成する方法を示しています。そして、 ElementInternals.form プロパティがコンソールに出力され、 ElementInternals オブジェクトがあることを実証しています。
js
class CustomCheckbox extends HTMLElement {
static formAssociated = true;
constructor() {
super();
this.internals_ = this.attachInternals();
}
// …
}
window.customElements.define("custom-checkbox", CustomCheckbox);
let element = document.getElementById("custom-checkbox");
console.log(element.internals_.form);
仕様書
| 仕様書 |
|---|
| HTML # dom-attachinternals |