捲動間諜
根據捲動位置自動更新 Bootstrap 導覽或清單群組元件,以指示目前在視窗中哪個連結處於活動狀態。
運作方式
當錨點 (<a>
) 元素的 href
所引用的 id
元素捲動到視圖中時,Scrollspy 會在錨點元素上切換 .active
類別。Scrollspy 最好與 Bootstrap 導覽元件 或 列表群組 搭配使用,但它也會與目前頁面中的任何錨點元素搭配使用。以下是它的運作方式。
-
首先,Scrollspy 需要兩樣東西:導覽、列表群組或一組簡單的連結,以及一個可捲動的容器。可捲動的容器可以是
<body>
或一個自訂元素,並設定height
和overflow-y: scroll
。 -
在可捲動的容器上,新增
data-bs-spy="scroll"
和data-bs-target="#navId"
,其中navId
是關聯導覽的唯一id
。如果元素內沒有可聚焦的元素,請務必也包含tabindex="0"
以確保鍵盤存取。 -
當您捲動「受監控」的容器時,會在關聯導覽中的錨點連結中新增和移除
.active
類別。連結必須有可解析的id
目標,否則會被忽略。例如,一個<a href="#home">home</a>
必須對應到 DOM 中類似<div id="home"></div>
的內容。 -
不可見的目標元素將會被忽略。請參閱以下 不可見元素 區段。
範例
導覽列
捲動導覽列下方的區域,並觀察 active 類別的變化。開啟下拉式功能表,並觀察下拉式項目也會被突顯。
第一個標題
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
第二個標題
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
第三個標題
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
第四個標題
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
第五個標題
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
<nav id="navbar-example2" class="navbar bg-body-tertiary 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-body-tertiary 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>
巢狀導覽
捲軸間諜也能與巢狀 .nav
一起使用。如果巢狀 .nav
是 .active
,其父層級也會是 .active
。捲動導覽列旁側區域,並觀察 active 類別的變化。
項目 1
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 1-1
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 1-2
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 2
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 3
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 3-1
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,JavaScript 外掛程式會嘗試在所有可能顯示的元素中挑選正確的元素。同時有多個可見的捲軸間諜目標可能會造成一些問題。
項目 3-2
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
請記住,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>
清單群組
捲軸間諜也能與 .list-group
一起使用。捲動清單群組旁側區域,並觀察 active 類別的變化。
項目 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
這是捲軸頁面的一些佔位符內容。請注意,當您向下捲動頁面時,會突出顯示適當的導覽連結。它會在整個元件範例中重複出現。我們會繼續在此處新增一些範例文字,以強調捲動和突出顯示。
<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>
)。接著加入 data-bs-target
屬性,其中包含任何 Bootstrap .nav
元件的父元素的 id
或類別名稱。
<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
,而個別的資料屬性將會覆寫 data-bs-config
中給定的值。此外,現有的資料屬性能夠存放 JSON 值,例如 data-bs-delay='{"show":0,"hide":150}'
。
最終的組態物件是 data-bs-config
、data-bs-
和 js 物件
的合併結果,其中最新給定的鍵值會覆寫其他鍵值。
名稱 | 類型 | 預設值 | 說明 |
---|---|---|---|
rootMargin |
字串 | 0px 0px -25% |
計算捲動位置時,Intersection Observer rootMargin 有效的單位。 |
smoothScroll |
布林值 | false |
當使用者點選連結,連結指向 ScrollSpy 可觀察物件時,啟用平滑捲動。 |
target |
字串、DOM 元素 | null |
指定要套用 Scrollspy 外掛程式的元素。 |
threshold |
陣列 | [0.1, 0.5, 1] |
計算捲動位置時,IntersectionObserver threshold 有效的輸入。 |
已棄用的選項
在 v5.1.3 之前,我們使用 offset
和 method
選項,它們現在已棄用,並由 rootMargin
取代。為了保持向後相容性,我們將繼續將給定的 offset
解析為 rootMargin
,但此功能將在 v6 中移除。
方法
方法 | 說明 |
---|---|
dispose |
摧毀元素的捲軸間諜。(移除儲存在 DOM 元素上的資料) |
getInstance |
靜態方法,用於取得與 DOM 元素關聯的捲軸間諜實例。 |
getOrCreateInstance |
靜態方法,用於取得與 DOM 元素關聯的捲軸間諜實例,或是在尚未初始化的情況下建立新的實例。 |
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...
})