1 Star 14 Fork 0

张鑫旭 / smart-nav

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

smart-nav

介绍

借助IntersectionObserver API实现文档标题的自动导航能力,带实验性质,不适合在正式项目中使用。

演示

戳这里:https://www.zhangxinxu.com/study/202011/intersection-observer-title-nav.html

使用说明

引入JS文件:

<script src="./smart-nav.js"></script>

调用:

smartNav('article h3');

会把符合选择器'article h3'的元素聚合成和快速定位的导航元素。

语法

smartNav(elements, options);

其中:

elements
必需。标题元素们,可以是Nodelist对象,也可以是元素的选择器字符串。
options
可选。目前支持一个参数如下表:
API名称 默认值 释义
nav null 导航容器对象,创建的导航列表会append到这里。如果为null,本JS会自动创建一个容器元素,结构为:div.title-nav-ul > a.title-nav-li

许可证

MIT

MIT License Copyright (c) 2020 张鑫旭 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

借助IntersectionObserver API实现文档标题的自动导航能力,带实验性质,不适合在正式项目中使用。 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/zhangxinxu/smart-nav.git
git@gitee.com:zhangxinxu/smart-nav.git
zhangxinxu
smart-nav
smart-nav
master

搜索帮助