スクロールスパイ

ビューポートで現在アクティブなリンクを示すために、スクロール位置に基づいて Bootstrap ナビゲーションまたはリストグループコンポーネントを自動的に更新します。

このページでは

使い方

Scrollspyは、アンカーによって参照される要素がビューにスクロールされると、.activeアンカー ( <a>) 要素のクラスを切り替えます。Scrollspy は、Bootstrap nav コンポーネントまたはリストグループと組み合わせて使用するのが最適ですが、現在のページのアンカー要素でも機能します。仕組みは次のとおりです。idhref

scrollspy を開始するには、ナビゲーション、リストグループ、または単純なリンクセットと、スクロール可能なコンテナーの 2 つが必要です。スクロール可能なコンテナは、またはとのセットを<body>持つカスタム要素にすることができます。heightoverflow-y: scroll
スクロール可能なコンテナーで、関連するナビゲーションの一意の場所を追加data-bs-spy="scroll"します。キーボードアクセスを確保するために、必ず a も含めてください。data-bs-target="#navId"navIdidtabindex="0"
「スパイ」コンテナをスクロールすると、.activeクラスが追加され、関連するナビゲーション内のアンカーリンクから削除されます。リンクには解決可能idなターゲットが必要です。そうでない場合、リンクは無視されます。たとえば、a<a href="#home">home</a>は次のような DOM の何かに対応する必要があります<div id="home"></div>
表示されていないターゲット要素は無視されます。以下の非表示要素のセクションを参照してください。

例

ナビゲーションバーの下の領域をスクロールして、アクティブなクラスの変化を確認します。ドロップダウンメニューを開き、ドロップダウンアイテムも強調表示されるのを確認します。

最初の見出し

これは、scrollspy ページのプレースホルダーコンテンツです。ページを下にスクロールすると、適切なナビゲーションリンクが強調表示されることに注意してください。コンポーネントの例全体で繰り返されます。スクロールと強調表示を強調するために、ここにいくつかの例のコピーを追加し続けます。

2 番目の見出し

第 3 見出し

第 4 見出し

第 5 見出し

<nav id="navbar-example2" class="navbar bg-light px-3 mb-3">
  <a class="navbar-brand" href="#">Navbar</a>
  <ul class="nav nav-pills">
    <li class="nav-item">
      <a class="nav-link" href="#scrollspyHeading1">First</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#scrollspyHeading2">Second</a>
    </li>
    <li class="nav-item dropdown">
      <a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-expanded="false">Dropdown</a>
      <ul class="dropdown-menu">
        <li><a class="dropdown-item" href="#scrollspyHeading3">Third</a></li>
        <li><a class="dropdown-item" href="#scrollspyHeading4">Fourth</a></li>
        <li><hr class="dropdown-divider"></li>
        <li><a class="dropdown-item" href="#scrollspyHeading5">Fifth</a></li>
      </ul>
    </li>
  </ul>
</nav>
<div data-bs-spy="scroll" data-bs-target="#navbar-example2" data-bs-root-margin="0px 0px -40%" data-bs-smooth-scroll="true" class="scrollspy-example bg-light p-3 rounded-2" tabindex="0">
  <h4 id="scrollspyHeading1">First heading</h4>
  <p>...</p>
  <h4 id="scrollspyHeading2">Second heading</h4>
  <p>...</p>
  <h4 id="scrollspyHeading3">Third heading</h4>
  <p>...</p>
  <h4 id="scrollspyHeading4">Fourth heading</h4>
  <p>...</p>
  <h4 id="scrollspyHeading5">Fifth heading</h4>
  <p>...</p>
</div>

ネストされたナビゲーション

Scrollspy はネストされた.navs でも動作します。ネストされた.navがの場合.active、その親もになります.active。ナビゲーションバーの横の領域をスクロールして、アクティブなクラスの変化を確認します。

アイテム1

JavaScript プラグインは、表示可能なすべての要素の中から正しい要素を選択しようとすることに注意してください。同時に複数のスクロールスパイターゲットが表示されると、いくつかの問題が発生する可能性があります。

項目1-1

項目1-2

項目 2

アイテム3

項目3-1

項目3-2

<div class="row">
  <div class="col-4">
    <nav id="navbar-example3" class="h-100 flex-column align-items-stretch pe-4 border-end">
      <nav class="nav nav-pills flex-column">
        <a class="nav-link" href="#item-1">Item 1</a>
        <nav class="nav nav-pills flex-column">
          <a class="nav-link ms-3 my-1" href="#item-1-1">Item 1-1</a>
          <a class="nav-link ms-3 my-1" href="#item-1-2">Item 1-2</a>
        </nav>
        <a class="nav-link" href="#item-2">Item 2</a>
        <a class="nav-link" href="#item-3">Item 3</a>
        <nav class="nav nav-pills flex-column">
          <a class="nav-link ms-3 my-1" href="#item-3-1">Item 3-1</a>
          <a class="nav-link ms-3 my-1" href="#item-3-2">Item 3-2</a>
        </nav>
      </nav>
    </nav>
  </div>

  <div class="col-8">
    <div data-bs-spy="scroll" data-bs-target="#navbar-example3" data-bs-smooth-scroll="true" class="scrollspy-example-2" tabindex="0">
      <div id="item-1">
        <h4>Item 1</h4>
        <p>...</p>
      </div>
      <div id="item-1-1">
        <h5>Item 1-1</h5>
        <p>...</p>
      </div>
      <div id="item-1-2">
        <h5>Item 1-2</h5>
        <p>...</p>
      </div>
      <div id="item-2">
        <h4>Item 2</h4>
        <p>...</p>
      </div>
      <div id="item-3">
        <h4>Item 3</h4>
        <p>...</p>
      </div>
      <div id="item-3-1">
        <h5>Item 3-1</h5>
        <p>...</p>
      </div>
      <div id="item-3-2">
        <h5>Item 3-2</h5>
        <p>...</p>
      </div>
    </div>
  </div>
</div>

リストグループ

Scrollspy は.list-groups でも動作します。リストグループの横の領域をスクロールして、アクティブなクラスの変化を確認します。

アイテム1 項目 2 アイテム3 項目4

アイテム1

項目 2

アイテム3

項目4

<div class="row">
  <div class="col-4">
    <div id="list-example" class="list-group">
      <a class="list-group-item list-group-item-action" href="#list-item-1">Item 1</a>
      <a class="list-group-item list-group-item-action" href="#list-item-2">Item 2</a>
      <a class="list-group-item list-group-item-action" href="#list-item-3">Item 3</a>
      <a class="list-group-item list-group-item-action" href="#list-item-4">Item 4</a>
    </div>
  </div>
  <div class="col-8">
    <div data-bs-spy="scroll" data-bs-target="#list-example" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
      <h4 id="list-item-1">Item 1</h4>
      <p>...</p>
      <h4 id="list-item-2">Item 2</h4>
      <p>...</p>
      <h4 id="list-item-3">Item 3</h4>
      <p>...</p>
      <h4 id="list-item-4">Item 4</h4>
      <p>...</p>
    </div>
  </div>
</div>

シンプルなアンカー

Scrollspy はナビゲーションコンポーネントとリストグループに限定されないため<a>、現在のドキュメント内の任意のアンカー要素で機能します。領域をスクロールして、.activeクラスの変更を確認します。

アイテム1 項目 2 アイテム3 項目4 アイテム5

アイテム1

項目 2

アイテム3

項目4

アイテム5

<div class="row">
  <div class="col-4">
    <div id="simple-list-example" class="d-flex flex-column gap-2 simple-list-example-scrollspy text-center">
      <a class="p-1 rounded" href="#simple-list-item-1">Item 1</a>
      <a class="p-1 rounded" href="#simple-list-item-2">Item 2</a>
      <a class="p-1 rounded" href="#simple-list-item-3">Item 3</a>
      <a class="p-1 rounded" href="#simple-list-item-4">Item 4</a>
      <a class="p-1 rounded" href="#simple-list-item-5">Item 5</a>
    </div>
  </div>
  <div class="col-8">
    <div data-bs-spy="scroll" data-bs-target="#simple-list-example" data-bs-offset="0" data-bs-smooth-scroll="true" class="scrollspy-example" tabindex="0">
      <h4 id="simple-list-item-1">Item 1</h4>
      <p>...</p>
      <h4 id="simple-list-item-2">Item 2</h4>
      <p>...</p>
      <h4 id="simple-list-item-3">Item 3</h4>
      <p>...</p>
      <h4 id="simple-list-item-4">Item 4</h4>
      <p>...</p>
      <h4 id="simple-list-item-5">Item 5</h4>
      <p>...</p>
    </div>
  </div>
</div>

目に見えない要素

.active表示されていないターゲット要素は無視され、対応するナビゲーションアイテムはクラスを受け取りません。非表示のラッパーで初期化された Scrollspy インスタンスは、すべてのターゲット要素を無視します。ラッパーが表示されたら、このメソッドを使用しrefreshて監視可能な要素を確認します。

document.querySelectorAll('#nav-tab>[data-bs-toggle="tab"]').forEach(el => {
  el.addEventListener('shown.bs.tab', () => {
    const target = el.getAttribute('data-bs-target')
    const scrollElem = document.querySelector(`${target} [data-bs-spy="scroll"]`)
    bootstrap.ScrollSpy.getOrCreateInstance(scrollElem).refresh()
  })
})

使用法

データ属性経由

scrollspy 動作をトップバーナビゲーションに簡単に追加するdata-bs-spy="scroll"には、スパイしたい要素 (最も一般的には<body>) に追加します。次に、任意の Bootstrapコンポーネントの親要素のまたはクラス名をdata-bs-target持つ属性を追加します。id.nav

<body data-bs-spy="scroll" data-bs-target="#navbar-example">
  ...
  <div id="navbar-example">
    <ul class="nav nav-tabs" role="tablist">
      ...
    </ul>
  </div>
  ...
</body>

JavaScript 経由

const scrollSpy = new bootstrap.ScrollSpy(document.body, {
  target: '#navbar-example'
})

オプション

オプションはデータ属性または JavaScript を介して渡すことができるためdata-bs-、のようにオプション名をに追加できますdata-bs-animation="{value}"。データ属性を介してオプションを渡すときは、オプション名のケースタイプを「camelCase」から「kebab-case 」に変更してください。たとえば、data-bs-custom-class="beautifier"の代わりにを使用しdata-bs-customClass="beautifier"ます。

Bootstrap 5.2.0 の時点で、すべてのコンポーネントは、単純なコンポーネント構成を JSON 文字列として格納できる実験的な予約済みデータ属性をサポートしています。data-bs-config要素にdata-bs-config='{"delay":0, "title":123}'とdata-bs-title="456"属性がある場合、最終的なtitle値はに456なり、個別のデータ属性がで指定された値をオーバーライドしますdata-bs-config。さらに、既存のデータ属性は、のような JSON 値を格納できますdata-bs-delay='{"show":0,"hide":150}'。

名前	タイプ	デフォルト	説明
`rootMargin`	ストリング	`0px 0px -25%`	Intersection Observer rootMarginスクロール位置を計算する際の有効な単位。
`smoothScroll`	ブール値	`false`	ユーザーが ScrollSpy オブザーバブルを参照するリンクをクリックしたときに、スムーズスクロールを有効にします。
`target`	文字列、DOM 要素	`null`	Scrollspy プラグインを適用する要素を指定します。
`threshold`	配列	`[0.1, 0.5, 1]`	`IntersectionObserver` スクロール位置を計算するときの有効な入力のしきい値。

非推奨のオプション

v5.1.3 まではoffset&methodオプションを使用していましたが、現在は推奨されておらず、に置き換えられていrootMarginます。offset下位互換性を維持するために、与えられた toを引き続き解析しますが、この機能はv6rootMarginで削除されます。

メソッド

方法	説明
`dispose`	要素の scrollspy を破棄します。(DOM要素に格納されたデータを削除します)
`getInstance`	DOM 要素に関連付けられた scrollspy インスタンスを取得する静的メソッド。
`getOrCreateInstance`	DOM 要素に関連付けられた scrollspy インスタンスを取得するための静的メソッド、または初期化されていない場合に新しいインスタンスを作成するための静的メソッド。
`refresh`	DOM で要素を追加または削除するときは、refresh メソッドを呼び出す必要があります。

以下は、refresh メソッドを使用した例です。

const dataSpyList = document.querySelectorAll('[data-bs-spy="scroll"]')
dataSpyList.forEach(dataSpyEl => {
  bootstrap.ScrollSpy.getInstance(dataSpyEl).refresh()
})

イベント

イベント	説明
`activate.bs.scrollspy`	このイベントは、scrollspy によってアンカーがアクティブ化されるたびに、スクロール要素で発生します。

const firstScrollSpyEl = document.querySelector('[data-bs-spy="scroll"]')
firstScrollSpyEl.addEventListener('activate.bs.scrollspy', () => {
  // do something...
})