加载中...

vue3-catalog-view

link 2025.06.27 21:16 16

version LICENSE

项目介绍

一个 Vue3 组件, 自动根据标签提取文章中的目录

功能介绍

  • 自动根据标签提取文章中的目录
  • 可以观测内容变化和容器宽度变化自动更新
  • 支持锚点
  • 内置两种主题
  • 可以自定义样式

安装

npm install vue3-catalog-view
yarn add vue3-catalog-view
pnpm install vue3-catalog-view

文档

文档

Attributes

属性名 说明 类型 默认值
type 主题类型 default | line | point default
contentContainer 文章内容容器 HTMLElement | VueInstance document.body
scrollContainer 滚动容器 HTMLElement | VueInstance window
selector 目录匹配标签或类 string[] [“h1”, “h2”, “h3”, “h4”, “h5”, “h6”]
topDistance 标题距离顶部距离 number 0
indent 子目录缩进距离 number 15
useAnchor 使用锚点 boolean false
isWatch 监听内容变化 boolean true
ellipsis 超出一行显示省略号 boolean true

Slots

插槽名 说明
default 自定义目录内容

更新日志

更新日志

许可证

License MIT