本記事では、JavaScriptで指定した要素の位置までスクロールさせる方法について解説しています。
JavaScriptの学習におすすめ参考書
改訂3版JavaScript本格入門 ~モダンスタイルによる基礎から現場での応用まで
綺麗なコードが書けるようになる!
リーダブルコード-より良いコードを書くためのシンプルで実践的なテクニック
scrollIntoViewメソッドの使い方
指定した要素の位置までスクロールさせたい場合は、scrollIntoViewメソッドを使用します。基本的な使い方は以下のとおりです。
Element.scrollIntoView(arg);
- Element:スクロール位置の基準要素を指定
- arg:boolean(true/false)を指定
実際に、scrollIntoViewメソッドを使用して特定の要素位置までスクロールするサンプルコードを用意したので、動作確認してみましょう。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<style>
div {
height: 2000px;
}
</style>
<body>
<input id="btn" type="button" value="h1までスクロールします" />
<div></div>
<h1>hoge</h1>
<div></div>
<script src="index.js"></script>
</body>
</html>
const btn = document.querySelector("#btn");
btn.addEventListener("click", () => {
const h1 = document.querySelector("h1");
h1.scrollIntoView(true);
});
ゆっくりスクロールさせたい場合
一瞬で指定した要素位置まで移動するのではなく、アニメーションが掛かっているように見せたい時はbehaviorオプションに値を指定します。オプションに指定できる値は以下のとおりです。
auto(初期値):ブラウザの初期動作。アニメーションはしない
smooth:アニメーションさせる
autoが初期値に設定されているので、オプションを指定していない場合はアニメーションのようなスクロールではなく即時に指定した要素まで移動します。
オプションの値にsmoothをセットして、アニメーションのようなスクロールがされるようコードを修正してみましょう。
const btn = document.querySelector("#btn");
btn.addEventListener("click", (e) => {
const h1 = document.querySelector("h1");
h1.scrollIntoView({
behavior: "smooth",
});
});
スクロールで止まる位置を変更させたい場合
スクロールで止まる位置を画面上部ではなく、中央や下部に変更させたい時はblockオプションに値を指定します。オプションに指定できる値は以下のとおりです。
start(初期値):画面の上端と要素の上端が重なる位置までスクロール
center:要素が画面の上下の中央になる位置までスクロール
end:画面の下端と要素の下端が重なる位置までスクロール
nearest:startかendの近い方を選択
startが初期値に設定されているので、オプションを指定していない場合は画面の上端と要素の上端が重なる位置までスクロールされます。
オプションの値にcenterをセットして、画面中央の位置でスクロールを止めるようコードを修正してみましょう。
const btn = document.querySelector("#btn");
btn.addEventListener("click", (e) => {
const h1 = document.querySelector("h1");
h1.scrollIntoView({
block: "center",
});
});