组件类型
SinleUI 组件专属类型的统一参考。全部类型(含扩展组件类型)均统一从 @/uni_modules/sinle-ui 导出,使用时从插件入口导入即可:
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 事件返回的链接详情。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| text | String | 是 | 链接文本 |
| index | Number | 是 | 链接在协议中的序号(从 0 开始) |
CheckboxGroupConfig 内部使用
sn-checkbox-group 向其子组件(sn-checkbox、sn-checkbox-tag)注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-checkbox-group 的属性控制。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| boxSize | String | Number | 是 | 勾选框尺寸 |
| boxBorderRadius | String | Number | 是 | 勾选框圆角 |
| boxBorderWidth | String | Number | 是 | 勾选框边框宽度 |
| boxTextSize | String | Number | 是 | 勾选框文字字号 |
| boxTextColor | String | 是 | 勾选框文字颜色 |
| disabledBoxTextColor | String | 是 | 禁用态勾选框文字颜色 |
| boxIcon | String | 是 | 勾选框选中图标名 |
| boxIconSize | String | Number | 是 | 勾选框图标字号 |
| boxIconColor | String | 是 | 勾选框图标颜色 |
| disabledBoxIconColor | String | 是 | 禁用态勾选框图标颜色 |
| boxBorderColor | String | 是 | 勾选框边框颜色 |
| disabledBoxBorderColor | String | 是 | 禁用态勾选框边框颜色 |
| boxActiveBorderColor | String | 是 | 选中态勾选框边框颜色 |
| disabledBoxActiveBorderColor | String | 是 | 禁用态选中态勾选框边框颜色 |
| boxBgColor | String | 是 | 勾选框背景颜色 |
| disabledBoxBgColor | String | 是 | 禁用态勾选框背景颜色 |
| boxActiveBgColor | String | 是 | 选中态勾选框背景颜色 |
| disabledBoxActiveBgColor | String | 是 | 禁用态选中态勾选框背景颜色 |
| tagType | String | 是 | 标签模式功能色(primary | info | success | error | warning) |
| tagLevel | String | 是 | 标签模式表现程度等级(first | second | third | least) |
| tagBorderRadius | String | Number | 是 | 标签圆角 |
| tagPadding | String | 是 | 标签内边距 |
| tagTextSize | String | Number | 是 | 标签文字字号 |
| tagBgColor | String | 是 | 标签背景颜色 |
| disabledTagBgColor | String | 是 | 禁用态标签背景颜色 |
| tagActiveBgColor | String | 是 | 选中态标签背景颜色 |
| disabledTagActiveBgColor | String | 是 | 禁用态选中态标签背景颜色 |
| tagTextColor | String | 是 | 标签文字颜色 |
| disabledTagTextColor | String | 是 | 禁用态标签文字颜色 |
| tagActiveTextColor | String | 是 | 选中态标签文字颜色 |
| disabledTagActiveTextColor | String | 是 | 禁用态选中态标签文字颜色 |
| boxContainStyle | UTSJSONObject | String | 是 | 勾选框容器自定义样式 |
| boxStyle | UTSJSONObject | String | 是 | 勾选框自定义样式 |
| boxIconStyle | UTSJSONObject | String | 是 | 勾选框图标自定义样式 |
| tagStyle | UTSJSONObject | String | 是 | 标签自定义样式 |
| textStyle | UTSJSONObject | String | 是 | 文字自定义样式 |
| boxContainClass | String | 是 | 勾选框容器外部样式类 |
| boxClass | String | 是 | 勾选框外部样式类 |
| boxIconClass | String | 是 | 勾选框图标外部样式类 |
| tagClass | String | 是 | 标签外部样式类 |
| textClass | String | 是 | 文字外部样式类 |
ChooseMediaWebOptions 内部使用
Web 平台下 sn-upload-media / sn-upload-media-unicloud 的内置文件选择器入参,仅 Web 端编译,业务侧不应直接引用。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | String | 是 | 媒体类型,可选值 image | video | all |
| multiple | Boolean | null | 否 | 是否允许多选 |
| maxCount | Number | null | 否 | 最大选择数量 |
| success | (files: SnFile[]) => void | null | 否 | 选择成功回调 |
| fail | (err: UniError) => void | null | 否 | 选择失败回调 |
CollapseConfig 内部使用
sn-collapse 向其子组件注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-collapse 的属性控制。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| accordion | Boolean | 是 | 是否手风琴模式(同时只展开一项) |
| showBorder | Boolean | 是 | 是否显示边框 |
| aniTime | String | 是 | 展开 / 收起动画时长 |
| bgColor | String | 是 | 背景颜色 |
| titleSize | String | 是 | 标题字号 |
| titleColor | String | 是 | 标题颜色 |
| noteSize | String | 是 | 备注字号 |
| noteColor | String | 是 | 备注颜色 |
| activeTitleColor | String | 是 | 展开态标题颜色 |
| borderRadius | String | 是 | 圆角 |
| titleStyle | UTSJSONObject | 是 | 标题自定义样式 |
| holderStyle | UTSJSONObject | 是 | 内容容器自定义样式 |
| noteStyle | UTSJSONObject | 是 | 备注自定义样式 |
| titleClass | String | 是 | 标题外部样式类 |
| noteClass | String | 是 | 备注外部样式类 |
| holderClass | String | 是 | 内容容器外部样式类 |
FingerOut 内部使用
sn-gesture 内部手势识别器每帧回传的手指状态对象,含位移、缩放、旋转与速度等信息。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | String | 是 | 手势类型 |
| x | Number | 是 | 当前触点横坐标 |
| y | Number | 是 | 当前触点纵坐标 |
| startX | Number | 是 | 起始横坐标 |
| startY | Number | 是 | 起始纵坐标 |
| endX | Number | 是 | 结束横坐标 |
| endY | Number | 是 | 结束纵坐标 |
| zoom | Number | 是 | 相对起始的缩放倍数 |
| rotate | Number | 是 | 相对起始的旋转角度(deg) |
| direction | String | 是 | 移动方向 |
| deltaX | Number | 是 | 本帧横向位移增量 |
| deltaY | Number | 是 | 本帧纵向位移增量 |
| vX | Number | 是 | 横向速度 |
| vY | Number | 是 | 纵向速度 |
| evt | UniTouchEvent | null | 否 | 原始触摸事件 |
LoadingPageBridge 内部使用
全局加载(snu.showLoading)与承载它的页面(pages/popups/showLoading)之间的通信桥接对象。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| page | any | 是 | 加载页实例引用 |
| hide | () => void | 是 | 关闭加载页的方法 |
QrCellPoint 内部使用
二维码绘制点,QrCodeData 的 points 列表项。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| x | Number | 是 | 横向坐标 |
| y | Number | 是 | 纵向坐标 |
| type | Number | 是 | 模块类型(QrPointType 枚举值) |
QrCodeData 内部使用
二维码绘制数据,由组件内部编码生成。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| size | Number | 是 | 含留白的最终矩阵尺寸 |
| moduleCount | Number | 是 | 不含留白的原始模块数 |
| version | Number | 是 | 实际使用的二维码版本 |
| matrix | Boolean[][] | 是 | 模块矩阵 |
| typeTable | Number[][] | 是 | 各模块类型表(对应 QrPointType 枚举) |
| points | QrCellPoint[] | 是 | 有效模块点列表(含坐标与类型) |
QrEcLevel
二维码纠错等级。
| 可选值 | 备注 |
|---|---|
low | 低(约 7% 纠错) |
medium | 中(约 15% 纠错) |
quartile | 四分位(约 25% 纠错) |
high | 高(约 30% 纠错) |
QrEncodeOptions 内部使用
二维码编码配置,由组件内部按属性组装后传入编码器。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| ecc | QrEcLevel | 是 | 纠错等级,默认 medium |
| version | Number | 是 | 二维码版本,0 表示自动 |
| mask | Number | 是 | 掩码图样,-1 表示自动 |
| border | Number | 是 | 留白边距(模块数),默认 2 |
QrModuleShape
二维码模块形状。
| 可选值 | 备注 |
|---|---|
square | 方形 |
rounded | 圆角方形 |
circle | 圆形 |
diamond | 菱形 |
QrPointType 内部使用
二维码模块的功能类型枚举,用于绘制时区分数据区与定位 / 校正 / 时序等特殊区域。
| 可选值 | 备注 |
|---|---|
DATA | 数据模块 |
POS_CENTER | 定位图案中心 |
POS_OTHER | 定位图案其他 |
ALIGN_CENTER | 校正图案中心 |
ALIGN_OTHER | 校正图案其他 |
TIMING | 时序图案 |
FORMAT | 格式信息 |
VERSION | 版本信息 |
SnAvatarConfig
内置 sn-avatar 的组件(如列表项、发布卡)可通过 avatarConfig 属性统一配置头像参数。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| mode | SnAvatarMode | 否 | 显示模式,默认 image |
| src | String | 否 | 图片路径(mode 为 image 时生效) |
| text | String | 否 | 文本内容(mode 为 text 时生效) |
| icon | String | 否 | 图标名(mode 为 icon 时生效) |
| size | String | Number | 否 | 尺寸大小 |
| shape | SnAvatarShape | 否 | 形状 |
| bgColor | String | 否 | 背景颜色 |
| textColor | String | 否 | 文本颜色 |
| iconColor | String | 否 | 图标颜色 |
| borderRadius | String | Number | 否 | 圆角大小 |
| enablePreview | Boolean | 否 | 是否启用图片预览(mode 为 image 时生效) |
SnAvatarGroupItem
sn-avatar-group 的 data 属性需要传入一个 SnAvatarGroupItem[] 类型的数组。此对象只能传入数据,样式请通过 sn-avatar-group 的属性统一设置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| src | String | 否 | 图片路径 |
| text | String | 否 | 文本内容 |
| icon | String | 否 | 图标名称 |
| bgColor | String | 否 | 背景颜色 |
| textColor | String | 否 | 文本颜色 |
| iconColor | String | 否 | 图标颜色 |
SnAvatarMode
头像显示模式。
| 可选值 | 备注 |
|---|---|
image | 图片 |
text | 文本 |
icon | 图标 |
SnAvatarShape
头像形状。
| 可选值 | 备注 |
|---|---|
square | 方形 |
circle | 圆形 |
SnBadgeParams
内置 sn-badge 的组件可通过 badgeConfig 属性配置徽标参数。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| value | Number | 否 | 显示的值(仅 number 模式) |
| max | Number | 否 | 最大值,超过显示 max+ |
| size | String | 否 | 大小 |
| offset | String | 否 | 偏移量(transform) |
| mode | String | 否 | 可选值 number | text | dot |
| text | String | 否 | 文本内容(仅 text 模式) |
| showZero | Boolean | 否 | 是否显示 0 |
| textColor | String | 否 | 文字颜色 |
| bgColor | String | 否 | 背景颜色 |
SnBarcodeBarElement 内部使用
条码单元。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| width | Number | 是 | 模块宽度 |
| bar | Boolean | 是 | 是否为条纹(false 为间隙) |
SnBarcodeData 内部使用
条码绘制数据,由组件内部编码生成。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| elements | SnBarcodeBarElement[] | 是 | 条纹元素序列 |
| totalModules | Number | 是 | 总模块数 |
| value | String | 是 | 实际编码的文本(可能被截断) |
SnBarcodeFormat
条码格式。
| 可选值 | 备注 |
|---|---|
code128 | Code 128 |
code39 | Code 39 |
code93 | Code 93 |
codabar | Codabar |
ean8 | EAN-8 |
ean13 | EAN-13 |
upca | UPC-A |
upce | UPC-E |
itf | ITF(交错 2/5) |
SnCalendarBoundaries 内部使用
日历可选日期范围边界,由组件内部经 min-date / max-date 属性归一化后传递。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| minDate | Number | 是 | 可选最小日期时间戳(当日 0 点) |
| maxDate | Number | 是 | 可选最大日期时间戳(当日 0 点) |
SnCalendarSelectionResult 内部使用
日历选中计算的结果,由 sn-calendar-view 内部根据当前值与点击日期推导。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| value | SnCalendarValue | 是 | 计算后的新选中值 |
| changed | Boolean | 是 | 选中值是否发生变化 |
| overRange | Boolean | 是 | 是否超出允许的选择范围 |
SnCalendarDay 内部使用
formatter 回调入参,单个日期格的完整信息。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | Number | 是 | 当日 0 点时间戳 |
| year | Number | 是 | 年 |
| month | Number | 是 | 月 |
| date | Number | 是 | 日 |
| weekday | Number | 是 | 星期(0-6) |
| text | String | 是 | 日期文本 |
| prefix | String | 是 | 前缀文字(默认空) |
| suffix | String | 是 | 后缀文字(默认空) |
| today | Boolean | 是 | 是否今天 |
| disabled | Boolean | 是 | 是否禁用 |
| currentMonth | Boolean | 是 | 是否当前显示月份 |
| state | SnCalendarDayState | 是 | 选中状态 |
| paint | SnCalendarDayPaint | null | 否 | 绘制配置 |
SnCalendarDayContent 内部使用
日期格内容(formatter 返回值)。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| prefix | String | 否 | 前缀文字(如「休」) |
| text | String | 否 | 日期文本(默认为日号) |
| suffix | String | 否 | 后缀文字(如「今天」) |
| paint | SnCalendarDayPaint | null | 否 | 绘制配置 |
SnCalendarDayContentInput
createCalendarDayContent(input) 的入参类型,在内容字段之外可快捷设置圆点相关字段。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| prefix | String | 否 | 前缀文字 |
| text | String | 否 | 日期文本 |
| suffix | String | 否 | 后缀文字 |
| showDot | Boolean | 否 | 是否显示圆点 |
| dotColor | String | 否 | 圆点颜色 |
| dotPosition | SnCalendarDayDotPosition | 否 | 圆点位置 |
| paint | SnCalendarDayPaintInput | 否 | 绘制配置 |
SnCalendarDayDotPosition 内部使用
日历圆点标记位置。
| 可选值 | 备注 |
|---|---|
left | 左侧 |
right | 右侧 |
top | 顶部 |
bottom | 底部 |
SnCalendarDayFormatter
日期格格式化器:返回 null 表示使用默认内容。
| 参数 | 类型 | 说明 |
|---|---|---|
| day | SnCalendarDay | 日期格信息 |
| 返回值 | SnCalendarDayContent | null | 格式化后的内容,null 表示使用默认内容 |
SnCalendarDayPaint 内部使用
日期格绘制配置(由 SnCalendarDayContent.paint 携带,经 formatter 或 createCalendarDayPaint 构造)。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| backgroundColor | String | 否 | 背景颜色 |
| borderColor | String | 否 | 边框颜色 |
| borderWidth | Number | 否 | 边框宽度 |
| fontSize | String | Number | 否 | 日期字号 |
| prefixColor | String | 否 | 前缀文字颜色 |
| textColor | String | 否 | 日期文字颜色 |
| suffixColor | String | 否 | 后缀文字颜色 |
| prefixFontSize | Number | 否 | 前缀字号 |
| suffixFontSize | Number | 否 | 后缀字号 |
| fontWeight | String | 否 | 字重 |
| showDot | Boolean | 否 | 是否显示圆点 |
| dotColor | String | 否 | 圆点颜色 |
| dotPosition | SnCalendarDayDotPosition | 否 | 圆点位置 |
SnCalendarDayPaintInput
createCalendarDayPaint(input) 的入参类型,字段与 SnCalendarDayPaint 一致。
SnCalendarDayState 内部使用
日历日期格状态。
| 可选值 | 备注 |
|---|---|
normal | 普通 |
selected | 选中 |
range-start | 范围起点 |
range-middle | 范围中间 |
range-end | 范围终点 |
range-start-end | 起终点同日 |
SnCalendarLocaleText
日历文案配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| title | String | 是 | 弹层标题 |
| confirmText | String | 是 | 确认按钮文案 |
| confirmDisabledText | String | 是 | 确认按钮禁用态文案 |
| rangePrompt | String | 是 | 范围选择提示文案 |
| weekdays | String[] | 是 | 星期标题数组 |
| yearMonthFormat | String | 是 | 年月格式 |
SnCalendarPanelChangeDetail 内部使用
日历 panel-change 事件返回的面板切换详情。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | Number | 是 | 面板首日时间戳 |
| year | Number | 是 | 年 |
| month | Number | 是 | 月 |
SnCalendarPunchDay 内部使用
打卡日历(sn-calendar-punch)select 事件返回的单日信息。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | Number | 是 | 当日 0 点时间戳 |
| year | Number | 是 | 年 |
| month | Number | 是 | 月 |
| date | Number | 是 | 日 |
| fullDate | String | 是 | YYYY-MM-DD 格式日期字符串 |
| signed | Boolean | 是 | 当日是否已打卡 |
| supplementable | Boolean | 是 | 当日是否可补签 |
| today | Boolean | 是 | 是否今天 |
SnCalendarSwitchMode
日历面板切换粒度。
| 可选值 | 备注 |
|---|---|
month | 按月切换 |
year-month | 按年-月切换 |
SnCalendarType
日历选择模式。
| 可选值 | 备注 |
|---|---|
single | 单选 |
multiple | 多选 |
range | 范围选择 |
SnCalendarValue
日历选中值(v-model),随 type 变化:single 为时间戳 number \| null;range 为 [] 或 [start, end](单点范围写成 [same, same]);multiple 为时间戳数组 number[]。
| 类型 | 说明 |
|---|---|
number | null | single 模式:时间戳或空 |
number[] | multiple 模式:时间戳数组 |
[] | [start, end] | range 模式:空或起止时间戳(单点范围写成 [same, same]) |
SnCalendarWeekChangeDetail 内部使用
周日历(sn-calendar-week)week-change 事件返回详情。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | Number | 是 | 当前周首日时间戳 |
| year | Number | 是 | 年 |
| month | Number | 是 | 月 |
SnCalendarWeekDay 内部使用
周日历(sn-calendar-week)单日信息,由组件内部构建。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| timestamp | Number | 是 | 当日 0 点时间戳 |
| text | String | 是 | 日号文本 |
| weekTitle | String | 是 | 所属周标题 |
| today | Boolean | 是 | 是否今天 |
| disabled | Boolean | 是 | 是否禁用 |
| showDot | Boolean | 是 | 是否显示圆点 |
| dotColor | String | 是 | 圆点颜色 |
SnCalendarWeekStartDay
日历周起始日。
| 可选值 | 备注 |
|---|---|
sunday | 星期日 |
monday | 星期一 |
tuesday | 星期二 |
wednesday | 星期三 |
thursday | 星期四 |
friday | 星期五 |
saturday | 星期六 |
SnCascaderDetail 内部使用
sn-cascader 的 change 事件返回的详情。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| values | String[] | 是 | 各级选中值 |
| labels | String[] | 是 | 各级选中文本 |
| options | SnCascaderOption[] | 是 | 各级选中的选项对象 |
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
级联选项。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| value | String | 是 | 选项值 |
| label | String | 是 | 选项显示文本 |
| disabled | Boolean | 否 | 是否禁用 |
| leaf | Boolean | 否 | 是否叶子节点(懒加载模式下标记不再展开) |
| children | SnCascaderOption[] | 否 | 子级选项列表 |
SnCascaderValue
级联选中值:各级选项 value 组成的数组(v-model)。
| 类型 | 说明 |
|---|---|
string[] | 各级选中值数组 |
SnDataItem
通用数据项类型,sn-picker-view、sn-select、sn-topbar 等数据组件的 data 属性需要传入一个 SnDataItem[],全局操作菜单(snu.showActionsheet)的 actions 同样使用它。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 否 | 数据的唯一标识 |
| text | String | 否 | 数据显示文本 |
| icon | String | 否 | 数据显示图标 |
| value | String | 否 | 关联值 |
| color | String | 否 | 文本颜色 |
| disabled | Boolean | 否 | 是否禁用子项 |
SnDatetimePickerTimeModeValue
日期时间选择器时间选择粒度模式。
| 可选值 | 备注 |
|---|---|
year | 年 |
month | 月 |
date | 日 |
hour | 时 |
minute | 分 |
second | 秒 |
SnDatetimePickerValue
日期时间选择器选中值(v-model):时间戳数字或时间格式字符串。
| 类型 | 说明 |
|---|---|
string | number | 时间格式字符串或时间戳数字 |
SnEmptyColorConfig 内部使用
sn-empty 内部传递插画配色参数。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| themeColor | String | 是 | 主题颜色 |
| hairColor | String | 是 | 头发颜色 |
| clothesColor | String | 是 | 衣服颜色 |
| trousersColor | String | 是 | 裤子颜色 |
| shoesColor | String | 是 | 鞋子颜色 |
| itemColor | String | 是 | 项目颜色 |
| skinColor | String | 是 | 皮肤颜色 |
| elementColor | String | 是 | 元素颜色 |
SnFile 内部使用
上传媒体文件信息,由 sn-upload-media 的 file-chose 事件与内部选择逻辑返回。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| filename | String | 是 | 文件名 |
| path | String | 是 | 文件路径 |
| size | Number | 否 | 文件大小 |
| ext | String | 是 | 扩展名 |
SnFooterLink
sn-footer 链接项。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| name | String | 否 | 链接名称 |
| url | String | 否 | 跳转地址 |
| openType | String | 否 | 打开方式 |
SnFooterLogo
sn-footer Logo 配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| icon | String | 否 | 图标名 |
| title | String | 否 | 标题文本 |
| url | String | 否 | 跳转地址 |
| openType | String | 否 | 打开方式 |
SnFormItemData 内部使用
sn-form-item 内部注册组件数据类型。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| field | String | 是 | 子项名称 |
| instance | ComponentPublicInstance | 是 | 子项实例 |
SnFormItemRule
sn-form-item 的 rule 属性校验规则。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | String | 否 | 字段类型(如 string / number / array / url / email / phone 等) |
| required | Boolean | 否 | 是否必填 |
| message | String | 否 | 校验失败提示信息 |
| pattern | RegExp | 否 | 正则校验规则 |
| min | Number | 否 | 最小长度 |
| max | Number | 否 | 最大长度 |
| len | Number | 否 | 固定长度 |
| enum | any[] | 否 | 枚举校验,值须在列表内 |
| transform | (value: any) => any | 否 | 校验前对值进行转换 |
| valid | (value: any) => string | 否 | 自定义校验函数,返回非空字符串表示失败信息 |
SnFormItemVerifyResult 内部使用
单项校验结果,经 sn-form 的 fail 事件与 valid.fail 回调返回,业务侧只读。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| valid | Boolean | 是 | 是否通过校验 |
| message | String | 否 | 失败信息 |
| field | String | 是 | 子项名称 |
SnFormValidResult
sn-form 的 valid 属性回调配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| success | () => void | 否 | 全部通过回调 |
| fail | (failResults: SnFormItemVerifyResult[]) => void | 否 | 失败回调,入参为失败结果数组 |
SnLocaleInfo
语言条目,SUPPORTED_LOCALES 数组的元素类型,可直接渲染为语言选择器。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | String | 是 | 语言代码(如 zh-Hans、en) |
| name | String | 是 | 该语言的本地化名称(如 简体中文、English) |
SnLoadmoreParams
sn-loadmore / 列表加载更多的文案与样式配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| loadmoreText | String | 否 | 加载前文案 |
| nomoreText | String | 否 | 没有更多文案 |
| loadingText | String | 否 | 加载中文案 |
| textSize | String | 否 | 文本字号 |
| textColor | String | 否 | 文本颜色 |
| iconSize | String | 否 | 图标字号 |
| iconColor | String | 否 | 图标颜色 |
| lineColor | String | 否 | 线条颜色 |
| lineHeight | String | 否 | 线条高度 |
| dashed | Boolean | 否 | 线条是否虚线 |
| disabled | Boolean | 否 | 是否禁用 |
SnMedia 内部使用
上传媒体条目。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| file | any | 否 | 文件对象 |
| src | String | 否 | 预览路径 |
| thumb | String | 否 | 缩略图路径 |
| name | String | 是 | 文件名 |
| status | String | 是 | 上传状态,可选值 uploaded | uploading | unuploaded | error |
| type | String | 是 | 媒体类型,可选值 image | video |
| ext | String | 否 | 扩展名 |
SnMessageLevel
消息条表现程度等级。
| 可选值 | 备注 |
|---|---|
first | 一级(表现最重) |
second | 二级 |
third | 三级(表现最轻) |
SnMessageParams
sn-message 组件 add 方法入参。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| text | String | 否 | 消息内容 |
| type | SnMessageType | 否 | 消息类型 |
| level | SnMessageLevel | 否 | 消息等级 |
| position | SnMessagePosition | 否 | 队列位置 |
| duration | Number | 否 | 显示时长(ms) |
| showIcon | Boolean | 否 | 是否显示图标 |
| icon | String | 否 | 图标名 |
| closable | Boolean | 否 | 是否显示关闭按钮 |
| grouping | Boolean | 否 | 相同内容是否归并计数 |
| bgColor | String | 否 | 背景颜色 |
| textColor | String | 否 | 文字颜色 |
| iconColor | String | 否 | 图标颜色 |
| textSize | String | 否 | 文字字号 |
| borderRadius | String | 否 | 圆角 |
| customStyle | UTSJSONObject | 否 | 自定义样式 |
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 方法入参。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| title | String | 否 | 通知标题 |
| content | String | 否 | 通知内容 |
| type | SnNotificationType | 否 | 通知类型 |
| level | SnNotificationLevel | 否 | 通知等级 |
| position | SnNotificationPosition | 否 | 队列位置,可选值 top | bottom |
| duration | Number | 否 | 显示时长(ms) |
| showProgress | Boolean | 否 | 是否显示进度条 |
| showIcon | Boolean | 否 | 是否显示图标 |
| icon | String | 否 | 图标名 |
| closable | Boolean | 否 | 是否显示关闭按钮 |
| showAction | Boolean | 否 | 是否显示右侧操作插槽(slot="action",需组件标签内定义插槽内容) |
| grouping | Boolean | 否 | 相同内容是否归并计数 |
| bgColor | String | 否 | 背景颜色 |
| titleColor | String | 否 | 标题颜色 |
| contentColor | String | 否 | 内容颜色 |
| iconColor | String | 否 | 图标颜色 |
| borderRadius | String | 否 | 圆角 |
| draggable | Boolean | 否 | 是否可拖拽 |
| dragThreshold | String | Number | 否 | 拖拽关闭位移阈值 |
| customStyle | UTSJSONObject | 否 | 自定义样式 |
SnNotificationPosition
通知队列位置。
| 可选值 | 备注 |
|---|---|
top | 顶部 |
bottom | 底部 |
SnNotificationType
通知类型。
| 可选值 | 备注 |
|---|---|
primary | 主色 |
success | 成功 |
error | 错误 |
info | 信息 |
warning | 警告 |
SnPostCardAction
动态卡片(sn-post-card)操作栏按钮配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 否 | 按钮 id |
| icon | String | 否 | 图标名 |
| text | String | 否 | 按钮文字(一般为数量) |
| disabled | Boolean | 否 | 是否禁用 |
| isActive | Boolean | 否 | 是否处于激活态(如已点赞) |
| iconColor | String | 否 | 图标颜色 |
| textColor | String | 否 | 文字颜色 |
| activeIconColor | String | 否 | 激活态图标颜色 |
| activeTextColor | String | 否 | 激活态文字颜色 |
SnPostCardComment
动态卡片评论区条目。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 否 | 评论 id |
| user | String | 否 | 评论用户 |
| content | String | 否 | 评论内容 |
| replyTo | String | 否 | 回复的用户名(为空表示直接评论) |
RadioGroupConfig 内部使用
sn-radio-group 向其子组件(sn-radio、sn-radio-tag)注入的配置对象,用于统一子项的外观与样式。业务侧只读,请通过 sn-radio-group 的属性控制。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| radioSize | String | Number | 是 | 单选按钮尺寸 |
| radioBorderWidth | String | Number | 是 | 单选按钮边框宽度 |
| radioTextSize | String | Number | 是 | 单选按钮文字字号 |
| radioBgColor | String | 是 | 单选按钮背景颜色 |
| disabledRadioBgColor | String | 是 | 禁用态单选按钮背景颜色 |
| radioActiveBgColor | String | 是 | 选中态单选按钮背景颜色 |
| disabledRadioActiveBgColor | String | 是 | 禁用态选中态单选按钮背景颜色 |
| radioTextColor | String | 是 | 单选按钮文字颜色 |
| disabledRadioTextColor | String | 是 | 禁用态单选按钮文字颜色 |
| radioBorderColor | String | 是 | 单选按钮边框颜色 |
| disabledRadioBorderColor | String | 是 | 禁用态单选按钮边框颜色 |
| radioActiveBorderColor | String | 是 | 选中态单选按钮边框颜色 |
| disabledRadioActiveBorderColor | String | 是 | 禁用态选中态单选按钮边框颜色 |
| tagType | String | 是 | 标签模式功能色(primary | info | success | error | warning) |
| tagLevel | String | 是 | 标签模式表现程度等级(first | second | third | least) |
| tagBorderRadius | String | Number | 是 | 标签圆角 |
| tagPadding | String | 是 | 标签内边距 |
| tagTextSize | String | Number | 是 | 标签文字字号 |
| tagBgColor | String | 是 | 标签背景颜色 |
| disabledTagBgColor | String | 是 | 禁用态标签背景颜色 |
| tagActiveBgColor | String | 是 | 选中态标签背景颜色 |
| disabledTagActiveBgColor | String | 是 | 禁用态选中态标签背景颜色 |
| tagTextColor | String | 是 | 标签文字颜色 |
| disabledTagTextColor | String | 是 | 禁用态标签文字颜色 |
| tagActiveTextColor | String | 是 | 选中态标签文字颜色 |
| disabledTagActiveTextColor | String | 是 | 禁用态选中态标签文字颜色 |
| radioContainStyle | UTSJSONObject | String | 是 | 单选按钮容器自定义样式 |
| radioStyle | UTSJSONObject | String | 是 | 单选按钮自定义样式 |
| tagStyle | UTSJSONObject | String | 是 | 标签自定义样式 |
| textStyle | UTSJSONObject | String | 是 | 文字自定义样式 |
| radioContainClass | String | 是 | 单选按钮容器外部样式类 |
| radioClass | String | 是 | 单选按钮外部样式类 |
| tagClass | String | 是 | 标签外部样式类 |
| textClass | String | 是 | 文字外部样式类 |
SnRefresherParams
下拉刷新区域文案与样式配置。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| refreshText | String | 否 | 下拉中文案 |
| refreshingText | String | 否 | 刷新中文案 |
| textSize | String | 否 | 文本字号 |
| textColor | String | 否 | 文本颜色 |
| icon | String | 否 | 图标名 |
| iconSize | String | 否 | 图标字号 |
| iconColor | String | 否 | 图标颜色 |
SnRegionDetail 内部使用
sn-region-picker 的 change 事件返回详情。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| codes | String[] | 是 | 各级区划代码数组 |
| names | String[] | 是 | 各级名称数组 |
SnRegionLevel
行政区划层级。
| 可选值 | 备注 |
|---|---|
province | 省 |
city | 市 |
county | 区县 |
SnRegionNode
行政区划节点。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | String | 是 | 区划代码 |
| name | String | 是 | 名称 |
| children | SnRegionNode[] | 否 | 子级节点 |
SnRegionValue
sn-region-picker 选中值(v-model):各级区划代码数组。
| 类型 | 说明 |
|---|---|
string[] | 各级区划代码数组 |
SnScanParams
sn-scan 经 uni.navigateTo 打开扫码页时通过 SnScanParams 传参(snu.openScanPage 等封装亦使用)。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| scanType | String | 否 | 扫码类型,可选值 barcode | qrcode | all,默认 all |
| continuous | Boolean | 否 | 是否连续扫码 |
| scanOnlyOnce | Boolean | 否 | 是否识别一次后自动返回 |
| continuousSleep | Number | 否 | 连续扫码间隔(ms) |
| enableDing | Boolean | 否 | 识别成功提示音 |
| dingFileSrc | String | 否 | 自定义提示音文件路径 |
| showTorch | Boolean | 否 | 是否显示手电筒按钮 |
| showAlbum | Boolean | 否 | 是否显示相册选择按钮 |
| showBackButton | Boolean | 否 | 是否显示返回按钮 |
| showAni | Boolean | 否 | 是否显示扫码动画 |
| enableZoom | Boolean | 否 | 是否启用手势缩放 |
| initZoomScale | Number | 否 | 初始缩放倍数 |
| title | String | 否 | 页面标题 |
| titleSize | String | Number | 否 | 标题字号 |
| titleColor | String | 否 | 标题颜色 |
| tip | String | 否 | 提示文本 |
| tipSize | String | Number | 否 | 提示字号 |
| tipColor | String | 否 | 提示颜色 |
| customTitleStyle | UTSJSONObject | String | 否 | 标题自定义样式 |
| customTipStyle | UTSJSONObject | 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 的属性控制。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| bordered | Boolean | 是 | 是否显示单元格边框 |
| underline | Boolean | 是 | 是否显示单元格下划线 |
| borderColor | String | 是 | 边框与下划线颜色 |
| scrollable | Boolean | 是 | 是否允许横向滚动 |
SnTableCellReport 内部使用
表格单元格向行组件回传的尺寸上报信息,用于计算固定列的偏移量。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| kind | String | 是 | 固定类型,可选值 left | right | all |
| width | Number | 是 | 单元格实测宽度(px) |
SnTabbarItem
sn-tabbar 标签栏项数据。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| text | String | 否 | 文本 |
| icon | String | 否 | 图标名 |
| image | String | 否 | 图片路径(优先于 icon) |
| activeIcon | String | 否 | 选中态图标名 |
| activeText | String | 否 | 选中态文本 |
| activeImage | String | 否 | 选中态图片路径 |
| interceptor | () => boolean | 否 | 切换拦截器,返回 false 阻止切换 |
| badge | SnBadgeParams | null | 否 | 徽标配置 |
SnTabParams
sn-tabs 标签项数据。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| text | String | 是 | 标签文本 |
| icon | String | 否 | 图标名 |
| id | String | 是 | 标签唯一 id |
| disabled | Boolean | 否 | 是否禁用 |
| checked | Boolean | 否 | 是否选中 |
| showBadge | Boolean | 否 | 是否显示徽标 |
| badgeConfig | SnBadgeParams | null | 否 | 徽标配置 |
SnTime 内部使用
sn-timer、sn-countdown 等组件的 change 事件返回的时间结构。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| d | Number | 是 | 天 |
| h | Number | 是 | 时 |
| m | Number | 是 | 分 |
| s | Number | 是 | 秒 |
| ms | Number | 是 | 毫秒 |
SnToastParams
sn-toast 组件 show 方法入参,字段与 SnShowToastConfig 基本一致(无回调字段),另含 overlay(是否显示遮罩)。
SnTreeData
树形数据集合,即 sn-tree 的 data 属性类型。
| 类型 | 说明 |
|---|---|
| SnTreeItem[] | 树节点列表 |
SnTreeItem
树节点数据。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | String | 是 | 节点唯一 id |
| text | String | 是 | 节点显示文本 |
| icon | String | 否 | 节点图标名 |
| activeIcon | String | 否 | 选中态图标名 |
| rotate | Number | 否 | 图标展开旋转角度(deg) |
| disabled | Boolean | 否 | 是否禁用节点 |
| lazy | Boolean | 否 | 是否懒加载子节点(配合 load-data) |
| children | SnTreeItem[] | 否 | 子节点列表 |
SnTreeLoadData
sn-tree 的 load-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 的条目。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | Number | 是 | 分组类型值(取自列表项的 type 字段,缺省为 0) |
| entries | SnTypeGroupEntry[] | 是 | 该分组下的条目列表 |
SnTypeGroupEntry 内部使用
sn-list-view / sn-waterflow 内部打平后的列表条目,承载原始数据及其索引与分组类型。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| item | any | 是 | 原始列表项数据 |
| index | Number | 是 | 该条目在原始 list 中的下标 |
| type | Number | 是 | 该条目的分组类型值 |
StepsConfig 内部使用
sn-steps 向其子组件(sn-step)注入的配置对象,用于统一各步骤的外观与样式。业务侧只读,请通过 sn-steps 的属性控制。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| vertical | Boolean | 是 | 是否纵向排列 |
| type | String | 是 | 步骤条类型 |
| selectable | Boolean | 是 | 步骤是否可点击切换 |
| activeColor | String | 是 | 激活态颜色 |
| circleSize | String | Number | 是 | 步骤圆圈尺寸 |
| textSize | String | Number | 是 | 标题文字字号 |
| contentSize | String | Number | 是 | 内容文字字号 |
| stepStyle | UTSJSONObject | String | 是 | 步骤项自定义样式 |
| stepClass | String | 是 | 步骤项外部样式类 |
| titleStyle | UTSJSONObject | String | 是 | 标题自定义样式 |
| titleClass | String | 是 | 标题外部样式类 |
| contentStyle | UTSJSONObject | String | 是 | 内容自定义样式 |
| contentClass | String | 是 | 内容外部样式类 |
| lineStyle | UTSJSONObject | String | 是 | 连接线自定义样式 |
| lineClass | String | 是 | 连接线外部样式类 |
其他说明
- 日期时间库类型(
DayutsConfig、DayutsUnit、DayutsFormats、DayutsRelativeTime、DayutsLocale、DayutsObject)见 Date 日期库类型。 - 颜色库类型(
LColorOptions、LGenerateOptions)见 Color 颜色库类型。 PermListener(权限监听)见 sn-perm-listener。UniError错误类型见 错误处理机制。- 分组组件的 group config(
CheckboxGroupConfig、RadioGroupConfig、CollapseConfig、StepsConfig)及其他框架内部自用类型(SnTableConfig、SnTableCellReport、SnTypeGroup、SnTypeGroupEntry、SnCalendarBoundaries、SnCalendarSelectionResult等)已在上文完整收录,均标记为「内部使用」。
