API

View source
学习如何利用内置的文档组件,为您的组件自动生成全面而专业的 API 文档,内容涵盖属性(Props)、插槽(Slots)和事件(Emits)。

用法

在您的 Markdown 文档中,使用以下语法来生成不同类型的 API 文档:

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

Slots

Slot Type
default
avatar

{}

Emits

Event Type
change
delete

any[]

### Props

:component-props{slug=Api}

### Slots

:component-slots{slug=Api}

### Emits

:component-emits{slug=Api}
Copyright © 2024 - 2025