一个骚气的文章目录自动生成器了解一下

简介: 这个插件根据选定的目录内容中的 h1, h2, h3, h4, h5, h6 标签来自动生成目录插入到选定的目录容器中,并且提供一个漂亮的样式效果。监听内容区滚动点击跳转功能兼容性:IE10+ (由于使用了 node.classList)地址戳这里 github地址,欢迎star,issue,pr ~感兴趣的同学可以加文末的微信群,一起聊聊吧~

这个插件根据选定的目录内容中的 h1, h2, h3, h4, h5, h6 标签来自动生成目录插入到选定的目录容器中,并且提供一个漂亮的样式效果。


  • 监听内容区滚动


  • 点击跳转功能


兼容性:IE10+ (由于使用了 node.classList)


地址戳这里 github地址,欢迎star,issue,pr ~


感兴趣的同学可以加文末的微信群,一起聊聊吧~


1. 预览


炫酷模式:


微信截图_20220426210944.png


普通模式:


微信截图_20220426210949.png


可以通过 线上DEMO 来预览一下炫酷模式的效果


2. 实现思路


滚动的监听通过 getBoundingClientRect 获取元素大小以及相对视口的位置,判断我们的监听对象 h1~h6 标签是否在视口中,如果在则添加 linkActiveClass  类。

传统的锚点定位跳转会与hash模式的单页面应用的路由冲突,会导航到错误的路由路径,这里采用把要跳转的id放到 dataset 中,跳转的时候取出来使用 scrollIntoView 来进行平滑滚动到目标位置。


左边的边栏线则是使用 svg 的path来画出来的,根据层级相应做一些调整,辅以css的 transition 的效果就可以呈现出不错的移动效果。


3. Api


如果要使用默认的样式,请手动引入


import 'progress-catalog/src/progress-catalog.css'
复制代码


使用方法:


// 引入
import Catalog from 'ProgressCatalog'
// 使用 
new Catalog({
  contentEl: 'loading-animation',
  catalogEl: `catalog-content-wrapper`,
  selector: ['h2', 'h3']
})
复制代码


构造函数接受的参数:


contentEl [String]


需要检索生成目录的内容区的id选择器,不需要加#


catalogEl [String]


将生成的目录append进的目录容器的id选择器,不需要加#


scrollWrapper [可选, String]


监听scroll事件的内容区容器的id选择器,不需要加#,如果不填则默认是 contentEl 的父元素


linkClass [可选, String]


所有目录项都有的类,默认值:cl-link


注意,如果设置了此值,则需要重写默认样式


linkActiveClass [可选, String]


激活的目录项所有的类,默认值:cl-link-active


注意,如果设置了此值,则需要重写默认样式


selector [可选, Array]


选择目录的标题标签,默认值:['h1', 'h2', 'h3', 'h4', 'h5', 'h6']

如果只希望生成目标内容区的 h2, h3 标签的目录,那么可以设置 selector: ['h2', 'h3']


activeHook [可选, Function]


当激活新的目录项标签的时候的回调函数


topMargin [可选, Number]


第一个目录标签在被认为可见之前需要向下移动的距离,默认值:0


bottomMargin [可选, Number]


同上,向下移动的距离,默认值:0


cool [可选, Boolean]


炫酷模式开关,默认值:true


网上的帖子大多深浅不一,甚至有些前后矛盾,在下的文章都是学习过程中的总结,如果发现错误,欢迎留言指出~


参考:

  1. 阮一峰 - SVG 图像入门教程
  2. Codepen - Progress Nav
  3. MDN - scrollIntoView
  4. MDN - HTMLElement.dataset



相关文章
|
3月前
|
Linux
【Linux 或Mac系统】自动生成项目结构目录并放在README.md文件中
如何在Linux或Mac系统中使用tree命令自动生成项目结构目录,并将其格式化后放入项目的README.md文件中以展示项目结构。
103 1
|
5月前
vuepress自动生成文件列表【解决方案】
vuepress自动生成文件列表【解决方案】
32 4
|
6月前
|
C# Python
如何让 StyleCop 忽略 refit 自动生成的代码
创建自定义规则:我们需要创建一个自定义规则,该规则将用于排除特定类型的代码,我们可以创建一个自定义规则,用于检查类名是否以大写字母开头,然后忽略符合此规则的代码。
IDEA如何自定义文件类型并自动生成默认代码
IDEA如何自定义文件类型并自动生成默认代码
182 0
|
Java Maven
maven项目新建后缺少目录
maven项目新建后缺少目录
172 0
maven项目新建后缺少目录
|
API 网络架构
docfx 简单使用方法、自动生成目录的工具
docfx 简单使用方法、自动生成目录的工具
354 0
|
分布式数据库 Python
|
Java 开发工具 C语言