ComponentProps

自动生成 Vue 组件 Props 文档表格。

用法

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

Prop Default Type
color'primary'"error" | "primary" | "secondary" | "success" | "info" | "warning" | "neutral"
size'md'"xs" | "sm" | "md" | "lg" | "xl"
variant'solid'"link" | "solid" | "outline" | "soft" | "subtle" | "ghost"

The variant of the component

labelstring
avatar{ src: string; alt?: string; text?: string; chip?: boolean | "circle"; size?: "xs" | "sm" | "md" | "lg" | "xl"; }

display an avatar

disabledboolean
:component-props{slug="TestApi"}

API

Props

Prop Default Type
slug路由路径的最后一段string

获取组件属性的 slug 标识

ignore[ "activeClass", "inactiveClass", "exactActiveClass", "ariaCurrentValue", "href", "rel", "noRel", "prefetch", "prefetchOn", "noPrefetch", "prefetchedClass", "replace", "exact", "exactQuery", "exactHash", "external", "onClick", "viewTransition", "enterKeyHint", "form", "formaction", "formenctype", "formmethod", "formnovalidate", "formtarget" ]string[]

需要忽略的属性名数组

proseboolean

Changelog

4e45d — refactor: 重构组件结构和优化代码组织

d68bc — feat: 增强组件属性显示功能

586a5 — ✨ feat: 添加 Nuxt 文档主题 layer 核心代码

Copyright © 2024 - 2026