Bootstrap JS Scrollspy
JS Scrollspy
Scrollspy 用于根据滚动位置自动更新导航列表中的链接。
有关 Scrollspy 的教程,请阅读我们的 Bootstrap Scrollspy 教程。
通过 data-* 属性
在应该用作可滚动区域的元素上添加 data-spy="scroll"
(通常这是 <body>
元素)。
然后添加 data-target
属性,其值为导航栏的 ID 或类名 (.navbar
)。这是为了确保导航栏与可滚动区域连接。
请注意,可滚动元素必须与导航栏列表项中链接的 ID 匹配 (<div id="section1">
匹配 <a href="#section1">
)。
可选的 data-offset
属性指定在计算滚动位置时从顶部偏移的像素数。当您觉得导航栏中的链接在跳转到可滚动元素时过早或过晚地更改活动状态时,这很有用。默认值为 10 像素。
**需要相对定位:** 具有 data-spy="scroll" 的元素需要 CSS **position** 属性,其值为 "relative" 才能正常工作。
示例
<!-- 可滚动区域 -->
<body data-spy="scroll" data-target=".navbar" data-offset="50">
<!-- 导航栏 - <a> 元素用于跳转到可滚动区域中的部分 -->
<nav class="navbar navbar-expand-sm bg-dark navbar-dark fixed-top">
<ul class="navbar-nav">
<li class="nav-item">
<a class="nav-link" href="#section1">部分 1</a>
</li>
....
</ul>
</nav>
<!-- 部分 1 -->
<div id="section1">
<h1>部分 1</h1>
<p>尝试滚动此页面,并在滚动时查看导航栏!</p>
</div>
...
</body>
自己尝试 »
通过 JavaScript
使用以下代码手动启用
Scrollspy 选项
选项可以通过 data 属性或 JavaScript 传递。对于 data 属性,将选项名称附加到 data-,如 data-offset=""。
名称 | 类型 | 默认值 | 描述 | 尝试 |
---|---|---|---|---|
offset | 数字 | 10 | 指定在计算滚动位置时从顶部偏移的像素数 | 尝试 |
Scrollspy 方法
下表列出了所有可用的 scrollspy 方法。
方法 | 描述 |
---|---|
.scrollspy("refresh") | 在向 scrollspy 添加和删除元素时,可以使用此方法刷新文档 |
.scrollspy("dispose") | 销毁 scrollspy |
Scrollspy 事件
下表列出了所有可用的 scrollspy 事件。
事件 | 描述 |
---|---|
activate.bs.scrollspy | 当 scrollspy 激活一个新项目时发生 |