SuperAPI AI 工具集

sgds-components-table-of-contents

前端与建站

查看项目

更新于 10-16 05:49

技能介绍

用途:此技能用于在使用 SGDS Web Component 的页面中渲染页内导航目录,把内容分区标题链接成锚点列表,方便读者在同一页面内跳转。

主要能力:<sgds-table-of-contents> 本身没有属性、事件和公开方法。它通过两个插槽工作:默认插槽放置目录标题元素(例如 <h3>Contents</h3>,建议使用语义化标题元素);contents 插槽放置若干 <li> 元素,每个 <li> 内使用 <sgds-link> 包裹锚点链接 <a href="#section-id">标签</a>。

必要用法:先参考 sgds-components-setup 完成安装与框架集成(涉及 React 19+、React ≤18、Vue、Angular 的差异)。然后按下面的结构编写:先在组件默认插槽写入标题,再为每个目录条目添加带 slot="contents" 的 <li>,其中嵌套 <sgds-link><a href="#section-id">…</a></sgds-link>。锚点的 href 值需要与目标页面分区的 id 属性一致(如 #overview、#installation、#usage、#api、#changelog),并在对应分区元素上设置相同 id。

适用场景:内容较长、需要分区导航的文档页或说明页。若需要的是标准内容页目录,使用本组件;若每个条目需要链接到页面分区,则在每个 <li> 内使用 <sgds-link> 与 <a href="#section-id">。

限制:该组件不暴露自定义属性和 CSS part,因此不能通过自定义属性或 CSS part 修改样式。它在文档中列出的插槽、事件与 API 情况如上;官方资料未提供更多属性、价格或平台信息。