Source

スクロールスパイ

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

使い方

Scrollspy が正しく機能するには、いくつかの要件があります。

  • JavaScript をソースからビルドする場合はutil.js、 .
  • Bootstrap nav コンポーネントまたはリスト グループで使用する必要があります。
  • Scrollspy はposition: relative;、スパイしている要素、通常は<body>.
  • 以外の要素をスパイするときは<body>、必ずheightセットしてoverflow-y: scroll;適用してください。
  • アンカー ( <a>) が必要であり、それを持つ要素を指している必要がありidます。

正常に実装されると、それに応じてナビゲーションまたはリスト グループが更新さ.activeれ、関連するターゲットに基づいてクラスが 1 つのアイテムから次のアイテムに移動します。

ナビゲーションバーの例

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

@太い

広告レギンス キーター、ブランチ id アート パーティー ドロア 労働。彼らが売り切れる前に、Pitchfork yr enim lo-fi。Tumblrの農場から食卓への自転車の権利は何でも。アニム・ケフィヤ・カルレスのカーディガン。Velit seitan mcsweeney のフォト ブース 3 ウルフ ムーン イルレ。コスビー セーター ロモ ジーンズ ショートパンツ、ウィリアムズバーグ パーカー ミニム qui あなたはおそらくそれらについて聞いたことがないでしょう. ニヒルは刺青を入れたアキュマス、信頼できる皮肉なバイオディーゼル ケフィーヤの職人ウラムコの結果です。

@mdo

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.

one

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.

two

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.

three

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.

Keytar twee ブログ、カルパ メッセンジャー バッグ マーファ エニウェア デレクタス フード トラック。Sapiente のシンセ ID は仮定だ。Locavore sed helvetica cliche 皮肉、あなたがおそらく聞いたことのないサンダーキャットは、グルテンフリーのローファイファップアリクイップを結果としてもたらします. 彼らが売り切れる前に労働者のエリートの場所、テリー・リチャードソンのプロイデント・ブランチ、ネス・コスビー・セーター・パリアトゥール・ケフィーヤ・ウット・ヘルベチカ・アーティザン. カーディガン クラフトビール セイタン レディメイド ヴェリット。VHS シャンブレーラボラリス tempor veniam. アニメーション mollit minim commodo ullamco thundercats.

<nav id="navbar-example2" class="navbar navbar-light bg-light">
  <a class="navbar-brand" href="#">Navbar</a>
  <ul class="nav nav-pills">
    <li class="nav-item">
      <a class="nav-link" href="#fat">@fat</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#mdo">@mdo</a>
    </li>
    <li class="nav-item dropdown">
      <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
      <div class="dropdown-menu">
        <a class="dropdown-item" href="#one">one</a>
        <a class="dropdown-item" href="#two">two</a>
        <div role="separator" class="dropdown-divider"></div>
        <a class="dropdown-item" href="#three">three</a>
      </div>
    </li>
  </ul>
</nav>
<div data-spy="scroll" data-target="#navbar-example2" data-offset="0">
  <h4 id="fat">@fat</h4>
  <p>...</p>
  <h4 id="mdo">@mdo</h4>
  <p>...</p>
  <h4 id="one">one</h4>
  <p>...</p>
  <h4 id="two">two</h4>
  <p>...</p>
  <h4 id="three">three</h4>
  <p>...</p>
</div>

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

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

アイテム1

Ex consequat commodo adipisicing execitation auteexcepteur occaecat ullamco duis aliqua id magna ullamco eu. aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur Labore. Fugiat labirum incididunt tempor eu consequat enim dolore proident. Qui labum do nonexcepteur nulla magna eiusmod consectetur in。Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

項目1-1

Amet tempor mollit aliquip pariaturexcepteur commodo do ea cillum commodo Lorem et occaecat elit qui et. Aliquip labe ex ex esse voluptate occaecat Lorem ullamco deserunt. Aliqua cillumexcepteur irure consequat id quis ea. 素晴らしいウラムコ・オーテ・マグナ・パリアトゥール・ノーストラッド・ラヴァーレに座ってください。Reprehenderit aliqua commodo eiusmod aliquip est do duis amet proident magna consectetur consequat eu commodo fugiat non quis. Enim aliquip exercitation ullamco adipisicing voluptateexcepteur minim exercitation minim minim commodo adipisicing execitation office nisi adipisicing. anim id duis qui consequat labe adipisicing sint dolor elit cillum anim et fugiat.

項目1-2

Cillum nisi deserunt magna eiusmod qui eiusmod velit voluptate pariatur laborum sunt enim. Irure laboris mollit consequat incididunt sint et culpa culpa incididunt adipisicing magna magna occaecat. Nulla ipsum cillum eiusmod sint elit excepteur ea labore enim consectetur in labore anim. Proident ullamco ipsum esse elit ut Lorem eiusmod dolor et eiusmod. Anim occaecat nulla in non consequat eiusmod velit incididunt.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 3-1

Deserunt quis elit Lorem eiusmod amet enim enim amet minim Lorem proident nostrud. Ea id dolore anim exercitation aute fugiat labore voluptate cillum do laboris labore. Ex velit exercitation nisi enim labore reprehenderit labore nostrud ut ut. Esse officia sunt duis aliquip ullamco tempor eiusmod deserunt irure nostrud irure. Ullamco proident veniam laboris ea consectetur magna sunt ex exercitation aliquip minim enim culpa occaecat exercitation. Est tempor excepteur aliquip laborum consequat do deserunt laborum esse eiusmod irure proident ipsum esse qui.

Item 3-2

Labore sit culpa commodo elit adipisicing sit aliquip elit proident voluptate minim mollit nostrud aute reprehenderit do. Mollit excepteur eu Lorem ipsum anim commodo sint labe in exercitation velit incididunt. Occaecat consectetur nisi in occaecat proident minim enim sunt reprehenderit exercitation cupidatat et do officia. Aliquip consequat ad Labore Labore mollit ut amet. veniam culpa aliquaexcepteur elit magna fugiat eiusmod amet official.

<nav id="navbar-example3" class="navbar navbar-light bg-light">
  <a class="navbar-brand" href="#">Navbar</a>
  <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 ml-3 my-1" href="#item-1-1">Item 1-1</a>
      <a class="nav-link ml-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 ml-3 my-1" href="#item-3-1">Item 3-1</a>
      <a class="nav-link ml-3 my-1" href="#item-3-2">Item 3-2</a>
    </nav>
  </nav>
</nav>

<div data-spy="scroll" data-target="#navbar-example3" data-offset="0">
  <h4 id="item-1">Item 1</h4>
  <p>...</p>
  <h5 id="item-1-1">Item 1-1</h5>
  <p>...</p>
  <h5 id="item-1-2">Item 1-2</h5>
  <p>...</p>
  <h4 id="item-2">Item 2</h4>
  <p>...</p>
  <h4 id="item-3">Item 3</h4>
  <p>...</p>
  <h5 id="item-3-1">Item 3-1</h5>
  <p>...</p>
  <h5 id="item-3-2">Item 3-2</h5>
  <p>...</p>
</div>

リストグループの例

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

アイテム1

Ex consequat commodo adipisicing execitation auteexcepteur occaecat ullamco duis aliqua id magna ullamco eu. aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur Labore. Fugiat labirum incididunt tempor eu consequat enim dolore proident. Qui labum do nonexcepteur nulla magna eiusmod consectetur in。Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

項目 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis Laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor labourum mollit labe official labourumexcepteur commodo non commodo dolorexcepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

アイテム3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat exceptioneur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamcoexcepteur.

項目4

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat exceptioneur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamcoexcepteur.

<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 data-spy="scroll" data-target="#list-example" data-offset="0" class="scrollspy-example">
  <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>

使用法

データ属性経由

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

body {
  position: relative;
}
<body data-spy="scroll" data-target="#navbar-example">
  ...
  <div id="navbar-example">
    <ul class="nav nav-tabs" role="tablist">
      ...
    </ul>
  </div>
  ...
</body>

JavaScript 経由

CSSを追加position: relative;したら、JavaScript 経由で scrollspy を呼び出します。

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

解決可能な ID ターゲットが必要

Navbar リンクには、解決可能な ID ターゲットが必要です。たとえば、 a<a href="#home">home</a>は DOM のようなものに対応している必要があります<div id="home"></div>。

非:visibleターゲット要素は無視されました

:visiblejQuery に準拠していないターゲット要素は無視され、対応するナビゲーション アイテムが強調表示されることはありません。

メソッド

.scrollspy('refresh')

scrollspy を DOM からの要素の追加または削除と組み合わせて使用​​する場合、次のように refresh メソッドを呼び出す必要があります。

$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
})

.scrollspy('dispose')

要素の scrollspy を破棄します。

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-offset=""。

名前 タイプ デフォルト 説明
オフセット 番号 10 スクロールの位置を計算するときに上からオフセットするピクセル。
方法 ストリング 自動 スパイされた要素がどのセクションにあるかを見つけautoます。スクロール座標を取得するための最良の方法を選択します。offsetjQuery オフセット メソッドを使用してスクロール座標を取得します。positionjQuery position メソッドを使用してスクロール座標を取得します。
目標 ストリング Scrollspy プラグインを適用する要素を指定します。

イベント

イベントタイプ 説明
activate.bs.scrollspy このイベントは、スクロールスパイによって新しいアイテムがアクティブになるたびに、スクロール要素で発生します。 
$('[data-spy="scroll"]').on('activate.bs.scrollspy', function () {
  // do something...
})