更新记录

1.0.0(2026-07-22)

  • 空壳 UTS 占位(五端 getHello / getHelloAsync
  • readme.md:15 个 sibling API 总表
  • 双轨示例 App:pages/ + pagesx/,主页 catalog + 30 个详情页
  • 详情页:keywords、三指标、平台矩阵、API 清单(与 readme 同步)
  • 示例页自包含,不 import sibling 插件
  • DESIGN.md 设计说明与新增示例操作清单

平台兼容性

uni-app(4.87)

Vue2 Vue3 Chrome Safari app-vue app-nvue Android iOS 鸿蒙
微信小程序 支付宝小程序 抖音小程序 百度小程序 快手小程序 京东小程序 鸿蒙元服务 QQ小程序 飞书小程序 小红书小程序 快应用-华为 快应用-联盟
× × × × × × × × × × ×

uni-app x(5.0)

Chrome Safari Android iOS 鸿蒙 微信小程序

Xview Vip 汇总清单

购买本插件(xview-vip)后,即可免费获取下方目录列表中全部插件与组件的源码。

符号: 支持 · / 兼容/部分支持 · × 不支持 · 规划中/无实现

符号 说明
支持:该平台有实现且能力完整可用
/ 兼容/部分支持:降级实现、演示级、依赖版本、仅部分参数可用
× 不支持:无 utssdk 目录、readme 明确不支持,或调用返回统一不支持错误
规划中/无实现:占位仓库、尚未定义 API

Vip 服务支持

  • 源码授权:购买 xview-vip 后,可免费获取下方目录列表中全部插件与组件源码
  • 持续更新:提供 Git 仓库访问与持续推送(能力迭代、平台适配、Bug 修复);VIP 交流群互动答疑

Vip 目录列表

插件(11)

目录 模块 ID 说明
Xview-Deviceid xview-device 跨平台设备标识
Xview-Files xview-files 应用沙箱文件管理
Xview-Keepalive xview-keepalive App 前台/后台保活
Xview-Location xview-location 原生 GPS 五端定位
Xview-Logger xview-logger 原生日志采集与上传
Xview-Notification xview-notification 系统通知统一 API
Xview-Request xview-request HTTP/上传下载/WebSocket
Xview-Scancode xview-scancode 二维码/条码扫码
Xview-Share xview-share 系统分享
Xview-Sqlite xview-sqlite 五端 SQLite
Xview-Water-Mark xview-watermark 跨平台图片水印

标准组件(2)

目录 模块 ID 说明
Xview-Camera-View xview-camera-view uni-app x 标准模式相机
Xview-Liveness-View xview-liveness-view uni-app x 活体检测

兼容组件(2)

目录 模块 ID 说明
Xview-Camera-Viewer 兼容模式相机(待实现)
Xview-Liveness-Viewer 兼容模式活体(待实现)

Xview-Camera-View

  • 模块 IDxview-camera-view
  • 类型:标准组件 <xview-camera-view>
  • 功能说明:uni-app x 标准模式相机组件:预览、拍照、录像、聚焦缩放。

方法

API 说明 Android iOS HarmonyOS Web 微信小程序
open() 打开相机预览
reopen() 关闭后重新打开
close() 关闭预览
destroyCamera() 销毁相机实例
isOpened() 是否已打开
openAppSettings() 跳转系统设置 × × ×
takePhoto() 拍照
takeVideo(maxDuration?) 开始录像 / /
stopVideo() 停止录像 / /
changeFacing(facing) 切换前/后摄
changeFlash(flash) 闪光灯模式 / / /
changeMode(mode) 拍摄模式 / /
changePhotoFormat(format) 照片格式 / / /
changeResolution(resolution) 分辨率 / / / /
changeSaveToAlbum(save) 保存相册 × /
changeWhiteBalance(wb) 白平衡 × × ×
changeHdr(hdr) HDR 开关 × × ×
changeExposure(exposure) 曝光补偿 / × ×
changeAudio(audio) 录像音频 / /
changeLinearZoom(zoom) 线性缩放 0–1 / × ×
changeZoomRatio(ratio) 变焦倍率 / × ×
switchUltraWide() 切换超广角 × × ×
resetZoom() 恢复标准主摄 / × ×
changeGrid(grid,color) 网格线 × × ×
changeCorner(radius?,ratio?) 预览圆角
changePreviewRotate(deg) 预览旋转 / / /
changeZoomGesture(enabled) 双指缩放 × × ×
changeTapFocus(enabled) 点击对焦 × × ×
changeTargetSize(w,h?,tol?) 指定目标分辨率 × × × ×
changeKeyShortcut(enabled) 物理键快捷键 × × × ×
changeRecordSound(en,file) 录像提示音 / × ×
changeFeedback(...) 快门反馈/震动 / / /

主要 Props

API 说明 Android iOS HarmonyOS Web 微信小程序
facing 镜头
flash 闪光
mode 模式
photoFormat 格式 / /
saveToAlbum 存相册 / /
resolution 分辨率档位 / / / /
grid 网格 × × ×
gridColor 网格颜色 × × ×
whiteBalance 白平衡 × × ×
hdr HDR × × ×
zoomGesture 缩放/对焦手势 × × ×
tapFocus 缩放/对焦手势 × × ×
keyShortcut 物理键 × × × ×
shutterFeedback 快门反馈 / / /

事件

API 说明 Android iOS HarmonyOS Web 微信小程序
@onCameraOpened 打开
@onCameraClosed 关闭
@onPictureTaken 拍照完成 / /
@onVideoTakenStart 录像开始 / /
@onVideoTakenProgress 录像进度 / /
@onVideoTakenEnd 录像结束 / /
@onFocusStart 对焦开始 × × ×
@onFocusEnd 对焦结束 × × ×
@onZoomChanged 缩放变化 / × ×
@onCameraChange 参数变更 / / /
@onCameraTakenError 拍照错误
@onCameraError 相机错误

Xview-Camera-Viewer

  • 模块 ID:—
  • 类型:兼容组件(待实现)
  • 功能说明:兼容模式相机组件(Android/iOS),规划中,暂无公开 API。
API 说明 Android iOS HarmonyOS Web 微信小程序
规划中,暂无公开 API

Xview-Deviceid

  • 模块 IDxview-device
  • 类型:UTS 插件
  • 功能说明:跨平台设备标识:AndroidID/OAID、IDFV/IDFA、Harmony ODID、Web/小程序指纹。
API 说明 Android iOS HarmonyOS Web 微信小程序
getDeviceId(callback) 异步获取设备唯一标识
getDeviceIdSync() 同步获取设备唯一标识
getPlatformInfo(callback) 异步平台概要
getPlatformInfoSync() 同步平台概要
getDeviceInfo(callback) 异步设备信息
getDeviceInfoSync() 同步设备信息

Xview-Files

  • 模块 IDxview-files
  • 类型:UTS 插件(仅 App 三端)
  • 功能说明:应用沙箱文件管理:读写、目录、复制移动、分块读、SHA-256、ZIP、下载。
API 说明 Android iOS HarmonyOS Web 微信小程序
getSandboxPaths() 获取沙箱根路径 × ×
createPath(options) 创建目录 × ×
writeTextFile(options) 写入 UTF-8 文本 × ×
readTextFile(options) 读取 UTF-8 文本 × ×
listPaths(options) 列举目录 × ×
getPathInfo(options) 路径元数据 × ×
checkPathAccess(options) 路径访问检查 × ×
readFileChunk(options) Base64 分块读取 × ×
truncateFile(options) 按字节截断 × ×
getFileDigest(options) SHA-256 摘要 × ×
copyPath(options) 复制路径 × ×
movePath(options) 移动路径 × ×
removePath(options) 删除路径 × ×
createZip(options) 创建 ZIP × × × ×
extractZip(options) 解压 ZIP × × × ×
downloadFiles(options) 批量下载 × × ×

Xview-Keepalive

  • 模块 IDxview-keepalive
  • 类型:UTS 插件(仅 App 三端)
  • 功能说明:App 前台/后台保活、WakeLock、电池优化与通知权限引导。
API 说明 Android iOS HarmonyOS Web 微信小程序
startKeepalive(options) 启动后台保活 / / × ×
requestNotificationPermission(s,f) 申请通知权限 × ×
restartKeepalive() 重启保活 / / × ×
stopKeepalive() 停止保活 × ×
updateKeepaliveNotification(opts) 更新通知 × × ×
getKeepaliveStatus() 查询状态 × ×
isKeepaliveRunning() 是否运行中 × ×
checkNotificationEnabled() 通知是否可用 × ×
openNotificationSettings() 打开通知设置 / × ×
isIgnoringBatteryOptimizations() 电池优化白名单 × × × ×
requestIgnoreBatteryOptimizations() 请求忽略电池优化 / / × ×
openBatteryOptimizationSettings() 打开电池优化设置 / / × ×
acquireWakeLock(timeoutMs) 临时 WakeLock × × × ×
flushKeepaliveReconnectEvents() 读取恢复事件 / / × ×
markKeepaliveReconnect(reason) 标记恢复事件 × ×

Xview-Liveness-View

  • 模块 IDxview-liveness-view
  • 类型:标准组件 <xview-liveness-view>(仅 App 三端)
  • 功能说明:uni-app x 活体检测标准组件:动作/多距离/炫彩活体与存证。

方法

API 说明 Android iOS HarmonyOS Web 微信小程序
open() 打开相机预览 × ×
close() 关闭预览 × ×
reset() 重置检测状态 × ×
isOpened() 是否已打开 × ×
destroy() 释放资源 × ×
startDetection(actionList?) 开始活体检测 / / × ×
retryDetection(...) 失败后重试 / / × ×
peekLastPictureTakenJson() peek 最近拍照 × ×
consumeLastPictureTakenJson() 消费最近拍照 × ×
clearLastPictureTakenCache() 清空拍照缓存 × ×

主要 Props / 事件

API 说明 Android iOS HarmonyOS Web 微信小程序
facing 镜头 × ×
actions 动作序列 × ×
requiredFrames 必需帧数 × ×
actionThresholds 检测阈值调参 / / × ×
livenessMode 活体模式 / / × ×
炫彩相关 props 炫彩相关 props / / × ×
autoRecordVideo 自动录像 / / × ×
returnPhoto 返回照片 / / × ×
@onActionChange 动作变化 / / × ×
@onLivenessPass 活体通过 / / × ×
@onColorPhaseChange 炫彩活体事件 / / × ×
@onPictureTaken 拍照 / / × ×
@onVideoRecordEnd 录像结束 / / × ×
@onCameraError 相机错误 × ×
@onFaceError 人脸错误 × ×

Xview-Liveness-Viewer

  • 模块 ID:—
  • 类型:兼容组件(待实现)
  • 功能说明:兼容模式活体组件(Android/iOS),规划中,暂无公开 API。
API 说明 Android iOS HarmonyOS Web 微信小程序
规划中,暂无公开 API

Xview-Location

  • 模块 IDxview-location
  • 类型:UTS 插件
  • 功能说明:原生 GPS 五端定位:权限、持续监听、坐标转换、逆地理编码。
API 说明 Android iOS HarmonyOS Web 微信小程序
initLocation() 初始化定位上下文
getRuntimeProfile() 平台能力描述
checkPermission(name) 检查权限
requestPermission(name,cb) 申请权限
isLocationEnabled() 定位总开关
openLocationSettings() 打开定位设置 /
requestBackgroundMode(cb) 申请后台定位 × /
getLastLocation(cb) 读取最近定位
getLastLocationTuple(cb) 元组形式读取
watchLocation(opts,cb) 持续监听
watchLocationTuple(opts,cb) 元组形式监听
stopLocationWatch(dismiss) 停止监听
readPendingLocations() 回灌息屏缓存 × × × ×
convertCoordinate(...) 单点坐标转换
convertCoordinates(...) 批量坐标转换
isGcj02OffsetRegion(...) GCJ-02 范围判断
reverseGeocode(opts,cb) 高德逆地理编码 / /
getAndroidDiagnostics() Android 诊断 × × × ×
requestNotificationPermission(cb) Android 通知权限 × × × ×
openNotificationSettings() 打开通知设置 × × × ×
openBatterySettings() 打开电池设置 × × × ×

Xview-Logger

  • 模块 IDxview-logger
  • 类型:UTS 插件(仅 App 三端)
  • 功能说明:原生日志采集、生命周期/崩溃、ZIP 压缩与顺序上传。
API 说明 Android iOS HarmonyOS Web 微信小程序
initLogger(options) 初始化日志采集 × ×
stopLogger() 停止采集 × ×
setLoggerUser(userId) 设置用户 ID × ×
setLoggerTag(tag) 设置标签 × ×
clearLoggerContext() 清空上下文 × ×
writeInfoLog(msg) 写 INFO 日志 × ×
writeWarnLog(msg) 写 WARN 日志 × ×
writeErrorLog(msg) 写 ERROR 日志 × ×
writeEventLog(name,msg) 写事件日志 × ×
listLogFiles() 列出日志文件 × ×
cleanExpiredLogs(opts) 清理过期日志 × ×
compressLogFiles(paths,name) 压缩为 ZIP × ×
removeLogArchive(path) 删除归档 × ×
uploadLogFiles(...) 上传日志 × ×
uploadCompressedLogs(...) 压缩后上传 × ×
uploadFile(...) 上传单文件 × ×
uploadFolder(...) 压缩文件夹上传 × ×

Xview-Notification

  • 模块 IDxview-notification
  • 类型:UTS 插件
  • 功能说明:系统通知 + Web DOM 弹层统一 API,支持进度、定时与点击回调。
API 说明 Android iOS HarmonyOS Web 微信小程序
requestNotificationPermission(s,f) 申请通知权限 / ×
isNotificationEnabled() 检查通知可用 ×
openNotificationSettings() 打开通知设置 / × ×
isExactAlarmEnabled() 精确定时权限 / × × ×
sendNotification(options) 发送通知 / / ×
sendSimpleNotification(...) 快捷普通通知 / / ×
sendProgressNotification(...) 进度通知 / / / ×
onNotificationClick(cb) 点击监听 × ×
offNotificationClick() 移除监听 ×
scheduleNotification(options) 定时通知 / / ×
sendRepeatingNotification(options) 重复通知 / / / ×
cancelScheduledNotification(id) 取消定时 / / ×
updateScheduledNotification(...) 更新定时文案 / / / ×
updateNotification(id,opts) 更新通知 / ×
updateProgress(...) 更新进度 / / ×
completeProgress(id) 进度完成 / / ×
cancelNotification(id) 取消指定通知 ×
cancelAllNotifications() 取消全部 ×

Xview-Request

  • 模块 IDxview-request
  • 类型:UTS 插件(统一调度层,五端可用)
  • 功能说明:HTTP/上传下载/WebSocket/拦截器统一封装(基于 uni 网络栈)。
API 说明 Android iOS HarmonyOS Web 微信小程序
createRequest(config?) 创建 Request 实例
getRequestFail(err) 解析错误对象
Request.onRequestInterceptor(fn) 请求拦截器
Request.onResponseInterceptor(fn) 响应拦截器
Request.onDebuggerInterceptor(fn) 调试拦截器
Request.getNetworkStatus() 查询网络状态
Request.watchNetworkStatus(l) 监听网络变化
Request.stopNetworkStatus(id) 取消网络监听
Request.request(config) 通用 HTTP 请求
Request.get(...) HTTP GET
Request.post(...) HTTP POST
Request.put(...) HTTP PUT
Request.head(...) HTTP HEAD
Request.options(...) HTTP OPTIONS
Request.formPost(...) 表单 POST
Request.deleteRequest(...) DELETE 请求
Request.upload(...) 文件上传
Request.download(...) 文件下载
Request.connectSocket(opts) WebSocket 连接
XViewSocketClient.send(...) 发送 Socket
XViewSocketClient.close(...) 关闭 Socket

Xview-Scancode

  • 模块 IDxview-scancode
  • 类型:UTS 插件
  • 功能说明:二维码/条码统一扫码,支持单次、持续、多码与手电筒。
API 说明 Android iOS HarmonyOS Web 微信小程序
xviewScanCode(options) 调起扫码(回调)
xviewScanCodeAsync(options) 调起扫码(Promise)
closeXviewScanCode() 停止持续扫码
parseXviewScanCode(options) 解析扫码内容
setXviewTorch(options) 手电筒控制 × × ×
getXviewScanCodePlatformInfo() 查询平台能力

Xview-Share

  • 模块 IDxview-share
  • 类型:UTS 插件
  • 功能说明:系统分享文本/链接/图片/文件,支持 Promise 与 Android 目标 App 检测。
API 说明 Android iOS HarmonyOS Web 微信小程序
share(options) 通用分享 / ×
shareAsync(options) Promise 通用分享 / ×
shareText(options) 文本/链接分享 ×
shareTextAsync(options) Promise 文本分享 ×
shareFile(options) 单文件分享 × ×
shareFileAsync(options) Promise 单文件 × ×
shareImages(options) 多图片分享 × ×
shareImagesAsync(options) Promise 多图片 × ×
requestSharePermission(opts) 申请读取权限 / / / ×
requestSharePermissionAsync(opts) Promise 权限 / / / ×
isShareAppInstalled(opts) 检测目标 App × × × ×

Xview-Sqlite

  • 模块 IDxview-sqlite
  • 类型:UTS 插件
  • 功能说明:五端 SQLite:建表、CRUD、事务、迁移、备份与诊断。
API 说明 Android iOS HarmonyOS Web 微信小程序
openDatabase 打开库
closeDatabase 关闭库
isOpenDatabase 状态 / /
getDatabasePath 路径 / /
cleanupDatabaseConnections() 清理全部连接
executeSql 原始 SQL
selectSql 原始 SQL
executePrepared 参数化 SQL
batch 批处理
transaction 事务
selectRows 结构化查询
insertRow 插入单行
insertRows 批量插入
updateRows 更新
deleteRows 删除
batchCrud 混合批
listTables 表列表 / /
isTableExists 存在检查 / /
createTable 建表
addTableColumns 加列
checkTableFields 字段检查
clearTable 清表
deleteTable 删表
runMigrations 版本迁移
backupDatabase 文件级备份 × ×
restoreDatabase 恢复 × ×
exportDatabase JSON 导出
importDatabase JSON 导入
configureDatabase PRAGMA 配置 / /
inspectDatabase 结构检查
runHealthCheck 健康检查
getCapabilities() 能力矩阵
getDiagnostics 诊断日志
clearDiagnostics 清空诊断

Web/微信小程序为降级存储;backupDatabase/restoreDatabase 请改用 exportDatabase/importDatabase


Xview-Water-Mark

  • 模块 IDxview-watermark
  • 类型:UTS 插件
  • 功能说明:跨平台图片水印,支持 plain/card 布局与 Promise API。
API 说明 Android iOS HarmonyOS Web 微信小程序
xviewWatermark(options) 图片水印(回调)
xviewWatermarkAsync(options) 图片水印(Promise)

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件不采集任何数据

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

暂无用户评论。