.onpopstate
window上でのonpopstateイベントのためのイベントハンドラです。
popstate
イベントは、アクティブな履歴項目が、
同じdocumentの2つの履歴項目の間で変更される度に発生します。
履歴項目の有効化が、history.pushState()の呼び出しによって作られたもの、
またはhistory.replaceState()の呼び出しによって作用したものである場合、
popstate
イベントのstateのプロパティは、履歴項目のstateオブジェクトのコピーを含みます。
history.pushState()、
またはhistory.replaceState()を呼び出すだけであれば、
popstate
イベントはトリガされないことに注意してください。
popstate
イベントは、
ブラウザの「戻る」ボタンのクリック(またはJavaScriptのhistory.back()
呼び出し)のような、
ブラウザのアクションが実行された場合にのみトリガされます。
また、このイベントはユーザーが同じdocumentでの2つの履歴間を行き来した場合のみトリガされます。
文法
window.onpopstate = funcRef;
funcRef
には、関数または関数への参照を割り当てます。
popstateイベントについて
例として、http://example.com/example.html
のページで下記のコードを実行すると、
コメントに記述されている内容がアラートダイアログで表示されます。
window.onpopstate = function(event) {
alert("location: " + document.location + ", state: " + JSON.stringify(event.state));
};
history.pushState({page: 1}, "title 1", "?page=1");
history.pushState({page: 2}, "title 2", "?page=2");
history.replaceState({page: 3}, "title 3", "?page=3");
history.back();
//アラート: "location: http://example.com/example.html?page=1, state: {"page":1}"
history.back();
//アラート: "location: http://example.com/example.html, state: null
history.go(2);
//アラート: "location: http://example.com/example.html?page=3, state: {"page":3}
元の履歴項目(http://example.com/example.html)はそれに関連するstateオブジェクトを持たないにも関わらず、
2度目のhistory.back()
の呼び出しの後に、
その項目を作動(activate)させるとpopstate
イベントが発火することに注意してください。(翻訳に自信無し)
例
注意事項
© 2017 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
このページは、ページトップのURL先のMozilla Developer Network(以下、MDN)のコンテンツを翻訳した内容を基に構成されています。 構成について異なる点も含まれますので、下記の項目を確認し、必要に応じて元のコンテンツをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。
- 特定のブラウザに特化しすぎている情報やあまりにも古い情報、 または試験的に導入されているようなAPIや機能については、省略していることがあります。
- 例やデモについて、実際にページ内で動作させる関係で一部ソースコードを変更している場合や、 その例で使用しているコンテンツの単語や文章などを日本人向けに変更しいてる場合があります。
- MDNの更新頻度が高いため、元のコンテンツと比べ情報が古くなっている可能性があります。
- "訳注:"などの断わりを入れた上で、日本人向けの情報の追記を行っている事があります。