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 |
label | string | |
avatar | { src: string; alt?: string; text?: string; chip?: boolean | "circle"; size?: "xs" | "sm" | "md" | "lg" | "xl"; }display an avatar
| |
disabled | boolean |
: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[]需要忽略的属性名数组 |
prose | boolean |