ComponentProps

GitHub查看源码
ComponentProps 通过 nuxt-component-meta 自动读取 Vue 组件元数据,在 Markdown 文档中一行代码生成包含属性名称、类型、默认值和说明的完整 Props 文档表格,支持通过 slug 属性指定目标组件名称。

用法

在您的 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
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[]

需要忽略的属性名数组

slug路由路径的最后一段string

获取组件属性的 slug 标识

proseboolean

Changelog

No recent changes
Copyright © 2024 - 2026