Table of Contents

通过锚点链接浏览文章章节,目录指示器随阅读位置更新。

适用场景

  • 用于较长的指南、参考文档或文章,让读者快速跳转章节并确认阅读位置。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/table-of-contents.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

Overview

Follow this article using the links alongside it. The active section updates as you scroll.

Installation

Follow this article using the links alongside it. The active section updates as you scroll.

Usage

Follow this article using the links alongside it. The active section updates as you scroll.

Accessibility

Follow this article using the links alongside it. The active section updates as you scroll.

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
TableOfContentsv-modelstringupdate:modelValue

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

items
TableOfContentsItem[]
—
target?
string | HTMLElement | ComponentPublicInstance | Ref<HTMLElement | ComponentPublicInstance | null | undefined, HTMLElement | ComponentPublicInstance | null | undefined> | () => HTMLElement | null
—
offset?
number
88
modelValue?
string
local.value
title?
string
"On this page"

事件

update:modelValue
[id: string]
@update:modelValue

插槽

title
() => unknown
#title
item
(props: { item: TableOfContentsItem; active: boolean; }) => unknown

作用域参数: item, active

#item

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Table of Contents?
传入包含稳定章节 ID 的 items,以及正文元素或选择器 target。通过 modelValue 与 update:modelValue 读取阅读位置;offset 默认 88px。
如何连接到应用状态?
监听 update:modelValue,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于