Bootstrap3 スクロールスパイとScrollspy.jsの簡単な使い方

Pocket

Bootstrap3のScrollSpyを使うと、スクロールに合わせてナビゲーションに動きを持たせたり、現在の位置を確認できるようになります。

この機能は主にランディングページ(LP)のような縦に長いページでよく見かけます。サイドに配置して目次のように使ったり、トップのナビゲーションに配置して現在のセクションを確認できるようになっているものが多いですね。

Bootstrap3のScrollspyを使えば簡単にこのような機能を使うことができます。

Bootstrap3 スクロールスパイの使い方

スクロールスパイはNavbaで作る機能。ナビのaタグにコンテンツのidを入れて紐付けることで、コンテンツが画面のトップに表示されるのと同時にナビゲーションの.activeclassが切り替わります。

Navbarがnavbar-fixed-topになっている場合はコンテンツがNavbarに隠れてしまうため、cssのmargin-topをコンテンツに当てて調整する必要があります。

スクロールスパイを作るには通常はbodyタグに以下のdata属性を設置するだけでOK。

Class名 概要
data-spy="scroll" スクロールスパイの機能を起動
data-target="#navbar-scrollspy" 監視するナビゲーションを指定
<!-- スクロールスパイと紐付けるNavbar、id間違わないよう注意 -->
<nav class="navbar navbar-default navbar-fixed-top" id="navbar-scrollspy" >
  <div class="container-fluid">
    <div class="navbar-header">
      <button class="navbar-toggle" type="button" data-toggle="scroll-spy-sample">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="#">Navbar</a>
    </div>

    <div class="collapse navbar-collapse scroll-spy-sample">
      <ul class="nav navbar-nav">

        <!-- <a>タグにターゲットを指定する -->
        <li class="active"><a href="#fat">@fat</a></li>
        <li><a href="#mdo">@mdo</a></li>
        <li class="dropdown">
          <a href="#" class="dropdown-toggle" id="navbarDrop1" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Dropdown 
            <span class="caret"></span>
          </a>
          <ul class="dropdown-menu" aria-labelledby="navbarDrop1">
            <li><a href="#one">one</a></li>
            <li><a href="#two">two</a></li>
            <li role="separator" class="divider"></li>
            <li><a href="#three">three</a></li>
          </ul>
        </li>

      </ul>
    </div>
  </div>
</nav>

<!-- 
  監視するコンテンツ、サンプルではここにdata属性を設置(一般的にはbody)
  Navbarで、fixed-top使ってる場合、margin-topでNavbarに隠れないように調整する
-->
<div class="scrollspy-example" data-spy="scroll" data-target="#navbar-scrollspy">
  <h4 id="fat">@fat</h4>
  <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
  <h4 id="mdo">@mdo</h4>
  <p>Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.</p>
  <h4 id="one">one</h4>
  <p>Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.</p>
  <h4 id="two">two</h4>
  <p>In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.</p>
  <h4 id="three">three</h4>
  <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
  <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats. </p>
</div>

デモページはこちら

スクロールスパイをJavascriptで適用する方法

スクロールスパイはHTMLにデータ属性を入れるだけでなく、Javascriptでも実装可能。targetのところにNavbarのidを入れればOKです。

$('body').scrollspy({ target: '#navbar-scrollspy' });

Scrollspy.jsの使い方

Scrollspy.jsに用意されているのはスクロールイベントの反応位置とナビが切り替わるごとに発動するイベントの2つのみ。イベントをうまく使えば、スクロールしたら動くアニメーションなども作れそうです。

option名 概要
offset スクロールイベントの反応位置を調整
activate.bs.scrollspy スクロールスパイでナビが切り替わる度に発動
$('.scrollspy-example').on('activate.bs.scrollspy', function () {
  // do something…
});

offsetはdata属性として使用することも可能。

<!-- データ属性でオプション設定 -->
<div class="scrollspy-example" data-spy="scroll" data-target="#navbar-scrollspy" data-offset="80">

デモページはこちら