它是如何工作的
滚动监听切换 .active 关于锚点的课程 (<a>) 元素当具有该元素时 id 被锚点引用的 href 被滚动到视图中。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>不可见的目标元素将被忽略。请参阅 不可见元素 下面的部分。
目标
id与……匹配getElementById,所以包含特殊字符或百分号编码字符的 ID(例如#item.1,#section:overview,或者#%2Fpath) 正确解决。
检测
Scrollspy 使用一个 IntersectionObserver 来跟踪各个部分,而无需 scroll-position 轮询。检测是确定性的,并完全由靠近滚动容器顶部的激活线驱动。
- 活动部分是顶部已经滚动过激活线的最深部分,就像你当前正在阅读的部分一样。
- 在两个标题之间的间隙滚动时,最后激活的部分保持激活状态,直到下一个部分越过该线。
- 在容器的最顶部,在任何部分越过该线之前,第一个部分保持激活状态。
- 在容器的最底部,即使最后一个部分的顶部从未达到该线,也会被激活(对短的最后一部分非常有用)。
通过 topMargin 设置激活线的位置(更用户友好的值 % 或 px 从滚动根顶部开始,例如 96px 以位于固定导航栏下方),或使用原始 IntersectionObserver rootMargin 字符串完全控制。请参见 选项。
跳转到调试覆盖层部分,以可视化激活行的实际效果。
示例
导航栏
向下滚动导航栏下方的区域,观察 active 类的变化。打开菜单,观察菜单项也被高亮显示。
第一标题
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本以强调滚动和高亮显示。
第二个标题
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本以强调滚动和高亮显示。
第三个标题
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示的效果。
第四标题
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
第五标题
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
<nav id="navbar-example2" class="navbar bg-1 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">
<a class="nav-link" href="#" role="button" data-bs-toggle="menu" aria-expanded="false">Menu</a>
<div class="menu">
<a class="menu-item" href="#scrollspyHeading3">Third</a>
<a class="menu-item" href="#scrollspyHeading4">Fourth</a>
<hr class="menu-divider">
<a class="menu-item" href="#scrollspyHeading5">Fifth</a>
</div>
</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-1 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。如果一个嵌套的 .nav 是 .active,它的父级也将是 .active。滚动导航栏旁边的区域,并观察活动类的变化。
项目 1
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 1-1
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 1-2
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 2
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 3
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 3-1
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
项目 3-2
这是滚动监视页面的一些占位内容。请注意,当你向下滚动页面时,相应的导航链接会被高亮显示。这在整个组件示例中反复出现。我们在这里继续添加一些示例文本,以强调滚动和高亮显示。
请记住,JavaScript 插件会尝试在所有可能可见的元素中选择正确的元素。多个可见的 scrollspy 目标同时出现可能会引起一些问题。
<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。滚动列表组旁边的区域,观察活动类的变化。
项目 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-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>
调试覆盖
确切地想象 Scrollspy 决定某个部分处于活动状态的位置可能很困难。由于我们的文档页面在目录(右侧导航)上使用了 Scrollspy,你可以启用调试叠加层,在视口上绘制红色指南线以说明其行为。
- 顶部附近的红色虚线是激活线。 当某个部分的标题滚动超过这条线时,该部分就会被激活。在这些文档中,它位于
96px处,就在导航栏下方,有一点空间。 - 到达页面底部时,底部的红色区域会亮起。 在这个区域,即使最后一部分的标题从未到达激活线,它也会保持活跃状态。
滚动页面,观察当标题越过该线时目录中高亮显示的项目如何变化。引导位置是根据插件使用的相同topMargin/rootMargin检测数学计算的。
不可见元素
不可见的目标元素将被忽略,其对应的导航项将不会获得 .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 属性,并使用 id 或任何 Bootstrap .nav 组件父元素的类名。
| 属性 | 描述 |
|---|---|
data-bs-spy="scroll" | 在可滚动元素(通常是<body>)上启用ScrollSpy。 |
data-bs-target | 用于其链接与被监视元素中的部分匹配的导航的CSS选择器。 |
<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'
})
依赖项
如果你是从源代码构建 Bootstrap 的 JS,则 scrollspy 插件需要以下 JavaScript 文件:
| 文件 | 描述 |
|---|---|
js/src/scrollspy.ts | 主滚动监听组件 |
js/src/base-component.ts | 基础组件类 |
js/src/dom/data.ts | 元素数据存储 |
js/src/dom/event-handler.ts | 事件处理工具 |
js/src/dom/manipulator.ts | 数据属性操作 |
js/src/dom/selector-engine.ts | DOM选择器工具 |
js/src/util/config.ts | 配置基类 |
js/src/util/index.ts | 核心实用功能 |
选项
由于选项可以通过数据属性或 JavaScript 传递,你可以将选项名称附加到 data-bs-,就像在 data-bs-animation="{value}" 中一样。确保在通过数据属性传递选项时,将选项名称的大小写类型从“camelCase”更改为“kebab-case”。例如,使用 data-bs-custom-class="beautifier" 而不是 data-bs-customClass="beautifier"。
所有组件都支持一个保留的数据属性 data-bs-config,该属性可以以 JSON 字符串的形式存放简单的组件配置。当一个元素具有 data-bs-config='{"delay":0, "title":123}' 和 data-bs-title="456" 属性时,最终的 title 值将是 456,并且单独的数据属性将覆盖在 data-bs-config 上给定的值。此外,现有的数据属性也可以存放像 data-bs-delay='{"show":0,"hide":150}' 这样的 JSON 值。
最终的配置对象是data-bs-config、data-bs-和js object合并的结果,其中最新提供的键值会覆盖其他键值。
| 名称 | 类型 | 默认 | 描述 |
|---|---|---|---|
rootMargin | 字符串, 空 | null | IntersectionObserver 的高级覆盖 根边距. 当设置它时 优先于 topMargin 并直接传递给观察者(例如 0px 0px -40%). 离开 null 从……推导出激活线 topMargin. |
smoothScroll | boolean | false | 当用户点击指向 ScrollSpy 可观察对象的链接时,启用平滑滚动。一旦滚动停止,URL 哈希和焦点将移动到目标部分。 |
target | 字符串,DOM 元素 | null | 指定要应用 Scrollspy 插件的元素。 |
threshold | array | [0] | IntersectionObserver 门槛 有效输入,在计算滚动位置时。 |
topMargin | string | 12% | ……的位置 激活线,从卷轴根部顶部测量。接受百分比(12%) 或像素 (96px例如,坐在粘性导航栏下方)。被忽略时 rootMargin 已设置。 |
方法
| 方法 | 描述 |
|---|---|
dispose | 销毁一个元素的 ScrollSpy。(移除 DOM 元素上存储的数据) |
getInstance | 静态 方法,用于获取与某个 DOM 元素关联的 ScrollSpy 实例。 |
getOrCreateInstance | 静态 方法,用于获取与某个 DOM 元素关联的 ScrollSpy 实例,或者在未初始化时创建一个新的实例。 |
refresh | 当在 DOM 中添加或移除元素时,需要调用 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...
})