Skip to content

组件类型 ​

SinleUI 组件专属类型的统一参考。全部类型(含扩展组件类型)均统一从 @/uni_modules/sinle-ui 导出,使用时从插件入口导入即可:

typescript
import { SnDataItem, SnCalendarValue, SnTreeData } from '@/uni_modules/sinle-ui'

提示

标记「内部使用」的类型由框架组件内部写入或回传,业务侧只读、无需自行构造:既包括仅在组件之间传递的类型,也包括组件事件 / 回调返回的详情类型(如各 *-change、select 事件的 detail)。业务需要主动显式传入数据的类型(组件 data / v-model / 配置类 props,以及 load-data、format 等回调函数的入参类型)均不加此标记。组件与 API 公用或仅 API 使用的类型(颜色集、风格、手势事件、全局弹窗配置、权限等)见 API 类型。

本页与 API 类型 覆盖框架内全部类型定义——公开类型与框架内部自用类型(分组组件 group config、子组件间注入 / 回传的类型等)均完整收录并列出字段,不做省略。内部类型仅供理解组件行为与排查问题,业务侧不应依赖,其字段可能随版本调整。本页类型按字母顺序排列。


AgreementLinkDetail 内部使用 ​

sn-agreement 的 open-link 事件返回的链接详情。

名称类型必填描述
textString是链接文本
indexNumber是链接在协议中的序号(从 0 开始)

CheckboxGroupConfig 内部使用 ​

sn-checkbox-group 向其子组件(sn-checkbox、sn-checkbox-tag)注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-checkbox-group 的属性控制。

名称类型必填描述
boxSizeString | Number是勾选框尺寸
boxBorderRadiusString | Number是勾选框圆角
boxBorderWidthString | Number是勾选框边框宽度
boxTextSizeString | Number是勾选框文字字号
boxTextColorString是勾选框文字颜色
disabledBoxTextColorString是禁用态勾选框文字颜色
boxIconString是勾选框选中图标名
boxIconSizeString | Number是勾选框图标字号
boxIconColorString是勾选框图标颜色
disabledBoxIconColorString是禁用态勾选框图标颜色
boxBorderColorString是勾选框边框颜色
disabledBoxBorderColorString是禁用态勾选框边框颜色
boxActiveBorderColorString是选中态勾选框边框颜色
disabledBoxActiveBorderColorString是禁用态选中态勾选框边框颜色
boxBgColorString是勾选框背景颜色
disabledBoxBgColorString是禁用态勾选框背景颜色
boxActiveBgColorString是选中态勾选框背景颜色
disabledBoxActiveBgColorString是禁用态选中态勾选框背景颜色
tagTypeString是标签模式功能色(primary | info | success | error | warning)
tagLevelString是标签模式表现程度等级(first | second | third | least)
tagBorderRadiusString | Number是标签圆角
tagPaddingString是标签内边距
tagTextSizeString | Number是标签文字字号
tagBgColorString是标签背景颜色
disabledTagBgColorString是禁用态标签背景颜色
tagActiveBgColorString是选中态标签背景颜色
disabledTagActiveBgColorString是禁用态选中态标签背景颜色
tagTextColorString是标签文字颜色
disabledTagTextColorString是禁用态标签文字颜色
tagActiveTextColorString是选中态标签文字颜色
disabledTagActiveTextColorString是禁用态选中态标签文字颜色
boxContainStyleUTSJSONObject | String是勾选框容器自定义样式
boxStyleUTSJSONObject | String是勾选框自定义样式
boxIconStyleUTSJSONObject | String是勾选框图标自定义样式
tagStyleUTSJSONObject | String是标签自定义样式
textStyleUTSJSONObject | String是文字自定义样式
boxContainClassString是勾选框容器外部样式类
boxClassString是勾选框外部样式类
boxIconClassString是勾选框图标外部样式类
tagClassString是标签外部样式类
textClassString是文字外部样式类

ChooseMediaWebOptions 内部使用 ​

Web 平台下 sn-upload-media / sn-upload-media-unicloud 的内置文件选择器入参,仅 Web 端编译,业务侧不应直接引用。

名称类型必填描述
typeString是媒体类型,可选值 image | video | all
multipleBoolean | null否是否允许多选
maxCountNumber | null否最大选择数量
success(files: SnFile[]) => void | null否选择成功回调
fail(err: UniError) => void | null否选择失败回调

CollapseConfig 内部使用 ​

sn-collapse 向其子组件注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-collapse 的属性控制。

名称类型必填描述
accordionBoolean是是否手风琴模式(同时只展开一项)
showBorderBoolean是是否显示边框
aniTimeString是展开 / 收起动画时长
bgColorString是背景颜色
titleSizeString是标题字号
titleColorString是标题颜色
noteSizeString是备注字号
noteColorString是备注颜色
activeTitleColorString是展开态标题颜色
borderRadiusString是圆角
titleStyleUTSJSONObject是标题自定义样式
holderStyleUTSJSONObject是内容容器自定义样式
noteStyleUTSJSONObject是备注自定义样式
titleClassString是标题外部样式类
noteClassString是备注外部样式类
holderClassString是内容容器外部样式类

FingerOut 内部使用 ​

sn-gesture 内部手势识别器每帧回传的手指状态对象,含位移、缩放、旋转与速度等信息。

名称类型必填描述
typeString是手势类型
xNumber是当前触点横坐标
yNumber是当前触点纵坐标
startXNumber是起始横坐标
startYNumber是起始纵坐标
endXNumber是结束横坐标
endYNumber是结束纵坐标
zoomNumber是相对起始的缩放倍数
rotateNumber是相对起始的旋转角度(deg)
directionString是移动方向
deltaXNumber是本帧横向位移增量
deltaYNumber是本帧纵向位移增量
vXNumber是横向速度
vYNumber是纵向速度
evtUniTouchEvent | null否原始触摸事件

LoadingPageBridge 内部使用 ​

全局加载(snu.showLoading)与承载它的页面(pages/popups/showLoading)之间的通信桥接对象。

名称类型必填描述
pageany是加载页实例引用
hide() => void是关闭加载页的方法

QrCellPoint 内部使用 ​

二维码绘制点,QrCodeData 的 points 列表项。

名称类型必填描述
xNumber是横向坐标
yNumber是纵向坐标
typeNumber是模块类型(QrPointType 枚举值)

QrCodeData 内部使用 ​

二维码绘制数据,由组件内部编码生成。

名称类型必填描述
sizeNumber是含留白的最终矩阵尺寸
moduleCountNumber是不含留白的原始模块数
versionNumber是实际使用的二维码版本
matrixBoolean[][]是模块矩阵
typeTableNumber[][]是各模块类型表(对应 QrPointType 枚举)
pointsQrCellPoint[]是有效模块点列表(含坐标与类型)

QrEcLevel ​

二维码纠错等级。

可选值备注
low低(约 7% 纠错)
medium中(约 15% 纠错)
quartile四分位(约 25% 纠错)
high高(约 30% 纠错)

QrEncodeOptions 内部使用 ​

二维码编码配置,由组件内部按属性组装后传入编码器。

名称类型必填描述
eccQrEcLevel是纠错等级,默认 medium
versionNumber是二维码版本,0 表示自动
maskNumber是掩码图样,-1 表示自动
borderNumber是留白边距(模块数),默认 2

QrModuleShape ​

二维码模块形状。

可选值备注
square方形
rounded圆角方形
circle圆形
diamond菱形

QrPointType 内部使用 ​

二维码模块的功能类型枚举,用于绘制时区分数据区与定位 / 校正 / 时序等特殊区域。

可选值备注
DATA数据模块
POS_CENTER定位图案中心
POS_OTHER定位图案其他
ALIGN_CENTER校正图案中心
ALIGN_OTHER校正图案其他
TIMING时序图案
FORMAT格式信息
VERSION版本信息

SnAvatarConfig ​

内置 sn-avatar 的组件(如列表项、发布卡)可通过 avatarConfig 属性统一配置头像参数。

名称类型必填描述
modeSnAvatarMode否显示模式,默认 image
srcString否图片路径(mode 为 image 时生效)
textString否文本内容(mode 为 text 时生效)
iconString否图标名(mode 为 icon 时生效)
sizeString | Number否尺寸大小
shapeSnAvatarShape否形状
bgColorString否背景颜色
textColorString否文本颜色
iconColorString否图标颜色
borderRadiusString | Number否圆角大小
enablePreviewBoolean否是否启用图片预览(mode 为 image 时生效)

SnAvatarGroupItem ​

sn-avatar-group 的 data 属性需要传入一个 SnAvatarGroupItem[] 类型的数组。此对象只能传入数据,样式请通过 sn-avatar-group 的属性统一设置。

名称类型必填描述
srcString否图片路径
textString否文本内容
iconString否图标名称
bgColorString否背景颜色
textColorString否文本颜色
iconColorString否图标颜色

SnAvatarMode ​

头像显示模式。

可选值备注
image图片
text文本
icon图标

SnAvatarShape ​

头像形状。

可选值备注
square方形
circle圆形

SnBadgeParams ​

内置 sn-badge 的组件可通过 badgeConfig 属性配置徽标参数。

名称类型必填描述
valueNumber否显示的值(仅 number 模式)
maxNumber否最大值,超过显示 max+
sizeString否大小
offsetString否偏移量(transform)
modeString否可选值 number | text | dot
textString否文本内容(仅 text 模式)
showZeroBoolean否是否显示 0
textColorString否文字颜色
bgColorString否背景颜色

SnBarcodeBarElement 内部使用 ​

条码单元。

名称类型必填描述
widthNumber是模块宽度
barBoolean是是否为条纹(false 为间隙)

SnBarcodeData 内部使用 ​

条码绘制数据,由组件内部编码生成。

名称类型必填描述
elementsSnBarcodeBarElement[]是条纹元素序列
totalModulesNumber是总模块数
valueString是实际编码的文本(可能被截断)

SnBarcodeFormat ​

条码格式。

可选值备注
code128Code 128
code39Code 39
code93Code 93
codabarCodabar
ean8EAN-8
ean13EAN-13
upcaUPC-A
upceUPC-E
itfITF(交错 2/5)

SnCalendarBoundaries 内部使用 ​

日历可选日期范围边界,由组件内部经 min-date / max-date 属性归一化后传递。

名称类型必填描述
minDateNumber是可选最小日期时间戳(当日 0 点)
maxDateNumber是可选最大日期时间戳(当日 0 点)

SnCalendarSelectionResult 内部使用 ​

日历选中计算的结果,由 sn-calendar-view 内部根据当前值与点击日期推导。

名称类型必填描述
valueSnCalendarValue是计算后的新选中值
changedBoolean是选中值是否发生变化
overRangeBoolean是是否超出允许的选择范围

SnCalendarDay 内部使用 ​

formatter 回调入参,单个日期格的完整信息。

名称类型必填描述
timestampNumber是当日 0 点时间戳
yearNumber是年
monthNumber是月
dateNumber是日
weekdayNumber是星期(0-6)
textString是日期文本
prefixString是前缀文字(默认空)
suffixString是后缀文字(默认空)
todayBoolean是是否今天
disabledBoolean是是否禁用
currentMonthBoolean是是否当前显示月份
stateSnCalendarDayState是选中状态
paintSnCalendarDayPaint | null否绘制配置

SnCalendarDayContent 内部使用 ​

日期格内容(formatter 返回值)。

名称类型必填描述
prefixString否前缀文字(如「休」)
textString否日期文本(默认为日号)
suffixString否后缀文字(如「今天」)
paintSnCalendarDayPaint | null否绘制配置

SnCalendarDayContentInput ​

createCalendarDayContent(input) 的入参类型,在内容字段之外可快捷设置圆点相关字段。

名称类型必填描述
prefixString否前缀文字
textString否日期文本
suffixString否后缀文字
showDotBoolean否是否显示圆点
dotColorString否圆点颜色
dotPositionSnCalendarDayDotPosition否圆点位置
paintSnCalendarDayPaintInput否绘制配置

SnCalendarDayDotPosition 内部使用 ​

日历圆点标记位置。

可选值备注
left左侧
right右侧
top顶部
bottom底部

SnCalendarDayFormatter ​

日期格格式化器:返回 null 表示使用默认内容。

参数类型说明
daySnCalendarDay日期格信息
返回值SnCalendarDayContent | null格式化后的内容,null 表示使用默认内容

SnCalendarDayPaint 内部使用 ​

日期格绘制配置(由 SnCalendarDayContent.paint 携带,经 formatter 或 createCalendarDayPaint 构造)。

名称类型必填描述
backgroundColorString否背景颜色
borderColorString否边框颜色
borderWidthNumber否边框宽度
fontSizeString | Number否日期字号
prefixColorString否前缀文字颜色
textColorString否日期文字颜色
suffixColorString否后缀文字颜色
prefixFontSizeNumber否前缀字号
suffixFontSizeNumber否后缀字号
fontWeightString否字重
showDotBoolean否是否显示圆点
dotColorString否圆点颜色
dotPositionSnCalendarDayDotPosition否圆点位置

SnCalendarDayPaintInput ​

createCalendarDayPaint(input) 的入参类型,字段与 SnCalendarDayPaint 一致。


SnCalendarDayState 内部使用 ​

日历日期格状态。

可选值备注
normal普通
selected选中
range-start范围起点
range-middle范围中间
range-end范围终点
range-start-end起终点同日

SnCalendarLocaleText ​

日历文案配置。

名称类型必填描述
titleString是弹层标题
confirmTextString是确认按钮文案
confirmDisabledTextString是确认按钮禁用态文案
rangePromptString是范围选择提示文案
weekdaysString[]是星期标题数组
yearMonthFormatString是年月格式

SnCalendarPanelChangeDetail 内部使用 ​

日历 panel-change 事件返回的面板切换详情。

名称类型必填描述
timestampNumber是面板首日时间戳
yearNumber是年
monthNumber是月

SnCalendarPunchDay 内部使用 ​

打卡日历(sn-calendar-punch)select 事件返回的单日信息。

名称类型必填描述
timestampNumber是当日 0 点时间戳
yearNumber是年
monthNumber是月
dateNumber是日
fullDateString是YYYY-MM-DD 格式日期字符串
signedBoolean是当日是否已打卡
supplementableBoolean是当日是否可补签
todayBoolean是是否今天

SnCalendarSwitchMode ​

日历面板切换粒度。

可选值备注
month按月切换
year-month按年-月切换

SnCalendarType ​

日历选择模式。

可选值备注
single单选
multiple多选
range范围选择

SnCalendarValue ​

日历选中值(v-model),随 type 变化:single 为时间戳 number \| null;range 为 [] 或 [start, end](单点范围写成 [same, same]);multiple 为时间戳数组 number[]。

类型说明
number | nullsingle 模式:时间戳或空
number[]multiple 模式:时间戳数组
[] | [start, end]range 模式:空或起止时间戳(单点范围写成 [same, same])

SnCalendarWeekChangeDetail 内部使用 ​

周日历(sn-calendar-week)week-change 事件返回详情。

名称类型必填描述
timestampNumber是当前周首日时间戳
yearNumber是年
monthNumber是月

SnCalendarWeekDay 内部使用 ​

周日历(sn-calendar-week)单日信息,由组件内部构建。

名称类型必填描述
timestampNumber是当日 0 点时间戳
textString是日号文本
weekTitleString是所属周标题
todayBoolean是是否今天
disabledBoolean是是否禁用
showDotBoolean是是否显示圆点
dotColorString是圆点颜色

SnCalendarWeekStartDay ​

日历周起始日。

可选值备注
sunday星期日
monday星期一
tuesday星期二
wednesday星期三
thursday星期四
friday星期五
saturday星期六

SnCascaderDetail 内部使用 ​

sn-cascader 的 change 事件返回的详情。

名称类型必填描述
valuesString[]是各级选中值
labelsString[]是各级选中文本
optionsSnCascaderOption[]是各级选中的选项对象

SnCascaderLoadData ​

sn-cascader 的 load-data 属性接收 SnCascaderLoadData 函数:parent 为 null 表示加载第一级,level 为当前层级;成功经 resolve(options) 返回选项列表,失败调用 reject()。

类型签名
SnCascaderResolve(options: SnCascaderOption[]) => void
SnCascaderReject() => void
SnCascaderLoadData(parent: SnCascaderOption | null, level: number, resolve: SnCascaderResolve, reject: SnCascaderReject) => void

SnCascaderOption ​

级联选项。

名称类型必填描述
valueString是选项值
labelString是选项显示文本
disabledBoolean否是否禁用
leafBoolean否是否叶子节点(懒加载模式下标记不再展开)
childrenSnCascaderOption[]否子级选项列表

SnCascaderReject ​

sn-cascader 的 load-data 回调参数之一:懒加载失败时调用,通知组件结束加载态(由 SnCascaderLoadData 的 reject 参数使用)。

类型签名
Function() => void

SnCascaderResolve ​

sn-cascader 的 load-data 回调参数之一:懒加载成功时调用,传入该层级的选项列表(由 SnCascaderLoadData 的 resolve 参数使用)。

类型签名
Function(options: SnCascaderOption[]) => void

SnCascaderValue ​

级联选中值:各级选项 value 组成的数组(v-model)。

类型说明
string[]各级选中值数组

SnDataItem ​

通用数据项类型,sn-picker-view、sn-select、sn-topbar 等数据组件的 data 属性需要传入一个 SnDataItem[],全局操作菜单(snu.showActionsheet)的 actions 同样使用它。

名称类型必填描述
idString否数据的唯一标识
textString否数据显示文本
iconString否数据显示图标
valueString否关联值
colorString否文本颜色
disabledBoolean否是否禁用子项

SnDatetimePickerTimeModeValue ​

日期时间选择器时间选择粒度模式。

可选值备注
year年
month月
date日
hour时
minute分
second秒

SnDatetimePickerValue ​

日期时间选择器选中值(v-model):时间戳数字或时间格式字符串。

类型说明
string | number时间格式字符串或时间戳数字

SnEmptyColorConfig 内部使用 ​

sn-empty 内部传递插画配色参数。

名称类型必填描述
themeColorString是主题颜色
hairColorString是头发颜色
clothesColorString是衣服颜色
trousersColorString是裤子颜色
shoesColorString是鞋子颜色
itemColorString是项目颜色
skinColorString是皮肤颜色
elementColorString是元素颜色

SnFile 内部使用 ​

上传媒体文件信息,由 sn-upload-media 的 file-chose 事件与内部选择逻辑返回。

名称类型必填描述
filenameString是文件名
pathString是文件路径
sizeNumber否文件大小
extString是扩展名

SnFooterLink ​

sn-footer 链接项。

名称类型必填描述
nameString否链接名称
urlString否跳转地址
openTypeString否打开方式

SnFooterLogo ​

sn-footer Logo 配置。

名称类型必填描述
iconString否图标名
titleString否标题文本
urlString否跳转地址
openTypeString否打开方式

SnFormItemData 内部使用 ​

sn-form-item 内部注册组件数据类型。

名称类型必填描述
fieldString是子项名称
instanceComponentPublicInstance是子项实例

SnFormItemRule ​

sn-form-item 的 rule 属性校验规则。

名称类型必填描述
typeString否字段类型(如 string / number / array / url / email / phone 等)
requiredBoolean否是否必填
messageString否校验失败提示信息
patternRegExp否正则校验规则
minNumber否最小长度
maxNumber否最大长度
lenNumber否固定长度
enumany[]否枚举校验,值须在列表内
transform(value: any) => any否校验前对值进行转换
valid(value: any) => string否自定义校验函数,返回非空字符串表示失败信息

SnFormItemVerifyResult 内部使用 ​

单项校验结果,经 sn-form 的 fail 事件与 valid.fail 回调返回,业务侧只读。

名称类型必填描述
validBoolean是是否通过校验
messageString否失败信息
fieldString是子项名称

SnFormValidResult ​

sn-form 的 valid 属性回调配置。

名称类型必填描述
success() => void否全部通过回调
fail(failResults: SnFormItemVerifyResult[]) => void否失败回调,入参为失败结果数组

SnLocaleInfo ​

语言条目,SUPPORTED_LOCALES 数组的元素类型,可直接渲染为语言选择器。

名称类型必填描述
codeString是语言代码(如 zh-Hans、en)
nameString是该语言的本地化名称(如 简体中文、English)

SnLoadmoreParams ​

sn-loadmore / 列表加载更多的文案与样式配置。

名称类型必填描述
loadmoreTextString否加载前文案
nomoreTextString否没有更多文案
loadingTextString否加载中文案
textSizeString否文本字号
textColorString否文本颜色
iconSizeString否图标字号
iconColorString否图标颜色
lineColorString否线条颜色
lineHeightString否线条高度
dashedBoolean否线条是否虚线
disabledBoolean否是否禁用

SnMedia 内部使用 ​

上传媒体条目。

名称类型必填描述
fileany否文件对象
srcString否预览路径
thumbString否缩略图路径
nameString是文件名
statusString是上传状态,可选值 uploaded | uploading | unuploaded | error
typeString是媒体类型,可选值 image | video
extString否扩展名

SnMessageLevel ​

消息条表现程度等级。

可选值备注
first一级(表现最重)
second二级
third三级(表现最轻)

SnMessageParams ​

sn-message 组件 add 方法入参。

名称类型必填描述
textString否消息内容
typeSnMessageType否消息类型
levelSnMessageLevel否消息等级
positionSnMessagePosition否队列位置
durationNumber否显示时长(ms)
showIconBoolean否是否显示图标
iconString否图标名
closableBoolean否是否显示关闭按钮
groupingBoolean否相同内容是否归并计数
bgColorString否背景颜色
textColorString否文字颜色
iconColorString否图标颜色
textSizeString否文字字号
borderRadiusString否圆角
customStyleUTSJSONObject否自定义样式

SnMessagePosition ​

消息条队列位置。

可选值备注
top-left左上
top顶部
top-right右上
bottom-left左下
bottom底部
bottom-right右下

SnMessageType ​

消息条类型。

可选值备注
primary主色
success成功
error错误
info信息
warning警告

SnNotificationLevel ​

通知表现程度等级。

可选值备注
first一级(表现最重)
second二级
third三级(表现最轻)

SnNotificationParams ​

sn-notification 组件 add 方法入参。

名称类型必填描述
titleString否通知标题
contentString否通知内容
typeSnNotificationType否通知类型
levelSnNotificationLevel否通知等级
positionSnNotificationPosition否队列位置,可选值 top | bottom
durationNumber否显示时长(ms)
showProgressBoolean否是否显示进度条
showIconBoolean否是否显示图标
iconString否图标名
closableBoolean否是否显示关闭按钮
showActionBoolean否是否显示右侧操作插槽(slot="action",需组件标签内定义插槽内容)
groupingBoolean否相同内容是否归并计数
bgColorString否背景颜色
titleColorString否标题颜色
contentColorString否内容颜色
iconColorString否图标颜色
borderRadiusString否圆角
draggableBoolean否是否可拖拽
dragThresholdString | Number否拖拽关闭位移阈值
customStyleUTSJSONObject否自定义样式

SnNotificationPosition ​

通知队列位置。

可选值备注
top顶部
bottom底部

SnNotificationType ​

通知类型。

可选值备注
primary主色
success成功
error错误
info信息
warning警告

SnPostCardAction ​

动态卡片(sn-post-card)操作栏按钮配置。

名称类型必填描述
idString否按钮 id
iconString否图标名
textString否按钮文字(一般为数量)
disabledBoolean否是否禁用
isActiveBoolean否是否处于激活态(如已点赞)
iconColorString否图标颜色
textColorString否文字颜色
activeIconColorString否激活态图标颜色
activeTextColorString否激活态文字颜色

SnPostCardComment ​

动态卡片评论区条目。

名称类型必填描述
idString否评论 id
userString否评论用户
contentString否评论内容
replyToString否回复的用户名(为空表示直接评论)

RadioGroupConfig 内部使用 ​

sn-radio-group 向其子组件(sn-radio、sn-radio-tag)注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-radio-group 的属性控制。

名称类型必填描述
radioSizeString | Number是单选按钮尺寸
radioBorderWidthString | Number是单选按钮边框宽度
radioTextSizeString | Number是单选按钮文字字号
radioBgColorString是单选按钮背景颜色
disabledRadioBgColorString是禁用态单选按钮背景颜色
radioActiveBgColorString是选中态单选按钮背景颜色
disabledRadioActiveBgColorString是禁用态选中态单选按钮背景颜色
radioTextColorString是单选按钮文字颜色
disabledRadioTextColorString是禁用态单选按钮文字颜色
radioBorderColorString是单选按钮边框颜色
disabledRadioBorderColorString是禁用态单选按钮边框颜色
radioActiveBorderColorString是选中态单选按钮边框颜色
disabledRadioActiveBorderColorString是禁用态选中态单选按钮边框颜色
tagTypeString是标签模式功能色(primary | info | success | error | warning)
tagLevelString是标签模式表现程度等级(first | second | third | least)
tagBorderRadiusString | Number是标签圆角
tagPaddingString是标签内边距
tagTextSizeString | Number是标签文字字号
tagBgColorString是标签背景颜色
disabledTagBgColorString是禁用态标签背景颜色
tagActiveBgColorString是选中态标签背景颜色
disabledTagActiveBgColorString是禁用态选中态标签背景颜色
tagTextColorString是标签文字颜色
disabledTagTextColorString是禁用态标签文字颜色
tagActiveTextColorString是选中态标签文字颜色
disabledTagActiveTextColorString是禁用态选中态标签文字颜色
radioContainStyleUTSJSONObject | String是单选按钮容器自定义样式
radioStyleUTSJSONObject | String是单选按钮自定义样式
tagStyleUTSJSONObject | String是标签自定义样式
textStyleUTSJSONObject | String是文字自定义样式
radioContainClassString是单选按钮容器外部样式类
radioClassString是单选按钮外部样式类
tagClassString是标签外部样式类
textClassString是文字外部样式类

SnRefresherParams ​

下拉刷新区域文案与样式配置。

名称类型必填描述
refreshTextString否下拉中文案
refreshingTextString否刷新中文案
textSizeString否文本字号
textColorString否文本颜色
iconString否图标名
iconSizeString否图标字号
iconColorString否图标颜色

SnRegionDetail 内部使用 ​

sn-region-picker 的 change 事件返回详情。

名称类型必填描述
codesString[]是各级区划代码数组
namesString[]是各级名称数组

SnRegionLevel ​

行政区划层级。

可选值备注
province省
city市
county区县

SnRegionNode ​

行政区划节点。

名称类型必填描述
codeString是区划代码
nameString是名称
childrenSnRegionNode[]否子级节点

SnRegionValue ​

sn-region-picker 选中值(v-model):各级区划代码数组。

类型说明
string[]各级区划代码数组

SnScanParams ​

sn-scan 经 uni.navigateTo 打开扫码页时通过 SnScanParams 传参(snu.openScanPage 等封装亦使用)。

名称类型必填描述
scanTypeString否扫码类型,可选值 barcode | qrcode | all,默认 all
continuousBoolean否是否连续扫码
scanOnlyOnceBoolean否是否识别一次后自动返回
continuousSleepNumber否连续扫码间隔(ms)
enableDingBoolean否识别成功提示音
dingFileSrcString否自定义提示音文件路径
showTorchBoolean否是否显示手电筒按钮
showAlbumBoolean否是否显示相册选择按钮
showBackButtonBoolean否是否显示返回按钮
showAniBoolean否是否显示扫码动画
enableZoomBoolean否是否启用手势缩放
initZoomScaleNumber否初始缩放倍数
titleString否页面标题
titleSizeString | Number否标题字号
titleColorString否标题颜色
tipString否提示文本
tipSizeString | Number否提示字号
tipColorString否提示颜色
customTitleStyleUTSJSONObject | String否标题自定义样式
customTipStyleUTSJSONObject | String否提示自定义样式

SnSignatureBrush ​

签名笔触类型。

可选值备注
default默认
pen钢笔
gel中性笔
pencil铅笔
marker马克笔
brush毛笔
crayon蜡笔
fur毛皮
ink墨水
longfur长绒毛
ribbon丝带
shaded阴影
sketchy速写
spray喷漆
squares方格
circle圆泡
web蛛网

SnStepStatus ​

步骤条步骤状态。

可选值备注
wait等待
finish已完成
process进行中
error错误

SnTableConfig 内部使用 ​

sn-table 向其子组件(sn-tr、sn-td、sn-th)注入的表格样式配置。业务侧只读,请通过 sn-table 的属性控制。

名称类型必填描述
borderedBoolean是是否显示单元格边框
underlineBoolean是是否显示单元格下划线
borderColorString是边框与下划线颜色
scrollableBoolean是是否允许横向滚动

SnTableCellReport 内部使用 ​

表格单元格向行组件回传的尺寸上报信息,用于计算固定列的偏移量。

名称类型必填描述
kindString是固定类型,可选值 left | right | all
widthNumber是单元格实测宽度(px)

SnTabbarItem ​

sn-tabbar 标签栏项数据。

名称类型必填描述
textString否文本
iconString否图标名
imageString否图片路径(优先于 icon)
activeIconString否选中态图标名
activeTextString否选中态文本
activeImageString否选中态图片路径
interceptor() => boolean否切换拦截器,返回 false 阻止切换
badgeSnBadgeParams | null否徽标配置

SnTabParams ​

sn-tabs 标签项数据。

名称类型必填描述
textString是标签文本
iconString否图标名
idString是标签唯一 id
disabledBoolean否是否禁用
checkedBoolean否是否选中
showBadgeBoolean否是否显示徽标
badgeConfigSnBadgeParams | null否徽标配置

SnTime 内部使用 ​

sn-timer、sn-countdown 等组件的 change 事件返回的时间结构。

名称类型必填描述
dNumber是天
hNumber是时
mNumber是分
sNumber是秒
msNumber是毫秒

SnToastParams ​

sn-toast 组件 show 方法入参,字段与 SnShowToastConfig 基本一致(无回调字段),另含 overlay(是否显示遮罩)。


SnTreeData ​

树形数据集合,即 sn-tree 的 data 属性类型。

类型说明
SnTreeItem[]树节点列表

SnTreeItem ​

树节点数据。

名称类型必填描述
idString是节点唯一 id
textString是节点显示文本
iconString否节点图标名
activeIconString否选中态图标名
rotateNumber否图标展开旋转角度(deg)
disabledBoolean否是否禁用节点
lazyBoolean否是否懒加载子节点(配合 load-data)
childrenSnTreeItem[]否子节点列表

SnTreeLoadData ​

sn-tree 的 load-data 属性接收 SnTreeLoadData 函数:懒加载节点展开时调用,加载成功经 resolve(children) 返回子节点,失败调用 reject()。

类型签名
SnTreeLoadResolve(children: SnTreeData) => void
SnTreeLoadReject() => void
SnTreeLoadData(item: SnTreeItem, resolve: SnTreeLoadResolve, reject: SnTreeLoadReject) => void

SnTreeLoadReject ​

sn-tree 的 load-data 回调参数之一:懒加载失败时调用,通知组件结束加载态(由 SnTreeLoadData 的 reject 参数使用)。

类型签名
Function() => void

SnTreeLoadResolve ​

sn-tree 的 load-data 回调参数之一:懒加载成功时调用,传入子节点数据(由 SnTreeLoadData 的 resolve 参数使用)。

类型签名
Function(children: SnTreeData) => void

SnTypeGroup 内部使用 ​

sn-list-view / sn-waterflow 内部按 type 对列表项分组后的结果,用于在同一列表中以不同布局渲染不同 type 的条目。

名称类型必填描述
typeNumber是分组类型值(取自列表项的 type 字段,缺省为 0)
entriesSnTypeGroupEntry[]是该分组下的条目列表

SnTypeGroupEntry 内部使用 ​

sn-list-view / sn-waterflow 内部打平后的列表条目,承载原始数据及其索引与分组类型。

名称类型必填描述
itemany是原始列表项数据
indexNumber是该条目在原始 list 中的下标
typeNumber是该条目的分组类型值

StepsConfig 内部使用 ​

sn-steps 向其子组件(sn-step)注入的配置对象,用于统一各步骤的外观与样式。业务侧只读,请通过 sn-steps 的属性控制。

名称类型必填描述
verticalBoolean是是否纵向排列
typeString是步骤条类型
selectableBoolean是步骤是否可点击切换
activeColorString是激活态颜色
circleSizeString | Number是步骤圆圈尺寸
textSizeString | Number是标题文字字号
contentSizeString | Number是内容文字字号
stepStyleUTSJSONObject | String是步骤项自定义样式
stepClassString是步骤项外部样式类
titleStyleUTSJSONObject | String是标题自定义样式
titleClassString是标题外部样式类
contentStyleUTSJSONObject | String是内容自定义样式
contentClassString是内容外部样式类
lineStyleUTSJSONObject | String是连接线自定义样式
lineClassString是连接线外部样式类

其他说明 ​

  • 日期时间库类型(DayutsConfig、DayutsUnit、DayutsFormats、DayutsRelativeTime、DayutsLocale、DayutsObject)见 Date 日期库类型。
  • 颜色库类型(LColorOptions、LGenerateOptions)见 Color 颜色库类型。
  • PermListener(权限监听)见 权限类。
  • UniError 错误类型见 错误处理机制。
  • 分组组件的 group config(CheckboxGroupConfig、RadioGroupConfig、CollapseConfig、StepsConfig)及其他框架内部自用类型(SnTableConfig、SnTableCellReport、SnTypeGroup、SnTypeGroupEntry、SnCalendarBoundaries、SnCalendarSelectionResult 等)已在上文完整收录,均标记为「内部使用」。

使用 MIT 协议