ComponentSlots
ComponentSlots automatically generates complete slot documentation for Vue components via nuxt-component-meta, displaying every slot's name, scoped variable types, and description in a single line of Markdown, greatly reducing the effort of writing API documentation by hand.
Usage
Use the :component-slots syntax in your Markdown documentation:
| Slot | Type |
|---|---|
default | {} |
avatar | {} |
:component-slots{slug="TestApi"}
API
Props
| Prop | Default | Type |
|---|---|---|
slug | 路由路径的最后一段 | string获取组件插槽的 slug 标识 |
Changelog
No recent changes
ComponentProps
ComponentProps automatically reads Vue component metadata via nuxt-component-meta, generating a complete Props documentation table in a single line of Markdown that includes property names, types, default values, and descriptions, with support for specifying the target component name via the slug property.
ComponentEmits
ComponentEmits automatically extracts a Vue component's defineEmits definitions via nuxt-component-meta, generating an Emits documentation table in your Markdown that includes event names, parameter types, and descriptions, with no need to write event API documentation by hand. Use it together with ComponentProps and ComponentSlots.