Back to Blog

Una UI 核心组件 API 摘要 (精简版)

Archive

这篇文章不是给人类看的

Published on 12/18/2025

数据展示与布局 (Data Display & Layout)

Accordion (手风琴)

描述: 一组垂直堆叠的交互式标题,每个标题都会显示一个内容部分 核心属性 (Props):

Prop默认值类型描述
items[]array设置手风琴项目。
item.value-string用于渲染和状态跟踪的唯一值。
typesingle`‘single’ \‘multiple’`
defaultValue-`string \string[]`
unmountOnHidetrueboolean设置为 false 可保持内容被挂载,即使手风琴已关闭(出于性能考虑,默认关闭不渲染),。
_accordionTrigger.leading-string为手风琴设置自定义前置图标。
accordionborder divider{variant}手风琴的变体。

插槽 (Slots):

NameProps描述
default{ modelValue }填充 AccordionItem 组件。
item{ open, item, index }手风琴的项目。
trigger{ open, item, index }触发按钮。
content{ open, item, index }手风琴的内容。
#{value}-content-针对特定项目(按其 value)定制内容。

Aspect Ratio (纵横比)

描述: 在所需的纵横比内显示内容。 核心属性 (Props):

Prop默认值类型描述
ratio1number期望的纵横比。例如:16/9
aspect-ratiosoft-gray{variant}-{color}更改组件的样式。
roundedmdstring设置圆角。

插槽 (Slots):

NameProps描述
defaultaspect默认插槽。

Avatar (头像)

描述: 一个带有回退机制的图像元素,用于表示用户。 核心属性 (Props):

Prop默认值类型描述
src-string图像源。
alt-string替代文本。
label-string加载时的占位符(默认为 alt 属性中每个单词的首字母)。
avatarsoft{variant}头像的变体。
iconfalseboolean如果为 truelabel 将被包装为图标组件。
sizemdstring设置头像的大小。
roundedfullstring设置圆角。

插槽 (Slots):

NameProps描述
default-头像的图像元素。
fallback-头像的回退元素。

Avatar Group (头像组)

描述: 显示一组 Avatar 组件。 核心属性 (Props):

Prop默认值类型描述
maxnumber在隐藏其余头像之前显示的最大数量。
overflow-label+${N}string覆盖默认的溢出标签。
sizemdstring设置头像的大小。
square2.5emstring设置头像为方形。

插槽 (Slots):

NameProps描述
default-AvatarGroup 组件的默认插槽。

Badge (徽章)

描述: 显示一个徽章或看起来像徽章的组件。 核心属性 (Props):

Prop默认值类型描述
label-string徽章的标签。
badgesoft{variant}徽章的变体。
badge{variant}-primary{variant}-{color}徽章的颜色。
sizexsstring更改大小。
closablefalseboolean添加一个关闭按钮。

事件 (Events):

Event Name描述
@close点击关闭图标时触发事件(与 closable 配合使用)。

插槽 (Slots):

NameProps描述
default-徽章标签。

Card (卡片)

描述: 显示带有页眉、内容和页脚的卡片。 核心属性 (Props):

Prop默认值类型描述
title-string设置卡片页眉中显示的主标题文本。
description-string提供显示在标题下方的副文本。
cardoutline{variant}控制卡片的视觉样式。
card{variant}-primary{variant}-{color}结合变体和颜色来定义卡片外观。

插槽 (Slots):

NameProps描述
header-卡片的页眉部分。
default-卡片的主要内容区域。
title-覆盖 title 属性的自定义标题内容。
footer-卡片的页脚部分。

Collapsible (可折叠)

描述: 一个可展开/折叠面板的交互式组件。 核心属性 (Props):

Prop默认值类型描述
defaultOpenfalseboolean初次渲染时的开放状态。
disabled-booleantrue 时,阻止用户与组件交互。
open-boolean受控的开放状态 (v-model 绑定)。

插槽 (Slots):

NameProps描述
defaultopen可折叠根插槽。
content-可折叠内容插槽。
triggeropen按钮触发器插槽。

Icon (图标)

描述: 显示来自各种图标库的图标。

  • 注意: UnaUI 默认集成了 Iconify,并包含 Lucide、Reka Icons 和 Tabler Icons。

Indicator (指示器)

描述: 显示一个指示器,可用于显示任务或组件的状态。 核心属性 (Props):

Prop默认值类型描述
label-string指示器的标签。
indicatorsolid{variant}指示器的变体。
indicator{variant}-primary{variant}-{color}指示器的颜色。
pingfalseboolean启用 Ping 动画。
sizemdstring指示器的大小。
visibletrueboolean显示或隐藏指示器。
indicatortop-right{placement}指示器的位置(例如 top-right, bottom-left)。

插槽 (Slots):

NameProps描述
default-指示器的内容。
indicator-整个指示器(会重置位置)。
label-指示器的标签。

Kbd (键盘按键)

描述: 指示通常通过键盘输入的输入。 核心属性 (Props):

Prop默认值类型描述
kbdsolid{variant}Kbd 的变体。
kbd{variant}-gray{variant}-{color}Kbd 的颜色。
sizemdstringKbd 的大小。

插槽 (Slots):

NameProps描述
default-内容插槽。

Progress (进度条)

描述: 显示任务完成进度的指示器,通常显示为进度条。 核心属性 (Props):

Prop默认值类型描述
modelValue-number进度值 (v-model 绑定)。
max100number最大进度值。
indeterminatefalseboolean使进度条不确定(无特定值时动画)。
getValueLabel默认百分比((value: number, max: number) => string)获取可访问标签文本的函数。
roundedfullstring设置进度条的圆角。
progressprimarystring设置进度条的颜色。
sizemdstring设置进度条的大小。

插槽 (Slots):

NameProps描述
default-进度指示器。

Separator (分隔符)

描述: 在视觉或语义上分隔内容。 核心属性 (Props):

Prop默认值类型描述
label-string标签内容。
separatorsolid-gray{variant}-{color}设置分隔符的变体和颜色。
orientationhorizontalhorizontal, vertical设置分隔符的方向。
separator-positioncentercenter, left, right, top, bottom设置标签内容的位置。
size-string设置分隔符的大小。

插槽 (Slots):

NameProps描述
default-标签内容。

Skeleton (骨架屏)

描述: 用于在内容加载时显示占位符。 核心属性 (Props):

Prop默认值类型描述
roundednonestring更改骨架的形状。
skeletongraystring更改骨架的颜色。

插槽 (Slots):

NameProps描述
default-默认插槽。

表单与输入 (Forms & Inputs)

Checkbox (复选框)

描述: 允许用户在“选中”和“未选中”之间切换的控件。 核心属性 (Props):

Prop默认值类型描述
modelValue-boolean, indeterminate受控选中状态 (v-model 绑定)。
defaultValue-boolean初始渲染时的选中状态。
disabled-boolean禁用交互。
label-string设置复选框的标签。
colorprimarystring更改复选框的颜色。
sizemdstring调整复选框的大小。
reverse-boolean反转复选框和标签的位置。
una.checkboxCheckedIconi-checkstring选中时的自定义图标。

插槽 (Slots):

NameProps描述
default-用于定制复选框的标签。
iconstate, modelValue用于定制复选框的图标。

Combobox (组合框)

描述: 带有建议列表的自动完成输入和命令面板。 核心属性 (Props):

Prop默认值类型描述
items-`T[] \NComboboxGroupProps[]`
modelValue-`AcceptableValue \AcceptableValue[]`
multiplefalseboolean启用多项选择模式。
labelKeylabelstring用于在选择项中显示的键名。
textEmptyNo items found.string组合框为空时显示的文本。
_comboboxTrigger{ btn: 'solid-white', ... }NComboboxTriggerProps触发按钮的属性。
sizesmstring调整组件的整体大小。

插槽 (Slots):

NameProps描述
default-用于使用子组件进行高级自定义渲染的插槽。
triggermodelValue, open默认触发按钮 内部 的自定义内容。
itemitem, selected每个组合框项的整个内容的自定义渲染。
header-列表内部、项目之前渲染的内容。
footer-列表内部、项目之后渲染的内容。

Input / Textarea (输入框 / 文本区域)

描述: 显示表单输入字段或看起来像输入字段的组件。 核心属性 (Props):

Prop默认值类型描述
type-`HTMLInputElement[‘type’] \textarea`
modelValue-any输入的值。
reversefalseboolean交换前置和后置图标的位置。
inputoutline{variant}输入的变体。
input{variant}-primary{variant}-{color}输入的颜色。
sizemdstring更改输入的大小。
leading-string显示前置图标。
trailing-string显示后置图标。
loading-boolean显示加载状态。
status-info, success, warning, error更新输入状态。
rows (Textarea only)-number设置文本区域的行数。
autoresize (Textarea only)falseboolean number启用文本区域自动调整大小。

事件 (Events):

Event描述
@leading点击前置图标时触发。
@trailing点击后置图标时触发。

暴露的方法 (Expose):

Name类型描述
focus() => void自动聚焦输入框。

插槽 (Slots):

NameProps描述
default-内容插槽。
leading-前置插槽。
trailing-后置插槽。

Label (标签)

描述: 渲染与控件关联的可访问标签。 核心属性 (Props):

Prop默认值类型描述
aslabelAsTag, Component此组件应渲染为的元素或组件。
forstringstring标签关联元素的 ID。
labelstringstring标签文本(默认插槽的替代方案)。

插槽 (Slots):

NameProps描述
default-内容插槽。

Number Field (数字输入框)

描述: 允许用户输入和调整数值,带有可选的递增和递减控件。 核心属性 (Props):

Prop默认值类型描述
modelValue-`number \null`
max-number允许的最大值。
min-number允许的最小值。
step1number每次递增或递减时的变化量。
disableWheelChange-booleantrue 时,阻止滚轮滚动时值改变。
number-fieldoutline-primary{variant}-{color}控制数字字段的视觉样式。
sizemdstring更改大小。
leading-string输入前显示的图标。

插槽 (Slots):

NameProps描述
default-用于使用子组件进行高级自定义渲染。
increment-数字字段递增按钮的自定义内容。
decrement-数字字段递减按钮的自定义内容。

Pin Input (PIN 输入)

描述: 用于输入短序列数字或字符的组件,通常用于验证码或 PIN 码。 核心属性 (Props):

Prop默认值类型描述
modelValue-`PinInputValue \null`
maxLength-number指定 PIN 输入的字段数量。
maskboolean-启用时将值屏蔽为密码字段。
otpboolean-在支持的移动设备上启用 OTP 自动检测和自动完成。
groupBy0number指定要分组的输入字段数量。
pin-inputoutline-primary{variant}-{color}控制 PIN 输入的视觉样式。
sizemdstring更改大小。
separatorfalse`boolean \string`

插槽 (Slots):

NameProps描述
default-允许使用子组件进行高级自定义渲染。
group-替换整个组容器(包括输入和分隔符)。
separator-PIN 输入的自定义分隔符。

Radio Group (单选组)

描述: 一组可选中按钮,同一时间只能选中其中一个。 核心属性 (Props):

Prop默认值类型描述
modelValue-string受控值 (v-model 绑定)。
items-RadioGroupItem[]要渲染的单选项目。
valueKeyvaluestring用于 value 属性的键名。
orientationverticalvertical, horizontal控制布局方向。
radio-groupprimary{color}设置单选组的颜色。
sizemdstring设置单选组的大小。
item.icon-string特定项目的图标。

插槽 (Slots):

NameProps描述
defaultitems项目插槽。
label-标签插槽。
icon-图标插槽。

Select (选择框)

描述: 显示供用户选择的选项列表,由按钮触发。 核心属性 (Props):

Prop默认值类型描述
items-`T[] \SelectGroup[]`
modelValue-string受控值 (v-model 绑定)。
placeholder-string未设置值时在 SelectValue 中渲染的内容。
multiplefalseboolean启用多选模式。
groupSeparatorfalseboolean是否在组之间显示分隔符。
valueKey-string在选中值中显示的键名。
selectsoft-white{variant}-{color}更改选择框的颜色。
sizesmstring调整组件的整体大小。

插槽 (Slots):

NameProps描述
defaultmodelValue, open对根元素和状态的完全访问。
triggermodelValue, open自定义触发器内容。
valuemodelValue, open自定义触发器中选定值的显示。
itemitem自定义单个下拉项。

Slider (滑块)

描述: 允许用户在给定范围内选择值的输入。 核心属性 (Props):

Prop默认值类型描述
modelValue-number受控值 (v-model 绑定)。
max100number最大值。
min0number最小值。
step1number步进值。
orientationhorizontalvertical, horizontal滑块的方向。
sliderprimarystring更改滑块的颜色。
sizemdstring设置滑块的常规大小。

插槽 (Slots):

NameProps描述
slider-track-滑块的轨道。
slider-thumb-滑块的滑块(Thumb)。

Switch (开关)

描述: 允许用户在“选中”和“未选中”之间切换的控件。 核心属性 (Props):

Prop默认值类型描述
modelValue-boolean受控状态 (v-model 绑定)。
disabledfalseboolean禁用交互。
switch-checkedprimarystring选中时开关的颜色。
switch-uncheckedgraystring未选中时开关的颜色。
sizemdstring更改开关的大小。
checkedIcon-string开关打开时显示的图标。
loading-boolean设置开关处于加载状态。

插槽 (Slots):

NameProps描述
iconchecked开关在选中和未选中状态下的自定义图标。
loading-iconchecked加载图标插槽。

Toggle (切换按钮)

描述: 一个可以打开或关闭的双状态按钮。 核心属性 (Props):

Prop默认值类型描述
modelValue-boolean受控按下状态 (v-model 绑定)。
disabledfalseboolean禁用用户交互。
toggle-onsoft-accent{variant}-{color}切换按钮打开时的颜色。
toggle-offghost-gray{variant}-{color}切换按钮关闭时的颜色。

Toggle Group (切换按钮组)

描述: 一组可切换开/关的双状态按钮。 核心属性 (Props):

Prop默认值类型描述
items[]Array<T>在切换组中显示的项。
modelValue-`AcceptableValue \Array`
type-`single \multiple`
orientationhorizontalhorizontal, vertical设置切换组的方向。
toggle-onsoft-accent{variant}-{color}项目打开时的颜色。
sizesmstring调整切换组的整体大小。

插槽 (Slots):

NameProps描述
defaultmodelValue默认插槽,覆盖所有内容。
itemitem, active项目静态插槽。

描述: 使用链接层次结构显示当前资源的路径。 核心属性 (Props):

Prop默认值类型描述
items[]array链接数组。
separatori-radix-icons-chevron-rightstring分隔符图标。
ellipsisi-radix-icons-dots-horizontalstring省略号图标。
sizesmstring调整组件的整体大小。
breadcrumb-activetext-primary{variant}-{color}活动面包屑的变体和颜色。

插槽 (Slots):

NameProps描述
defaultitem index isActive面包屑项目。
separatoritem分隔符。
dropdownitem如果可用(省略号)则为下拉菜单。

Button (按钮)

描述: 显示一个按钮或看起来像按钮的组件。 核心属性 (Props):

Prop默认值类型描述
label-string按钮的标签。
btnsolid{variant}按钮的变体。
btn{variant}-primary{variant}-{color}按钮的颜色。
sizesmstring更改按钮的大小。
block-boolean设置按钮为全宽。
leading-string显示前置图标。
trailing-string显示后置图标。
loading-boolean设置按钮为加载状态。
to-string导航链接。

插槽 (Slots):

NameProps描述
default-按钮标签。
leading-前置图标。
trailing-后置图标。
loading-加载图标。

描述: 提供一个自定义的 <NuxtLink> 组件来处理应用程序内的任何类型的链接。 核心属性 (Props):

Prop默认值类型描述
label-string链接的标签。
activeClass-string链接激活时应用的类。
exactfalseboolean仅在路径完全匹配时触发活动类。
disabledfalseboolean链接是否禁用。

插槽 (Slots):

NameProps描述
default-链接的内容。

描述: 显示用于导航网站的链接集合。 核心属性 (Props):

Prop默认值类型描述
items[]T在导航菜单中显示的项。
modelValue-string要激活的菜单项的受控值 (v-model 绑定)。
indicatorfalseboolean设置在列表下方渲染的指示器。
orientationhorizontalhorizontal, vertical设置菜单的方向。
sizesmstring调整组件的整体大小。
navigation-menughost-white{variant}-{color}设置导航菜单的变体和颜色。

插槽 (Slots):

NameProps描述
defaultitems默认插槽,覆盖所有内容。
triggeritem, index, modelValue触发器插槽。
itemitem, active项目静态插槽。
item-contentitems, item内容静态插槽。

Pagination (分页)

描述: 带有页面导航、下一页和上一页链接的分页。 核心属性 (Props):

Prop默认值类型描述
total0number列表中的总项目数。
page-number当前页的受控值 (v-model:page 绑定)。
itemsPerPage10number每页的项目数。
siblingCount2number当前页面周围显示的环绕页数。
showEdgesfalsebooleantrue 时,始终显示第一页、最后一页和省略号。
sizesmstring调整整个分页的大小。
pagination-selectedsolid-primary{variant}-{color}选中页面的颜色。

插槽 (Slots):

NameProps描述
first-自定义第一页导航按钮。
list-itemitem, page自定义分页列表项组件。
ellipsis-自定义省略号指示器。

叠加与浮层 (Overlays & Popups)

Alert Dialog (警告对话框)

描述: 一个模态对话框,用重要内容打断用户并期望响应。 核心属性 (Props):

Prop默认值类型描述
title-string对话框的标题。
description-string对话框的描述。
open-boolean受控的开放状态 (v-model:open 绑定)。
preventClose-boolean如果为 true,对话框不会因点击叠加层或按 Esc 键而关闭。
_alertDialogAction{ btn: 'soft-primary', ... }AlertDialogActionProps行动按钮的属性。

事件 (Events):

Event Name描述
@action点击行动按钮时触发(通常用于确认破坏性操作)。
@cancel点击取消按钮或对话框被关闭时触发。

插槽 (Slots):

NameProps描述
default-允许使用子组件进行高级自定义渲染,替换默认结构。
triggeropen用于打开对话框的触发按钮。
action-行动按钮的自定义内容。
header-包含标题和描述的页眉部分。

Dialog (对话框)

描述: 一个覆盖在主窗口或另一个对话框窗口上的窗口,使下方内容处于惰性状态。 核心属性 (Props):

Prop默认值类型描述
title-string对话框的标题。
open-boolean受控的开放状态 (v-model:open 绑定)。
modaltrueboolean对话框的模态性。
scrollablefalseboolean如果为 true,对话框将具有可滚动主体。
preventClose-boolean如果为 true,对话框不会因点击叠加层或按 Esc 键而关闭。

插槽 (Slots):

NameProps描述
default-主体插槽。
content-整个内容插槽。
header-包含标题和描述插槽。
footer-页脚。

Drawer (抽屉)

描述: 一个用于 Vue 的抽屉组件。 核心属性 (Props):

Prop默认值类型描述
open-boolean受控开放状态 (v-model:open 绑定)。
directionbottom`top \bottom \
snapPoints-`number \string`
dismissibletruebooleanfalse 时,拖动、点击外部、按 Esc 键等操作不会关闭抽屉。
shouldScaleBackground-boolean确定对话框打开时背景内容是否应该缩小。

插槽 (Slots):

NameProps描述
default-允许使用子组件进行高级自定义渲染。
triggeropen用于打开抽屉的触发按钮。
body-抽屉主体中显示的内容。
footer-抽屉页脚的自定义内容。

描述: 显示一个菜单(例如一组操作或功能),由按钮触发。 核心属性 (Props):

Prop默认值类型描述
items[]DropdownMenuItemProps[]在下拉菜单中显示的项。
openfalseboolean受控的开放状态 (v-model:open 绑定)。
insetfalseboolean设置下拉菜单为内嵌。
sizesmstring调整组件的整体大小。
dropdown-menusolid-white{variant}-{color}更改下拉菜单的颜色。

插槽 (Slots):

NameProps描述
trigger-触发器插槽。
itemitem项目插槽。
contentitems内容插槽。
groupitems组插槽。

Hover Card (悬停卡片)

描述: 供视力正常的用者预览链接后面的内容。 核心属性 (Props):

Prop默认值类型描述
open-boolean受控的开放状态 (v-model:open 绑定)。
openDelay700number鼠标进入触发器到卡片打开的持续时间。
closeDelay300number鼠标离开触发器或内容到卡片关闭的持续时间。
hovercardoutline-gray{variant}-{color}设置悬停卡片的变体和颜色。
arrowfalseboolean设置与悬停卡片一起渲染的箭头。

插槽 (Slots):

NameProps描述
default-允许使用子组件进行高级自定义渲染。
triggeropen触发器插槽。
content-用于显示卡片全部内容的内容插槽。

Popover (气泡框)

描述: 在门户中显示由按钮触发的丰富内容。 核心属性 (Props):

Prop默认值类型描述
openfalseboolean受控的开放状态。
modalfalseboolean气泡框的模态性。
_popoverContent.sidetoptop, right, bottom, left气泡框打开时首选的渲染侧。
_popoverContent.sideOffset-number与触发器的距离(以像素为单位)。

插槽 (Slots):

NameProps描述
triggeropen按钮触发器。
default-气泡框内容。

Sheet (侧边抽屉)

描述: 扩展 Dialog 组件以显示与屏幕主内容互补的内容。 核心属性 (Props):

Prop默认值类型描述
title-string抽屉的标题。
open-boolean受控的开放状态 (v-model:open 绑定)。
sheetrightstring抽屉出现的一侧 (top, right, bottom, left)。
preventClose-boolean如果为 true,抽屉不会因点击叠加层或按 Esc 键而关闭。
_sheetContent-object内容属性。

插槽 (Slots):

NameProps描述
default-主体插槽。
content-整个内容插槽。
header-包含标题和描述插槽。
footer-页脚。

Toast (通知/吐司)

描述: 临时显示的简洁消息。 核心属性 (Props):

Prop默认值类型描述
title-string通知标题。
description-string通知描述。
closabletrueboolean显示关闭按钮。
actions[]Action[]操作数组。
leading-string通知的前置图标。
toastoutline-gray{variant}-{color}设置通知的变体和颜色。
progressprimary{color}设置进度条颜色。
Provider prop: duration4000number设置通知的持续时间(毫秒)。

插槽 (Slots):

NameProps描述
default-触发器插槽。
actions-操作插槽。
title-标题插槽。
closeIcon-关闭图标插槽。

Tooltip (工具提示)

描述: 当元素接收到键盘焦点或鼠标悬停时,显示与该元素相关的信息的弹出窗口。 核心属性 (Props):

Prop默认值类型描述
content-string设置工具提示内容。
openfalseboolean受控的开放状态。
disabled-boolean禁用工具提示。
tooltipblackstring设置工具提示颜色。
sizexsstring设置工具提示的常规大小。
Content prop: sidetoptop right bottom left气泡框首选的渲染侧。

插槽 (Slots):

NameProps描述
default-触发器插槽。
content-内容插槽。

复杂与高级组件 (Complex & Advanced)

Resizable (可调整大小面板)

描述: 具有键盘支持的可访问可调整大小面板组和布局。

  • 注意: 该组件使用子组件 (ResizablePanelGroup, ResizablePanel, ResizableHandle) 配合使用。 核心属性 (Panel Group Props):
Prop默认值类型描述
direction*-vertical, horizontal分组方向(必需属性)。
autoSaveIdnullstring, null用于通过 localStorage 自动保存分组排列的唯一 ID。

核心属性 (Handle Props):

Prop默认值类型描述
iconi-lucide-grip-verticalboolean, string向调整大小手柄添加图标。
resizableHandlesolid-gray{variant}-{color}自定义手柄颜色。
disabled-boolean禁用拖动手柄。

核心属性 (Panel Props):

Prop默认值类型描述
defaultSize-number面板的初始大小 (1-100)。
minSize10number面板的最小允许大小 (1-100)。
collapsible-boolean当调整大小超出 minSize 时面板是否应该折叠。

Scroll Area (滚动区域)

描述: 增强原生滚动功能,以实现自定义的跨浏览器样式。 核心属性 (Props):

Prop默认值类型描述
typehoverscroll, always, auto, hover描述滚动条可见性的性质。
scrollHideDelay600number滚动条隐藏前的持续时间(毫秒)。
orientationverticalvertical, horizontal滚动条的方向。
scrollAreagraystring滚动区域的颜色。
roundedfullstring滚动区域的圆角。

插槽 (Slots):

NameProps描述
default-ScrollArea 组件的默认插槽。

描述: 一个可组合、可主题化和可定制的侧边栏组件。

  • 结构:SidebarProviderSidebarSidebarHeaderSidebarFooterSidebarContentSidebarGroupSidebarTrigger 组成。 核心属性 (Props):
Prop默认值类型描述
sheetleftleft, right抽屉的一侧。
sidebarsidebarsidebar, floating, inset侧边栏的变体。
collapsibleoffcanvasoffcanvas, icon, none可折叠行为。
railtrueboolean是否显示用于调整大小的侧边栏轨道。

定制属性 (Customization Props):

NameTypeDescription
_sidebarContentNSidebarContentProps内容组件的属性。
_sidebarHeaderNSidebarHeaderProps页眉组件的属性。

插槽 (Slots):

NameProps描述
default-侧边栏的主要内容(包括页眉、内容和页脚)。
header-页眉内容。
content-侧边栏的主要内容。
footer-页脚内容。

可组合项 (Composables):

  • useSidebar(): 提供对侧边栏状态的响应式访问。

Stepper (步骤条)

描述: 一组用于指示多步骤流程进度的步骤。 核心属性 (Props):

Prop默认值类型描述
items[]T传递给步骤条的步骤数组。
modelValue-number要激活的步骤的受控值 (v-model 绑定)。
lineartrueboolean步骤是否必须按顺序完成。
orientationhorizontal`horizontal \vertical`
steppersolid-primary{variant}-{color}设置步骤条的变体和颜色。
sizemdstring调整组件的整体大小。

暴露的方法 (Exposed):

Name类型描述
goToStep(step: number) => void导航到指定索引的步骤。
nextStep() => void移动到下一个步骤。
hasPrev() => boolean检查是否有前一个步骤可用。

插槽 (Slots):

NameProps描述
defaultmodelValue, totalSteps, ...默认插槽,覆盖整个步骤条内容。
itemitem, step自定义每个单独的步骤。
contentitem动态渲染活动步骤的内容。
triggeritem覆盖每个步骤的可点击触发区域。

Table (表格/数据网格)

描述: 使用 Tanstack 构建的强大、响应式表格和数据网格。 核心属性 (Props):

Prop默认值类型描述
columns[]array表格列。
data[]array表格数据。
rowSelection-object选中行状态 (v-model 绑定)。
enableMultiRowSelectiontrueboolean启用多行选择。
empty-textNo results.string空文本。
loadingfalseboolean加载状态。
pagination{pageIndex: 0, pageSize: 10}object分页状态 (v-model 绑定)。
sorting-array排序状态 (v-model 绑定)。
globalFilter-string全局过滤状态 (v-model 绑定)。
columnPinning-{ left: array, right: array }列固定状态 (v-model 绑定)。

事件 (Events):

Event Name描述
@select选择行时触发。
@row点击行时触发。

插槽 (Slots):

NameProps描述
{column}-headercolumn列标题插槽。
{column}-cellcell列单元格插槽。
bodytable主体插槽。
expandedrow展开插槽。
empty-空状态插槽。

Tabs (选项卡)

描述: 一组分层的、一次只显示一个内容的区域(称为选项卡面板)。 核心属性 (Props):

Prop默认值类型描述
content-string设置选项卡内容。
disabled-boolean设置为禁用选项卡。
tabs-activesoft-blackstring通过设置变体和颜色来控制活动选项卡的外观。
sizesmstring设置选项卡大小。

插槽 (Slots):

NameProps描述
default-允许使用子组件进行高级自定义渲染,替换默认结构。
listitems选项卡触发器/按钮的容器。
triggervalue可点击的选项卡按钮。
contentvalue选项卡内容面板。

表单组 (Form Group, Deprecated)

Form Group (表单组 - 废弃)

描述: 各种表单组件(如 Input、Textarea、Select 等)的通用包装器。

  • 🚨 注意: 此组件已废弃,将在下一主要版本中移除。请使用 Form 组件代替。 核心属性 (Props):
Prop默认值类型描述
label-string添加标签。
requiredfalseboolean在标签上添加 *
description-string添加描述。
message-string设置消息。
status-info, success, warning, error, undefined设置状态。

插槽 (Slots):

NameProps描述
default-默认插槽。
label-标签插槽。
message-消息插槽。

Form (表单字段)

描述: 使用 VeeValidate 和 Zod 构建表单。 核心属性 (Props):

Prop默认值类型描述
label-string添加标签。
name-string添加名称。
description-string添加描述。
hint-string添加提示。
status-info, success, warning, error, undefined设置表单字段的状态。

插槽 (Slots):

NameProps描述
default-默认插槽。
label-标签插槽。
message-消息插槽。