Skip to content

组件类型

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

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

提示

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

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


AgreementLinkDetail 内部使用

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

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

CheckboxGroupConfig 内部使用

sn-checkbox-group 向其子组件(sn-checkboxsn-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 内部使用

二维码绘制点,QrCodeDatapoints 列表项。

名称类型必填描述
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图片路径(modeimage 时生效)
textString文本内容(modetext 时生效)
iconString图标名(modeicon 时生效)
sizeString | Number尺寸大小
shapeSnAvatarShape形状
bgColorString背景颜色
textColorString文本颜色
iconColorString图标颜色
borderRadiusString | Number圆角大小
enablePreviewBoolean是否启用图片预览(modeimage 时生效)

SnAvatarGroupItem

sn-avatar-groupdata 属性需要传入一个 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
fullDateStringYYYY-MM-DD 格式日期字符串
signedBoolean当日是否已打卡
supplementableBoolean当日是否可补签
todayBoolean是否今天

SnCalendarSwitchMode

日历面板切换粒度。

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

SnCalendarType

日历选择模式。

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

SnCalendarValue

日历选中值(v-model),随 type 变化:single 为时间戳 number \| nullrange[][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-cascaderchange 事件返回的详情。

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

SnCascaderLoadData

sn-cascaderload-data 属性接收 SnCascaderLoadData 函数:parentnull 表示加载第一级,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[]子级选项列表

SnCascaderValue

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

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

SnDataItem

通用数据项类型,sn-picker-viewsn-selectsn-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-mediafile-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-itemrule 属性校验规则。

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

SnFormItemVerifyResult 内部使用

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

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

SnFormValidResult

sn-formvalid 属性回调配置。

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

SnLocaleInfo

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

名称类型必填描述
codeString语言代码(如 zh-Hansen
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-radiosn-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-pickerchange 事件返回详情。

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

SnRegionLevel

行政区划层级。

可选值备注
province
city
county区县

SnRegionNode

行政区划节点。

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

SnRegionValue

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

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

SnScanParams

sn-scanuni.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-trsn-tdsn-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-timersn-countdown 等组件的 change 事件返回的时间结构。

名称类型必填描述
dNumber
hNumber
mNumber
sNumber
msNumber毫秒

SnToastParams

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


SnTreeData

树形数据集合,即 sn-treedata 属性类型。

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

SnTreeItem

树节点数据。

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

SnTreeLoadData

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

类型签名
SnTreeLoadResolve(children: SnTreeData) => void
SnTreeLoadReject() => void
SnTreeLoadData(item: SnTreeItem, resolve: SnTreeLoadResolve, reject: SnTreeLoadReject) => 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连接线外部样式类

其他说明

  • 日期时间库类型(DayutsConfigDayutsUnitDayutsFormatsDayutsRelativeTimeDayutsLocaleDayutsObject)见 Date 日期库类型
  • 颜色库类型(LColorOptionsLGenerateOptions)见 Color 颜色库类型
  • PermListener(权限监听)见 sn-perm-listener
  • UniError 错误类型见 错误处理机制
  • 分组组件的 group config(CheckboxGroupConfigRadioGroupConfigCollapseConfigStepsConfig)及其他框架内部自用类型(SnTableConfigSnTableCellReportSnTypeGroupSnTypeGroupEntrySnCalendarBoundariesSnCalendarSelectionResult 等)已在上文完整收录,均标记为「内部使用」。

使用 MIT 协议