捲軸間諜
根據滾動位置自動更新 Bootstrap 導航或列表組組件,以指示當前在視口中哪個鏈接處於活動狀態。
這個怎麼運作
當具有錨點引用的元素滾動到視圖中時, Scrollspy 會切換.active
錨點 ( <a>
) 元素上的類。Scrollspy 最好與 Bootstrap導航組件或列表組一起使用,但它也可以與當前頁面中的任何錨元素一起使用。這是它的工作原理。id
href
-
首先,scrollspy 需要兩件東西:導航、列表組或一組簡單的鏈接,外加一個可滾動的容器。可滾動容器可以是
<body>
或帶有集合height
和的自定義元素overflow-y: scroll
。 -
在可滾動容器上,添加關聯導航的唯一性
data-bs-spy="scroll"
和data-bs-target="#navId"
位置。確保還包括一個以確保鍵盤訪問。navId
id
tabindex="0"
-
當您滾動“間諜”容器時,
.active
會在關聯導航中的錨鏈接中添加和刪除一個類。鏈接必須具有可解析的id
目標,否則將被忽略。例如,a<a href="#home">home</a>
必須對應於 DOM 中的某些內容,例如<div id="home"></div>
-
不可見的目標元素將被忽略。請參閱下面的不可見元素部分。
例子
導航欄
滾動導航欄下方的區域並觀察活動類的變化。打開下拉菜單並觀察下拉項目是否也被突出顯示。
第一個標題
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第二個標題
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第三個標題
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第四標題
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第五標題
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
<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 也適用於嵌套.nav
的 s。如果一個嵌套.nav
是.active
,它的父母也將是.active
。滾動導航欄旁邊的區域並觀察活動類的變化。
項目 1
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
項目 1-1
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
項目 1-2
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
第 2 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
第 3 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
項目 3-1
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
項目 3-2
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
請記住,JavaScript 插件會嘗試在所有可能可見的元素中選擇正確的元素。同時多個可見的滾動間諜目標可能會導致一些問題。
<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-group
s。滾動列表組旁邊的區域並觀察活動班級的變化。
項目 1
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 2 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 3 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 4 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
<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
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 2 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 3 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 4 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
第 5 項
這是 scrollspy 頁面的一些佔位符內容。請注意,當您向下滾動頁面時,相應的導航鏈接會突出顯示。它在整個組件示例中重複出現。我們在這裡不斷添加更多示例副本以強調滾動和突出顯示。
<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 開始,所有組件都支持一個實驗性的保留數據屬性data-bs-config
,該屬性可以將簡單的組件配置作為 JSON 字符串容納。當一個元素具有data-bs-config='{"delay":0, "title":123}'
和data-bs-title="456"
屬性時,最終title
值將是456
並且單獨的數據屬性將覆蓋給定的值 on data-bs-config
。此外,現有數據屬性能夠容納 JSON 值,例如data-bs-delay='{"show":0,"hide":150}'
.
姓名 | 類型 | 默認 | 描述 |
---|---|---|---|
rootMargin |
細繩 | 0px 0px -25% |
Intersection Observer rootMargin有效單位,計算滾動位置時。 |
smoothScroll |
布爾值 | false |
當用戶單擊引用 ScrollSpy observables 的鏈接時啟用平滑滾動。 |
target |
字符串,DOM 元素 | null |
指定要應用 Scrollspy 插件的元素。 |
threshold |
大批 | [0.1, 0.5, 1] |
IntersectionObserver 計算滾動位置時的閾值有效輸入。 |
不推薦使用的選項
在 v5.1.3 之前,我們一直在使用offset
&method
選項,現在已棄用並由rootMargin
. 為了保持向後兼容性,我們將繼續解析給定offset
的 to rootMargin
,但此功能將在v6中刪除。
方法
方法 | 描述 |
---|---|
dispose |
銷毀元素的滾動間諜。(刪除 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 |
每當滾動間諜激活錨點時,此事件就會在滾動元素上觸發。 |
const firstScrollSpyEl = document.querySelector('[data-bs-spy="scroll"]')
firstScrollSpyEl.addEventListener('activate.bs.scrollspy', () => {
// do something...
})