Skip to content

Wbbb UI API 参考

此文件由组件 Props 与 SFC 契约自动生成。公开 API 变更后请执行 npm run docs:api

除非另有说明,所有组件都通过 WbbbCommonProps 支持 customClasscustomStyle

按钮 Button

主要操作、禁用与加载反馈

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/button

属性(Props)

属性说明类型必填默认值
block是否让按钮占满可用宽度。booleanfalse
disabled是否禁止用户与组件交互。booleanfalse
formType设置按钮触发的原生表单动作。'submit' | 'reset'undefined
icon设置图标名称或图标内容。string''
loading是否显示加载状态,并在适用时阻止重复交互。booleanfalse
loadingText设置加载过程显示的文案。string''
openType设置按钮使用的 uni-app 开放能力类型。string''
plain是否使用描边或低强调视觉样式。booleanfalse
round是否使用全圆角或胶囊形外观。booleanfalse
size设置组件尺寸。WbbbSize'medium'
type设置组件的语义类型或样式变体。WbbbType'default'

事件(Events)

  • click

插槽(Slots)

  • default

图标 Icon

受控图标与自定义资源

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/icon

属性(Props)

属性说明类型必填默认值
code直接渲染字体图标时提供字形码点。string''
color设置主要显示颜色。string''
fontFamily设置直接字体图标使用的字体族。string''
fontSet选择已注册的 Iconfont 图标集。string''
name提供项目名称或唯一标识。string''
size设置组件尺寸。WbbbNumeric32
src设置资源的 URL 或本地路径。string''

事件(Events)

插槽(Slots)

文本 Text

语义化文字与省略处理

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/text

属性(Props)

属性说明类型必填默认值
color设置主要显示颜色。string''
ellipsis文本溢出时是否以省略号截断。booleanfalse
size设置组件尺寸。WbbbNumeric''
type设置组件的语义类型或样式变体。'default' | 'secondary' | 'primary' | 'success' | 'warning' | 'danger''default'

事件(Events)

插槽(Slots)

  • default

图片 Image

图片加载与失败占位

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/image

属性(Props)

属性说明类型必填默认值
errorText设置加载失败时显示的默认提示文案。string'图片加载失败'
height设置组件高度。WbbbNumeric''
lazyLoad是否延迟加载图片资源。booleantrue
mode设置展示方式或图片适配模式。string'aspectFill'
radius设置组件的圆角半径。WbbbNumeric0
showError控制是否显示内置错误占位。booleantrue
showLoading控制是否显示内置加载占位。booleantrue
src设置资源的 URL 或本地路径。string''
loading是否显示加载状态,并在适用时阻止重复交互。booleanfalse
loadingText设置加载过程显示的文案。string'加载中'
width设置组件宽度。WbbbNumeric'100%'

事件(Events)

  • error
  • load

插槽(Slots)

  • error

徽标 Badge

数字角标与状态点

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/badge

属性(Props)

属性说明类型必填默认值
dot是否将徽标显示为小型状态点。booleanfalse
max设置允许的最大数值。number99
showZero徽标值为零时是否仍然显示。booleanfalse
type设置组件的语义类型或样式变体。WbbbType'danger'
value提供展示值或项目值。number | string''

事件(Events)

插槽(Slots)

  • default

标签 Tag

轻量状态标签

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/tag

属性(Props)

属性说明类型必填默认值
clickable是否作为可点击项处理并触发点击事件。booleanfalse
closable是否显示关闭控件并允许用户关闭。booleanfalse
plain是否使用描边或低强调视觉样式。booleanfalse
round是否使用全圆角或胶囊形外观。booleanfalse
size设置组件尺寸。WbbbSize'medium'
type设置组件的语义类型或样式变体。WbbbType'default'

事件(Events)

  • click
  • close

插槽(Slots)

  • default

头像 Avatar

头像与默认占位

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/avatar

属性(Props)

属性说明类型必填默认值
alt提供图片资源的替代文本。string''
round是否使用全圆角或胶囊形外观。booleantrue
size设置组件尺寸。WbbbNumeric80
src设置资源的 URL 或本地路径。string''

事件(Events)

  • error

插槽(Slots)

  • default

分割线 Divider

内容分隔与文字说明

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/divider

属性(Props)

属性说明类型必填默认值
dashed是否使用虚线分隔线而非实线。booleanfalse
direction设置布局或分隔线方向。WbbbDirection'horizontal'
textPosition设置文字相对分隔线的位置。'left' | 'center' | 'right''center'

事件(Events)

插槽(Slots)

  • default

加载 Loading

加载中的过程状态

  • 组件分类: 基础
  • 导入路径: wbbb-ui/components/loading

属性(Props)

属性说明类型必填默认值
color设置主要显示颜色。string''
size设置组件尺寸。WbbbNumeric32
text提供主要展示文案。string''
vertical是否使用纵向布局方向。booleanfalse

事件(Events)

插槽(Slots)

单元格 Cell

信息行与分组容器

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/cell

属性(Props)

属性说明类型必填默认值
border控制是否显示分隔线或边框。booleantrue
clickable是否作为可点击项处理并触发点击事件。booleanfalse
icon设置图标名称或图标内容。string''
label设置字段或项目的可见标签。string''
required是否将字段标记为必填以用于校验或展示。booleanfalse
title设置组件标题文字。string''
value提供展示值或项目值。string''

事件(Events)

  • click

插槽(Slots)

  • title
  • default

宫格 Grid

网格布局与子项

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/grid

属性(Props)

属性说明类型必填默认值
bordered控制容器是否渲染外边框。booleanfalse
columns设置网格的列数。number4
gap设置重复项目之间的间距。number16

事件(Events)

插槽(Slots)

  • default

列表 List

可选择的业务列表

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/list

属性(Props)

属性说明类型必填默认值
border控制是否显示分隔线或边框。booleantrue
items提供组件需要渲染的数据项目。WbbbListItem[]() => []

事件(Events)

  • select

插槽(Slots)

  • default

卡片 Card

内容卡片与层级容器

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/card

属性(Props)

属性说明类型必填默认值
bordered控制容器是否渲染外边框。booleantrue
extra提供组件头部的补充内容。string''
shadow是否为组件添加层级阴影。booleanfalse
title设置组件标题文字。string''

事件(Events)

插槽(Slots)

  • header
  • default
  • footer

吸顶 Sticky

吸顶内容区

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/sticky

属性(Props)

属性说明类型必填默认值
offsetTop设置触发吸顶前距顶部的偏移量。WbbbNumeric0
zIndex设置组件的层叠层级。number700

事件(Events)

插槽(Slots)

  • default

安全区 SafeArea

设备安全区适配

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/safe-area

属性(Props)

属性说明类型必填默认值
bottom是否启用底部安全区留白。booleantrue
top是否启用顶部安全区留白。booleanfalse

事件(Events)

插槽(Slots)

  • default

导航栏 Navbar

页面导航栏

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/navbar

属性(Props)

属性说明类型必填默认值
border控制是否显示分隔线或边框。booleantrue
fixed是否将组件固定在视口位置。booleanfalse
leftArrow是否在左侧显示返回箭头。booleanfalse
leftText设置左侧显示的文字。string''
placeholder设置尚未输入或选择时的占位文案。booleanfalse
rightText设置右侧显示的文字。string''
safeAreaTop是否为设备顶部安全区增加留白。booleantrue
title设置组件标题文字。string''

事件(Events)

  • clickLeft
  • clickRight

插槽(Slots)

  • left
  • title
  • right

底部导航栏 Tabbar

底部应用导航

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/tabbar

属性(Props)

属性说明类型必填默认值
activeColor设置激活状态使用的颜色。string'var(--wbbb-color-primary)'
fixed是否将组件固定在视口位置。booleantrue
inactiveColor设置未激活状态使用的颜色。string'var(--wbbb-color-text-secondary)'
items提供组件需要渲染的数据项目。WbbbTabbarItem[]() => []
modelValue提供 v-model 使用的当前值。string | number''
safeAreaInsetBottom是否为设备底部安全区增加留白。booleantrue
zIndex设置组件的层叠层级。number800

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

  • default

标签页 Tabs

内容标签切换

  • 组件分类: 布局
  • 导入路径: wbbb-ui/components/tabs

属性(Props)

属性说明类型必填默认值
activeColor设置激活状态使用的颜色。string''
items提供组件需要渲染的数据项目。WbbbTabItem[]() => []
modelValue提供 v-model 使用的当前值。string | number''
scrollable标签项超出宽度时是否允许横向滚动。booleanfalse

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

  • default

输入框 Input

单行文本输入

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/input

属性(Props)

属性说明类型必填默认值
clearable是否显示清空当前输入值的控件。booleanfalse
disabled是否禁止用户与组件交互。booleanfalse
error是否以错误视觉状态展示组件。booleanfalse
maxlength限制允许输入的最大字符数。number140
modelValue提供 v-model 使用的当前值。string | number''
placeholder设置尚未输入或选择时的占位文案。string''
readonly是否禁止编辑但保留内容可读。booleanfalse
type设置组件的语义类型或样式变体。'text' | 'number' | 'idcard' | 'digit' | 'safe-password' | 'nickname''text'

事件(Events)

  • update:modelValue
  • blur
  • change
  • clear
  • confirm
  • focus

插槽(Slots)

文本域 Textarea

多行文本与字数控制

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/textarea

属性(Props)

属性说明类型必填默认值
autoHeight是否让文本域随内容自动增高。booleanfalse
disabled是否禁止用户与组件交互。booleanfalse
error是否以错误视觉状态展示组件。booleanfalse
maxlength限制允许输入的最大字符数。number200
modelValue提供 v-model 使用的当前值。string''
placeholder设置尚未输入或选择时的占位文案。string''
readonly是否禁止编辑但保留内容可读。booleanfalse
showCount是否显示当前输入字数。booleanfalse

事件(Events)

  • update:modelValue
  • blur
  • change
  • focus

插槽(Slots)

复选框 Checkbox

多项复选

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/checkbox

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
modelValue提供 v-model 使用的当前值。Array<string | number>() => []
options提供可选择的选项数据。WbbbCheckboxOption[]() => []

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

单选框 Radio

单项选择

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/radio

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
modelValue提供 v-model 使用的当前值。string | number''
options提供可选择的选项数据。WbbbRadioOption[]() => []

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

开关 Switch

布尔开关

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/switch

属性(Props)

属性说明类型必填默认值
activeColor设置激活状态使用的颜色。string''
disabled是否禁止用户与组件交互。booleanfalse
modelValue提供 v-model 使用的当前值。booleanfalse

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

选择器 Picker

基础选项选择器

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/picker

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
modelValue提供 v-model 使用的当前值。string | number''
options提供可选择的选项数据。WbbbPickerOption[]() => []
placeholder设置尚未输入或选择时的占位文案。string由 locale 决定

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

日期选择器 DatePicker

日期值选择

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/date-picker

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
end设置可选或有效值的结束边界。string''
fields注册由组件管理的表单字段。'day' | 'month' | 'year''day'
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
modelValue提供 v-model 使用的当前值。string''
placeholder设置尚未输入或选择时的占位文案。string由 locale 决定
start设置可选或有效值的起始边界。string''

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

步进器 Stepper

精确数字步进

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/stepper

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
max设置允许的最大数值。numberNumber.MAX_SAFE_INTEGER
min设置允许的最小数值。number0
modelValue提供 v-model 使用的当前值。number0
step设置数值变化时使用的步长。number1

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

滑块 Slider

范围值选择

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/slider

属性(Props)

属性说明类型必填默认值
activeColor设置激活状态使用的颜色。string''
disabled是否禁止用户与组件交互。booleanfalse
max设置允许的最大数值。number100
min设置允许的最小数值。number0
modelValue提供 v-model 使用的当前值。number0
showValue控制是否显示当前数值。booleanfalse
step设置数值变化时使用的步长。number1

事件(Events)

  • update:modelValue
  • change
  • changing

插槽(Slots)

上传 Upload

本地选择、上传钩子和失败反馈

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/upload

属性(Props)

属性说明类型必填默认值
beforeRead文件读取前执行,可阻止文件被接收。(files: WbbbUploadFile[]) => boolean | Promise<boolean>
count设置渲染的占位行数或项目数。number9
disabled是否禁止用户与组件交互。booleanfalse
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
modelValue提供 v-model 使用的当前值。WbbbUploadFile[]() => []
text提供主要展示文案。string由 locale 决定
uploader提供由业务层注入的上传实现。(file: WbbbUploadFile, options?: { signal?: AbortSignal }) => WbbbUploadFile | Promise<WbbbUploadFile>

事件(Events)

  • update:modelValue
  • afterRead
  • change
  • error
  • remove

插槽(Slots)

表单 Form

表单规则与校验

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/form

属性(Props)

属性说明类型必填默认值
disabled是否禁止用户与组件交互。booleanfalse
labelWidth设置表单标签预留的宽度。WbbbNumeric160
model提供组件使用的数据模型。Record<string, unknown>() => ({})
rules提供表单或字段的校验规则。Record<string, WbbbFormRule | WbbbFormRule[]>() => ({})

事件(Events)

插槽(Slots)

  • default

表单项 Field

字段标签和错误提示

  • 组件分类: 表单
  • 导入路径: wbbb-ui/components/field

属性(Props)

属性说明类型必填默认值
label设置字段或项目的可见标签。string''
labelWidth设置表单标签预留的宽度。WbbbNumericundefined
prop将表单项关联到表单模型中的字段键。string''
required是否将字段标记为必填以用于校验或展示。booleanfalse
rules提供表单或字段的校验规则。WbbbFormRule | WbbbFormRule[]undefined
value提供展示值或项目值。unknownundefined

事件(Events)

插槽(Slots)

  • default

轻提示 Toast

轻量短消息

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/toast

属性(Props)

属性说明类型必填默认值
duration设置展示或动画时长,单位为毫秒。number1800
icon设置图标名称或图标内容。'success' | 'error' | 'loading' | 'none''none'
message提供通知或反馈消息内容。string''
modelValue提供 v-model 使用的当前值。booleanfalse
zIndex设置组件的层叠层级。number1100

事件(Events)

  • update:modelValue
  • close

插槽(Slots)

  • default

对话框 Dialog

确认和取消对话框

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/dialog

属性(Props)

属性说明类型必填默认值
cancelText覆盖取消操作的文案。string由 locale 决定
confirmText覆盖确认操作的文案。string由 locale 决定
content提供组件的主要文本内容。string''
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
modelValue提供 v-model 使用的当前值。booleanfalse
showCancel控制是否显示取消操作。booleantrue
title设置组件标题文字。string''

事件(Events)

  • update:modelValue
  • cancel
  • close
  • confirm

插槽(Slots)

  • default

弹出层 Popup

位置弹出层

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/popup

属性(Props)

属性说明类型必填默认值
closeOnClickOverlay点击遮罩层时是否关闭弹层。booleantrue
modelValue提供 v-model 使用的当前值。booleanfalse
placement设置弹层或浮层的展示位置。WbbbPlacement'center'
round是否使用全圆角或胶囊形外观。booleanfalse
zIndex设置组件的层叠层级。number900

事件(Events)

  • update:modelValue
  • close
  • open

插槽(Slots)

  • default

动作面板 ActionSheet

操作项面板

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/action-sheet

属性(Props)

属性说明类型必填默认值
actions定义可供选择的操作项。WbbbActionSheetAction[]() => []
cancelText覆盖取消操作的文案。string由 locale 决定
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
modelValue提供 v-model 使用的当前值。booleanfalse
title设置组件标题文字。string''

事件(Events)

  • update:modelValue
  • cancel
  • close
  • select

插槽(Slots)

消息通知 Notify

页面顶部通知

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/notify

属性(Props)

属性说明类型必填默认值
duration设置展示或动画时长,单位为毫秒。number2200
message提供通知或反馈消息内容。string''
modelValue提供 v-model 使用的当前值。booleanfalse
type设置组件的语义类型或样式变体。Exclude<WbbbType, 'default'>'info'
zIndex设置组件的层叠层级。number1000

事件(Events)

  • update:modelValue
  • close

插槽(Slots)

  • default

遮罩宿主 OverlayHost

服务弹层的统一宿主

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/overlay-host

属性(Props)

属性说明类型必填默认值

事件(Events)

插槽(Slots)

骨架屏 Skeleton

内容加载骨架

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/skeleton

属性(Props)

属性说明类型必填默认值
animated是否启用组件的过渡动画。booleantrue
avatar设置头像图片或头像内容来源。booleanfalse
loading是否显示加载状态,并在适用时阻止重复交互。booleantrue
rows设置可见的文本行数。number3
title设置组件标题文字。booleantrue

事件(Events)

插槽(Slots)

  • default

空状态 Empty

空内容状态

  • 组件分类: 反馈
  • 导入路径: wbbb-ui/components/empty

属性(Props)

属性说明类型必填默认值
description提供辅助说明文字。string由 locale 决定
image设置项目使用的图片资源。string''
imageSize设置图片的渲染尺寸。WbbbNumeric160
locale覆盖组件内置文案使用的语言。WbbbLocaleInput

事件(Events)

插槽(Slots)

  • default

通知栏 NoticeBar

重要通知横幅

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/notice-bar

属性(Props)

属性说明类型必填默认值
closeable是否允许用户关闭弹层或通知。booleanfalse
color设置主要显示颜色。string''
text提供主要展示文案。string''
type设置组件的语义类型或样式变体。WbbbStatus | 'primary''warning'

事件(Events)

  • close

插槽(Slots)

  • default

折叠面板 Collapse

可展开的信息块

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/collapse

属性(Props)

属性说明类型必填默认值
accordion是否限制同一时间只展开一个折叠项。booleanfalse
animated是否启用组件的过渡动画。booleantrue
items提供组件需要渲染的数据项目。WbbbCollapseItem[]() => []
modelValue提供 v-model 使用的当前值。Array<string | number> | string | number() => []

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

  • default

轮播 Swiper

轮播内容

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/swiper

属性(Props)

属性说明类型必填默认值
autoplay是否自动切换到下一张轮播项。booleanfalse
circular是否允许轮播从最后一项循环到第一项。booleantrue
indicatorDots是否显示轮播项目的分页指示点。booleantrue
interval设置轮播自动切换间隔,单位为毫秒。number3000
items提供组件需要渲染的数据项目。WbbbSwiperItem[]() => []

事件(Events)

  • change

插槽(Slots)

  • default

步骤条 Steps

步骤进度

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/steps

属性(Props)

属性说明类型必填默认值
active标识当前激活的项目或步骤。number
direction设置布局或分隔线方向。WbbbDirection
items提供组件需要渲染的数据项目。WbbbStepItem[]

事件(Events)

插槽(Slots)

时间线 Timeline

时间线事件

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/timeline

属性(Props)

属性说明类型必填默认值
items提供组件需要渲染的数据项目。WbbbTimelineItem[]() => []

事件(Events)

插槽(Slots)

倒计时 CountDown

倒计时状态

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/count-down

属性(Props)

属性说明类型必填默认值
autoStart是否在组件挂载后自动开始计时。booleantrue
format设置输出内容的展示格式。string'HH:mm:ss'
time设置剩余时间或目标时间值。number0

事件(Events)

  • change
  • finish

插槽(Slots)

评分 Rate

评分选择

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/rate

属性(Props)

属性说明类型必填默认值
color设置主要显示颜色。string''
count设置渲染的占位行数或项目数。number5
disabled是否禁止用户与组件交互。booleanfalse
modelValue提供 v-model 使用的当前值。number0

事件(Events)

  • update:modelValue
  • change

插槽(Slots)

日历 Calendar

月历日期选择

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/calendar

属性(Props)

属性说明类型必填默认值
disabledDates指定不可选择的日期列表。string[]() => []
firstDayOfWeek设置日历每周的起始星期。0 | 10
locale覆盖组件内置文案使用的语言。WbbbLocaleInput
maxDate设置可选择的最晚日期。string''
minDate设置可选择的最早日期。string''
modelValue提供 v-model 使用的当前值。string''
month设置日历当前显示的月份。string''

事件(Events)

  • update:modelValue
  • change
  • monthChange

插槽(Slots)

进度条 Progress

进度反馈

  • 组件分类: 展示
  • 导入路径: wbbb-ui/components/progress

属性(Props)

属性说明类型必填默认值
color设置主要显示颜色。string''
percentage设置需要展示的进度百分比。number0
showText控制是否显示辅助文字。booleantrue
status设置展示使用的语义状态。WbbbStatus'default'
strokeWidth设置进度条描边的粗细。number12

事件(Events)

插槽(Slots)

Wbbb UI · 为 uni-app 产品体验而生