Window: requestResize() メソッド
利用可能性は限定的
この機能はベースラインではありません。最も広く使用されているブラウザーの一部で動作しません。
もっと多くのブラウザーがこの機能に対応してほしいですか? 理由を教えてください。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
requestResize() は Window インターフェイスのメソッドで、埋め込み文書と親文書の間で共有されるサイズ情報を更新します。ただし、<meta name="responsive-embedded-sizing"> メタタグによって、埋め込み文書がサイズ情報の共有を許可している場合に限ります。
構文
requestResize()
引数
なし。
返値
なし(undefined)。
例外
NotAllowedErrorDOMException-
次の場合に発生します。
requestResize()メソッドが最上位(埋め込まれていない)の文書から呼び出された。- 埋め込み先の要素が
<iframe>ではない。 - 埋め込まれた文書に
<meta name="responsive-embedded-sizing">タグが含まれておらず、レイアウトサイズの共有が許可されていない。
メモ:
親文書が埋め込み先の <iframe> に CSS の frame-sizing プロパティを設定していない場合、例外は発生しませんが、<iframe> のサイズも変更されません。
解説
セキュリティとプライバシー上の理由から、<iframe> 要素はデフォルトでは、埋め込んだ文書内のコンテンツのサイズ情報を親文書に公開しません。
コンテンツに応じた <iframe> 要素のサイズ変更を有効にするには、埋め込まれた文書に <meta name="responsive-embedded-sizing"> タグを含めて、その文書がサイズ情報を親文書と共有することを許可します。その後、CSS の frame-sizing プロパティを <iframe> に設定すると、埋め込まれた文書の実際のレイアウトサイズに合わせて、水平方向または垂直方向の寸法を調整できます。仕様書ではこのサイズを内部レイアウトの内在サイズ(internal layout intrinsic size)と呼びます。これにより、文書のコンテンツが埋め込み先の <iframe> に自然に収まり、不要なスクロールバーが表示されないようにできます。
埋め込まれた文書のレイアウトサイズは、DOMContentLoaded イベントが発生したときに一度自動的に報告され、さらに Window オブジェクトの load イベントが発生したときにも報告されます。
それ以外の場合は、埋め込まれた文書から requestResize() メソッドを呼び出して、更新後のレイアウトサイズを報告させることができます。通常は、埋め込みコンテンツのサイズ変更を引き起こしたイベントのハンドラー内で呼び出します。frame-sizing を使って <iframe> のサイズを設定している場合、埋め込みコンテンツが収まるように <iframe> のサイズも自動的に更新されます。
例
>requestResize() の使用
この例では、埋め込まれた文書のコンテンツのレイアウトサイズが変わったときに、requestResize() メソッドで <iframe> のサイズを自動的に変更する方法を示します。
ここでは、メインの index.html 文書と、埋め込まれる frame.html 文書を使用します。
メインの index.html
index.html の HTML には、見出しと <iframe> があり、その中に frame.html 文書が埋め込まれています。
<h1>レスポンシブな iframe — 基本例</h1>
<iframe src="frame.html"></iframe>
index.html の CSS では、<iframe> の frame-sizing に content-block-size を指定します。<iframe> の書字方向は横書きなので、その height は埋め込まれた文書のレイアウト上の高さに設定されます。
iframe {
frame-sizing: content-block-size;
border: 2px solid gray;
}
埋め込まれる frame.html
frame.html 文書には、フォーカス可能にするために tabindex を 0 に設定した <div> 要素があります。この要素には見出しといくつかの段落が含まれます。また、この文書には <meta name="responsive-embedded-sizing" /> タグがあり、コンテンツのレイアウトサイズを親文書と共有することを許可しています。最後に、デモを制御する JavaScript を含む <script> 要素を追加します。
<head>
<!-- ... -->
<meta name="responsive-embedded-sizing" />
<!-- ... -->
</head>
<body>
<div tabindex="0">
<h1>これが私のフレームです</h1>
<p>これは私の不満の内容です。</p>
<p>さらにコンテンツがあります。</p>
</div>
<script>
/* ... */
</script>
</body>
frame.html 内のスクリプトは、まず <div> 要素への参照を取得します。次に、この <div> に click および keydown イベントのリスナーを設定します。どちらのイベントが発生しても、addParagraph() という独自関数を実行します。
const divElem = document.querySelector("div");
divElem.addEventListener("click", addParagraph);
window.addEventListener("keydown", addParagraph);
addParagraph() 関数は新しい段落要素を生成し、<div> の末尾に子要素として追加して高さを増やします。その後、requestResize() を呼び出して、新しいサイズを親文書に報告します。
function addParagraph() {
const para = document.createElement("p");
para.textContent = "新しいコンテンツです。";
divElem.appendChild(para);
window.requestResize();
}
結果
動作を確認するには、requestResize() のデモ(英語)を別のタブで開いてください(ソースコード(英語))。
height を <iframe> に明示的に設定していなくても、埋め込まれた文書がちょうど収まる高さに調整され、スクロールバーは表示されません。コンテンツをクリックするか、フォーカスしてキーボードのキーを押してみてください。新しい段落が <div> に追加されると、<div> の高さが増し、それに合わせて <iframe> の高さも増えます。
仕様書
| 仕様書 |
|---|
| CSS Box Sizing Module Level 4> # dom-window-requestresize> |
ブラウザーの互換性
関連情報
- CSS の
frame-sizingプロパティ - CSS ボックスサイズ設定モジュール
<meta name="responsive-embedded-sizing">