ComponentEmits

GitHub 查看源码

ComponentEmits 通过 nuxt-component-meta 自动提取 Vue 组件的 defineEmits 定义，在 Markdown 文档中生成包含事件名称、参数类型和说明的 Emits 文档表格，无需手动编写事件 API 说明，与 ComponentProps 和 ComponentSlots 配合使用。

用法

在您的 Markdown 文档中使用 :component-emits 语法：

Event	Type
`change`	`any[]`
`delete`	`any[]`

:component-emits{slug="TestApi"}

API

Props

Prop	Default	Type
`slug`	`路由路径的最后一段`	`string` 获取组件事件的 slug 标识

Changelog

No recent changes

ComponentSlots

ComponentSlots 通过 nuxt-component-meta 自动为 Vue 组件生成完整的 Slot 插槽文档，在 Markdown 中一行代码即可展示所有插槽的名称、作用域变量类型和功能说明，大幅简化手写 API 文档的工作量。

ComponentExample

ComponentExample 在文档中嵌入交互式 Vue 组件示例，实时渲染预览效果并展示带语法高亮的源代码，支持折叠显示。通过 useFetchComponentExample 获取构建时注册的示例文件，显著提升文档的可读性和用户体验。