jQueryで読み込みを待つには？

jQueryを使用する際、JavaScriptコードが期待通りに動作するために、ドキュメントの読み込みが完了するのを待つ必要がある場合があります。例えば、DOM要素に対して操作を行う前に、その要素が完全に読み込まれている必要があります。そうでないと、スクリプトが要素を見つけられず、エラーが発生する可能性があります。

$(document).ready() 関数

jQueryでは、$(document).ready()関数を使用することで、ドキュメントの読み込みが完了したタイミングでコードを実行することができます。この関数は、DOMが完全に読み込まれ、スクリプトが安全にDOM操作を実行できるようになったときに実行されます。

$(document).ready()関数の基本的な構文は以下のとおりです：


$(document).ready(function() {
    // ドキュメントの準備が完了した後に実行するコードをここに記述します。
});

このコードは、ドキュメントの準備が完了した後、関数内のコードを実行します。例えば、以下のように、ページ上のすべての段落要素の背景色を赤に変更するコードを記述できます。


$(document).ready(function() {
    $("p").css("background-color", "red");
});

読み込みイベントと比較

$(document).ready()と似たものに、windowオブジェクトのloadイベントがあります。どちらもドキュメントの読み込みが完了した後にコードを実行しますが、重要な違いがあります。

イベント	説明
`$(document).ready()`	DOMツリーが構築された時点で発火します。画像や外部リソースの読み込みが完了するのを待ちません。
`window.onload`	すべてのコンテンツ（画像、外部リソースなど）が完全に読み込まれた時点で発火します。

一般的に、DOM操作は$(document).ready()を使用して行う方が効率的です。なぜなら、画像などのリソースの読み込みを待つ必要がないためです。一方、画像のサイズを取得するなど、すべてのコンテンツが読み込まれた状態でないと実行できない処理は、window.onloadイベント内で実行する必要があります。

コード例

以下は、$(document).ready()を使用して、ボタンクリック時にアラートを表示する簡単な例です。


<!DOCTYPE html>
<html>
<head>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<script>
$(document).ready(function(){
  $("button").click(function(){
    alert("ボタンがクリックされました！");
  });
});
</script>
</head>
<body>

<button>クリックしてください</button>

</body>
</html>

jQueryで読み込みを待つには？

$(document).ready() 関数

読み込みイベントと比較

コード例

参考資料

関連QA

Q1: $(document).ready() を複数回使用できますか？

Q2: $(document).ready() の短縮形はありますか？

Q3: JavaScriptのコードを <head> タグ内に記述する必要がありますか？