点此查看 所有教程、项目、源码导航
文章目录
- [1. 开篇介绍与环境引入](#1. 开篇介绍与环境引入)
- [2. 使用方法](#2. 使用方法)
-
- [2.1 基础页内滚动监听](#2.1 基础页内滚动监听)
- [2.2 offset 偏移调整](#2.2 offset 偏移调整)
- [2.3 监听整个body页面滚动](#2.3 监听整个body页面滚动)
- [3. 底层实现关键点解析](#3. 底层实现关键点解析)
- [4. 小结](#4. 小结)
1. 开篇介绍与环境引入
滚动监听 Scrollspy,监听页面滚动位置,自动给导航菜单匹配对应激活项,常用于侧边导航、页内目录,滚动页面时同步高亮当前所在章节。
先引入BootStrap相关的环境:
html
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="UTF-8">
<title></title>
<!-- Bootstrap 5 CSS -->
<link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/5.3.8/css/bootstrap.min.css">
</head>
<body>
<!-- Bootstrap JS + Popper,用于部分交互 -->
<script src="https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/5.3.8/js/bootstrap.bundle.min.js"></script>
</body>
</html>
2. 使用方法
2.1 基础页内滚动监听
给滚动容器添加 data-bs-spy="scroll",data-bs-target 绑定导航容器;导航内链接的 href 对应章节id。
html
<!-- 导航菜单 -->
<nav id="spyNav" class="nav nav-pills mb-3">
<a class="nav-link" href="#section1">第一节</a>
<a class="nav-link" href="#section2">第二节</a>
<a class="nav-link" href="#section3">第三节</a>
</nav>
<!-- 滚动区域,设置高度、溢出滚动 -->
<div data-bs-spy="scroll" data-bs-target="#spyNav" data-bs-offset="10" style="height:300px;overflow-y:auto;">
<div id="section1" style="height:200px;">
<h4>第一节内容</h4>
<p>滚动到这里,导航第一节自动高亮</p>
</div>
<div id="section2" style="height:200px;">
<h4>第二节内容</h4>
<p>滚动到这里,导航第二节自动高亮</p>
</div>
<div id="section3" style="height:200px;">
<h4>第三节内容</h4>
<p>滚动到这里,导航第三节自动高亮</p>
</div>
</div>
效果:

2.2 offset 偏移调整
data-bs-offset 用来设置触发激活的偏移量,单位px,适合顶部有固定导航栏,内容被遮挡的场景。
html
<div data-bs-spy="scroll" data-bs-target="#spyNav" data-bs-offset="80" style="height:300px;overflow-y:auto;">
...
</div>
效果:

2.3 监听整个body页面滚动
如果是整页滚动,直接把属性写在body上,target绑定目录导航。
html
<body data-bs-spy="scroll" data-bs-target="#spyNav" data-bs-offset="50">
效果:

3. 底层实现关键点解析
下面是精简复刻版本,去掉大量浏览器兼容代码,只保留核心逻辑。
使用上面的HTML代码,加下面自己写的CSS + JS,能得到基本类似的效果,大家可以尝试下。
css
/* 导航激活样式,和bootstrap保持一致 */
.nav-link.active {
color: #fff;
background-color: #0d6efd;
}
js
// 简易复刻 Scrollspy 滚动监听核心逻辑
class SimpleScrollSpy {
constructor(scrollEl, options = {}) {
this.scrollEl = scrollEl;
// 导航容器选择器
this.targetSelector = options.target;
// 滚动偏移阈值
this.offset = options.offset || 0;
this.navWrap = document.querySelector(this.targetSelector);
this.navLinks = this.navWrap.querySelectorAll('a[href^="#"]');
// 收集所有章节锚点
this.sections = [];
this.navLinks.forEach(link => {
const id = link.getAttribute('href');
const section = document.querySelector(id);
if(section) {
this.sections.push({
el: section,
link: link
})
}
})
// 绑定滚动事件
this.scrollEl.addEventListener('scroll', () => this.checkScroll())
}
checkScroll() {
// 获取当前滚动位置
const scrollTop = this.scrollEl.scrollTop + this.offset;
let activeItem = null;
// 遍历章节,找到当前滚动命中的章节
this.sections.forEach(item => {
const top = item.el.offsetTop;
if(scrollTop >= top) {
activeItem = item;
}
})
// 清除所有激活状态
this.navLinks.forEach(link => link.classList.remove('active'))
// 给当前匹配导航加上active
if(activeItem) {
activeItem.link.classList.add('active')
}
}
}
// 初始化
document.querySelectorAll('[data-bs-spy="scroll"]').forEach(spyEl => {
new SimpleScrollSpy(spyEl, {
target: spyEl.dataset.bsTarget,
offset: Number(spyEl.dataset.bsOffset) || 0
})
})
效果:

4. 小结
- Scrollspy 依靠滚动位置判断,自动给导航链接添加
active类,纯联动,不会自动生成导航。 data-bs-target必须指向导航容器,导航链接href必须和章节id一一对应。data-bs-offset是高频配置,顶部固定导航栏时,加大偏移避免高亮提前。- 可以监听局部滚动容器,也可以监听body整页滚动。
- 只监听垂直滚动,不支持横向滚动监听。
- 章节id不能重复,锚点链接必须是
#id形式,否则无法匹配。