Skip to content

U
unidocs-uni-app-x-zh

DCloud / unidocs-uni-app-x-zh

通知 144
Star 2
Fork 33
U
unidocs-uni-app-x-zh
提交 c856a0fb 编写于 作者: D DCloud_LXH
浏览文件
操作

chore: uts json

上级 58b5c55e
显示空白变更内容
内联 并排
Showing with 9 addition and 9 deletion
docs/.vuepress/utils/cssJson.json
浏览文件 @ c856a0fb
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
docs/.vuepress/utils/customTypeJson.json
浏览文件 @ c856a0fb
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
docs/.vuepress/utils/maniFestJson.json
浏览文件 @ c856a0fb
{"manifest":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appid | string | - | - | [DCloud AppID 使用说明](https://ask.dcloud.net.cn/article/35907) |\n| name | string | - | - | 应用名称 |\n| description | string | - | - | 应用描述 |\n| versionName | string | - | - | 应用版本名称 |\n| versionCode | integer | - | - | 应用版本号，必须是整数，取值范围1~2147483647；升级时必须高于上一次设置的值。 |\n| locale | '' | - | - | 默认语言 |\n| fallbackLocale | '' | - | - | 默认回退语言 |\n| uni-app-x | [uni-app-x 配置项列表](#manifest-uni-app-x) | - | - | 存在uni-app-x节点则表示为uni-app x项目 |\n| app | [app 配置项列表](#manifest-app) | - | - | App平台（原生App）配置 |","description":"[配置指南](https://doc.dcloud.net.cn/uni-app-x/collocation/manifest)"},"manifest_uni-app-x":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| flex-direction | 'row' \\| 'row-reverse' \\| 'column' \\| 'column-reverse' | \"column\" | - | uvue页面默认flex排列方向 |","description":"存在uni-app-x节点则表示为uni-app x项目"},"manifest_app":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| defaultAppTheme | 'auto' \\| 'light' \\| 'dark' | \"auto\" | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"4.18\",\"4.18\"]]}' /> | 应用默认主题，可取值 light/dark/auto，默认值为 light。应用主题适配[参考文档](https://doc.dcloud.net.cn/uni-app-x/collocation/themejson.html) |\n| distribute | [distribute 配置项列表](#app-distribute) | - | - | App平台发布配置 |","description":"App平台（原生App）配置"},"app_distribute":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| syncDebug | boolean | - | - | 是否为自定义调试基座 |\n| icons | [icons 配置项列表](#distribute-icons) | - | - | Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。 |\n| splashScreens | [splashScreens 配置项列表](#distribute-splashscreens) | - | - | Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作。 |\n| android | [android 配置项列表](#distribute-android) | - | - | App-Android平台发布配置 |\n| ios | [ios 配置项列表](#distribute-ios) | - | - | IOS配置 |\n| modules | [modules 配置项列表](#distribute-modules) | - | - | app内置模块配置 |","description":"App平台发布配置"},"distribute_icons":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | [android 配置项列表](#icons-android) | - | - | Android图标配置 |\n| ios | [ios 配置项列表](#icons-ios) | - | - | iOS图标配置 |","description":"Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。"},"icons_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| hdpi | string | - | - | 高分屏设备程序图标，分辨率要求72x72 |\n| xhdpi | string | - | - | 720P高分屏设备程序图标，分辨率要求96x96 |\n| xxhdpi | string | - | - | 1080P高分屏设备程序图标，分辨率要求144x144 |\n| xxxhdpi | string | - | - | 2K屏设备程序图标，分辨率要求192x192 |"},"icons_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appstore | string | - | - | iPhone/iPad设备应用图标，分辨率要求 1024x1024 |"},"distribute_splashScreens":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | [android 配置项列表](#splashscreens-android) | - | - | Android平台启动图配置 |\n| android12 | [android12 配置项列表](#splashscreens-android12) | - | - | 适配支持Android12启动界面。无此配置项表示不适配支持Android12启动界面。 |\n| ios | [ios 配置项列表](#splashscreens-ios) | - | - | iOS平台启动界面配置 |","description":"Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作。"},"splashScreens_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| ldpi | string | - | - | 适用于（mdpi）密度屏幕（~120dpi），建议分辨率 240x320。此类设备不常见，通常可以不用配置此项。 |\n| mdpi | string | - | - | 适用于（mdpi）密度屏幕（~160dpi），建议分辨率 320x480。此类设备不常见，通常可以不用配置此项。 |\n| hdpi | string | - | - | 适用于（hdpi）密度屏幕（~240dpi），建议分辨率 480x800。此类设备不常见，通常可以不用配置此项。 |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 720x1280 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 1080x1920 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 2160x3840 |"},"splashScreens_android12":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| background | string | - | - | 仅在Android12及以上设备生效，默认值为白色 |\n| icon | [icon 配置项列表](#android12-icon) | - | - | Android12启动界面中部Logo图标 |\n| brand | [brand 配置项列表](#android12-brand) | - | - | Android12启动界面底部品牌图标 |","description":"适配支持Android12启动界面。无此配置项表示不适配支持Android12启动界面。"},"android12_icon":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 480x480 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 720x720 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 960x960 |"},"android12_brand":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 400x160 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 600x240 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 800x320 |"},"splashScreens_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| storyboard | string | - | - | 用于iOS平台自定义storyboard启动界面，[参考文档](https://doc.dcloud.net.cn/uni-app-x/collocation/manifest-splashscreen.html#ios) |"},"distribute_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| minSdkVersion | integer | 21 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | 应用兼容的最低Android版本（API等级）；[参考文档](https://uniapp.dcloud.io/tutorial/app-android-minsdkversion) |\n| targetSdkVersion | integer | 30 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | 应用适配的目标Android版本（API等级），部分应用市场要求设置较高的targetSdkVersion才能提交审核；[参考文档](https://uniapp.dcloud.io/tutorial/app-android-targetsdkversion) |\n| abiFilters | Array\\<'armeabi-v7a' \\| 'arm64-v8a' \\| 'x86' \\| 'x86_64'> | [\"arm64-v8a\"\\] | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | [参考文档](https://uniapp.dcloud.io/tutorial/app-android-abifilters) |\n| packagingOptions | Array\\<string> | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"4.27\",\"x\"]]}' /> | packagingOptions 配置项[参考文档](https://developer.android.google.cn/reference/tools/gradle-api/7.4/com/android/build/api/dsl/PackagingOptions) |","description":"App-Android平台发布配置"},"distribute_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| devices | 'iphone' \\| 'ipad' \\| 'universal' | \"auto\" | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"x\",\"4.11\"]]}' /> | iOS支持的设备 |"},"distribute_modules":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| uni-ad | [uni-ad 配置项列表](#modules-uni-ad) | - | - | [uni-ad广告联盟](https://uniad.dcloud.net.cn/)模块 |\n| uni-canvas | object | - | - | [canvas画布](https://doc.dcloud.net.cn/uni-app-x/component/canvas.html)组件模块（HBuilderX4.0+） |\n| uni-cloud-client | object | - | - | [uniCloud云函数/云对象](https://doc.dcloud.net.cn/uniCloud/cf-functions.html)模块（HBuilderX4.25+） |\n| uni-createRequestPermissionListener | object | - | - | [监听权限申请](https://doc.dcloud.net.cn/uni-app-x/api/create-request-permission-listener.html)模块（HBuilderX4.0+） |\n| uni-createWebviewContext | object | - | - | 创建[web-view 组件的上下文对象](https://doc.dcloud.net.cn/uni-app-x/api/create-webview-context.html)模块 |\n| uni-facialRecognitionVerify | object | - | - | [uni实人认证](https://doc.dcloud.net.cn/uni-app-x/api/facial-recognition-meta-info.html)模块 |\n| uni-fileSystemManager | object | - | - | [文件管理](https://doc.dcloud.net.cn/uni-app-x/api/get-file-system-manager.html)模块（HBuilderX3.99+） |\n| uni-getLocation | [uni-getLocation 配置项列表](#modules-uni-getlocation) | - | - | [系统定位](https://doc.dcloud.net.cn/uni-app-x/api/get-location.html)模块 |\n| uni-getNetworkType | object | - | - | [获取网络类型](https://doc.dcloud.net.cn/uni-app-x/api/get-network-type.html)模块 |\n| uni-installApk | object | - | - | [安装apk](https://doc.dcloud.net.cn/uni-app-x/api/install-apk.html)模块（HBuilderX3.99+） |\n| uni-payment | [uni-payment 配置项列表](#modules-uni-payment) | - | - | [请求支付](https://doc.dcloud.net.cn/uni-app-x/api/request-payment.html)模块 |\n| uni-getProvider | object | - | - | [获取服务供应商](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html#getprovider)模块 |\n| uni-push | object | - | - | [统一推送](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html#getprovider)模块（HBuilderX3.97+） |\n| uni-media | object | - | - | [多媒体](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块 |\n| uni-network | object | - | - | [网络请求（文件上传/下载）](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块 |\n| uni-virtualPayment | object | - | - | [虚拟支付](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块（HBuilderX4.25+） |\n| uni-video | object | - | - | [video视频组件](https://doc.dcloud.net.cn/uni-app-x/component/video.html)模块（HBuilderX4.25+） |\n| uni-websocket | object | - | - | [WebSocket](https://doc.dcloud.net.cn/uni-app-x/api/websocket.html)模块 |\n| uni-verify | object | - | - | [一键登录](https://doc.dcloud.net.cn/uni-app-x/api/get-univerify-manager.html)模块（HBuilderX3.99+） |","description":"app内置模块配置"},"modules_uni-ad":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| gdt | object | - | - | 腾讯优量汇广告联盟 |\n| gm | object | - | - | 穿山甲GroMore |\n| ks | object | - | - | 快手广告联盟 |\n| sgm | object | - | - | Sigmob广告联盟 |\n| bd | object | - | - | 百度百青藤广告联盟 |","description":"[uni-ad广告联盟](https://uniad.dcloud.net.cn/)模块"},"modules_uni-getLocation":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| system | object | - | - | 系统定位 |\n| tencent | object | - | - | 腾讯定位 |","description":"[系统定位](https://doc.dcloud.net.cn/uni-app-x/api/get-location.html)模块"},"modules_uni-payment":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| alipay | object | - | - | 支付宝支付 |\n| wxpay | [wxpay 配置项列表](#uni-payment-wxpay) | - | - | 微信支付 |","description":"[请求支付](https://doc.dcloud.net.cn/uni-app-x/api/request-payment.html)模块"},"uni-payment_wxpay":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | object | - | - | android平台微信支付配置信息 |\n| ios | [ios 配置项列表](#wxpay-ios) | - | - | ios平台微信支付配置信息 |","description":"微信支付"},"wxpay_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appid | string | - | - | 微信开放平台申请的应用ID（AppID） |\n| universalLink | string | - | - | 通用链接（Universal Link），配置方式参考：[iOS通用链接](https://uniapp.dcloud.net.cn/tutorial/app-ios-capabilities.html#%E9%80%9A%E7%94%A8%E9%93%BE%E6%8E%A5-universal-link) |","description":"ios平台微信支付配置信息"},"tutorial":"## 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=collocation.manifest_json)"}
\ No newline at end of file
{"manifest":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appid | string | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | [DCloud AppID 使用说明](https://ask.dcloud.net.cn/article/35907) |\n| name | string | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 应用名称 |\n| description | string | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 应用描述 |\n| versionName | string | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 应用版本名称 |\n| versionCode | integer | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 应用版本号，必须是整数，取值范围1~2147483647；升级时必须高于上一次设置的值。 |\n| uni-app-x | [uni-app-x 配置项列表](#manifest-uni-app-x) | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 存在uni-app-x节点则表示为uni-app x项目 |\n| app | [app 配置项列表](#manifest-app) | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.11\"]]}' /> | App平台（原生App）配置 |","description":"[配置指南](https://doc.dcloud.net.cn/uni-app-x/collocation/manifest)"},"manifest_uni-app-x":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| flex-direction | 'row' \\| 'row-reverse' \\| 'column' \\| 'column-reverse' | \"column\" | - | uvue页面默认flex排列方向 |","description":"存在uni-app-x节点则表示为uni-app x项目"},"manifest_app":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| defaultAppTheme | 'auto' \\| 'light' \\| 'dark' | \"auto\" | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"4.18\",\"4.18\"]]}' /> | 应用默认主题，可取值 light/dark/auto，默认值为 light。应用主题适配[参考文档](https://doc.dcloud.net.cn/uni-app-x/collocation/themejson.html) |\n| distribute | [distribute 配置项列表](#app-distribute) | - | - | App平台发布配置 |","description":"App平台（原生App）配置"},"app_distribute":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| syncDebug | boolean | - | - | 是否为自定义调试基座 |\n| icons | [icons 配置项列表](#distribute-icons) | - | - | Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。 |\n| splashScreens | [splashScreens 配置项列表](#distribute-splashscreens) | - | - | Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作。 |\n| android | [android 配置项列表](#distribute-android) | - | - | App-Android平台发布配置 |\n| ios | [ios 配置项列表](#distribute-ios) | - | - | IOS配置 |\n| modules | [modules 配置项列表](#distribute-modules) | - | - | app内置模块配置 |","description":"App平台发布配置"},"distribute_icons":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | [android 配置项列表](#icons-android) | - | - | Android图标配置 |\n| ios | [ios 配置项列表](#icons-ios) | - | - | iOS图标配置 |","description":"Android、iOS平台应用图标配置。云打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作，不推荐手动在源码视图中修改。"},"icons_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| hdpi | string | - | - | 高分屏设备程序图标，分辨率要求72x72 |\n| xhdpi | string | - | - | 720P高分屏设备程序图标，分辨率要求96x96 |\n| xxhdpi | string | - | - | 1080P高分屏设备程序图标，分辨率要求144x144 |\n| xxxhdpi | string | - | - | 2K屏设备程序图标，分辨率要求192x192 |"},"icons_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appstore | string | - | - | iPhone/iPad设备应用图标，分辨率要求 1024x1024 |"},"distribute_splashScreens":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | [android 配置项列表](#splashscreens-android) | - | - | Android平台启动图配置 |\n| android12 | [android12 配置项列表](#splashscreens-android12) | - | - | 适配支持Android12启动界面。无此配置项表示不适配支持Android12启动界面。 |\n| ios | [ios 配置项列表](#splashscreens-ios) | - | - | iOS平台启动界面配置 |","description":"Android、iOS平台应用启动界面配置。云端打包后生效，建议在HBuilderX中 manifest.json 的可视化界面操作。"},"splashScreens_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| ldpi | string | - | - | 适用于（mdpi）密度屏幕（~120dpi），建议分辨率 240x320。此类设备不常见，通常可以不用配置此项。 |\n| mdpi | string | - | - | 适用于（mdpi）密度屏幕（~160dpi），建议分辨率 320x480。此类设备不常见，通常可以不用配置此项。 |\n| hdpi | string | - | - | 适用于（hdpi）密度屏幕（~240dpi），建议分辨率 480x800。此类设备不常见，通常可以不用配置此项。 |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 720x1280 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 1080x1920 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 2160x3840 |"},"splashScreens_android12":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| background | string | - | - | 仅在Android12及以上设备生效，默认值为白色 |\n| icon | [icon 配置项列表](#android12-icon) | - | - | Android12启动界面中部Logo图标 |\n| brand | [brand 配置项列表](#android12-brand) | - | - | Android12启动界面底部品牌图标 |","description":"适配支持Android12启动界面。无此配置项表示不适配支持Android12启动界面。"},"android12_icon":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 480x480 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 720x720 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 960x960 |"},"android12_brand":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| xhdpi | string | - | - | 适用于（xhdpi）密度屏幕（~320dpi），建议分辨率 400x160 |\n| xxhdpi | string | - | - | 适用于（xxhdpi）密度屏幕（~480dpi），建议分辨率 600x240 |\n| xxxhdpi | string | - | - | 适用于（xxxhdpi）密度屏幕（~640dpi），建议分辨率 800x320 |"},"splashScreens_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| storyboard | string | - | - | 用于iOS平台自定义storyboard启动界面，[参考文档](https://doc.dcloud.net.cn/uni-app-x/collocation/manifest-splashscreen.html#ios) |"},"distribute_android":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| minSdkVersion | integer | 21 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | 应用兼容的最低Android版本（API等级）；[参考文档](https://uniapp.dcloud.io/tutorial/app-android-minsdkversion) |\n| targetSdkVersion | integer | 30 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | 应用适配的目标Android版本（API等级），部分应用市场要求设置较高的targetSdkVersion才能提交审核；[参考文档](https://uniapp.dcloud.io/tutorial/app-android-targetsdkversion) |\n| abiFilters | Array\\<'armeabi-v7a' \\| 'arm64-v8a' \\| 'x86' \\| 'x86_64'> | [\"arm64-v8a\"\\] | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"3.9\",\"x\"]]}' /> | [参考文档](https://uniapp.dcloud.io/tutorial/app-android-abifilters) |\n| packagingOptions | Array\\<string> | - | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"4.27\",\"x\"]]}' /> | packagingOptions 配置项[参考文档](https://developer.android.google.cn/reference/tools/gradle-api/7.4/com/android/build/api/dsl/PackagingOptions) |","description":"App-Android平台发布配置"},"distribute_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| devices | 'iphone' \\| 'ipad' \\| 'universal' | \"auto\" | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"-\",\"x\",\"4.11\"]]}' /> | iOS支持的设备 |"},"distribute_modules":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| uni-ad | [uni-ad 配置项列表](#modules-uni-ad) | - | - | [uni-ad广告联盟](https://uniad.dcloud.net.cn/)模块 |\n| uni-canvas | object | - | - | [canvas画布](https://doc.dcloud.net.cn/uni-app-x/component/canvas.html)组件模块（HBuilderX4.0+） |\n| uni-cloud-client | object | - | - | [uniCloud云函数/云对象](https://doc.dcloud.net.cn/uniCloud/cf-functions.html)模块（HBuilderX4.25+） |\n| uni-createRequestPermissionListener | object | - | - | [监听权限申请](https://doc.dcloud.net.cn/uni-app-x/api/create-request-permission-listener.html)模块（HBuilderX4.0+） |\n| uni-createWebviewContext | object | - | - | 创建[web-view 组件的上下文对象](https://doc.dcloud.net.cn/uni-app-x/api/create-webview-context.html)模块 |\n| uni-facialRecognitionVerify | object | - | - | [uni实人认证](https://doc.dcloud.net.cn/uni-app-x/api/facial-recognition-meta-info.html)模块 |\n| uni-fileSystemManager | object | - | - | [文件管理](https://doc.dcloud.net.cn/uni-app-x/api/get-file-system-manager.html)模块（HBuilderX3.99+） |\n| uni-getLocation | [uni-getLocation 配置项列表](#modules-uni-getlocation) | - | - | [系统定位](https://doc.dcloud.net.cn/uni-app-x/api/get-location.html)模块 |\n| uni-getNetworkType | object | - | - | [获取网络类型](https://doc.dcloud.net.cn/uni-app-x/api/get-network-type.html)模块 |\n| uni-installApk | object | - | - | [安装apk](https://doc.dcloud.net.cn/uni-app-x/api/install-apk.html)模块（HBuilderX3.99+） |\n| uni-payment | [uni-payment 配置项列表](#modules-uni-payment) | - | - | [请求支付](https://doc.dcloud.net.cn/uni-app-x/api/request-payment.html)模块 |\n| uni-getProvider | object | - | - | [获取服务供应商](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html#getprovider)模块 |\n| uni-push | object | - | - | [统一推送](https://doc.dcloud.net.cn/uni-app-x/api/get-provider.html#getprovider)模块（HBuilderX3.97+） |\n| uni-media | object | - | - | [多媒体](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块 |\n| uni-network | object | - | - | [网络请求（文件上传/下载）](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块 |\n| uni-virtualPayment | object | - | - | [虚拟支付](https://doc.dcloud.net.cn/uni-app-x/api/choose-image.html)模块（HBuilderX4.25+） |\n| uni-video | object | - | - | [video视频组件](https://doc.dcloud.net.cn/uni-app-x/component/video.html)模块（HBuilderX4.25+） |\n| uni-websocket | object | - | - | [WebSocket](https://doc.dcloud.net.cn/uni-app-x/api/websocket.html)模块 |\n| uni-verify | object | - | - | [一键登录](https://doc.dcloud.net.cn/uni-app-x/api/get-univerify-manager.html)模块（HBuilderX3.99+） |","description":"app内置模块配置"},"modules_uni-ad":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| gdt | object | - | - | 腾讯优量汇广告联盟 |\n| gm | object | - | - | 穿山甲GroMore |\n| ks | object | - | - | 快手广告联盟 |\n| sgm | object | - | - | Sigmob广告联盟 |\n| bd | object | - | - | 百度百青藤广告联盟 |","description":"[uni-ad广告联盟](https://uniad.dcloud.net.cn/)模块"},"modules_uni-getLocation":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| system | object | - | - | 系统定位 |\n| tencent | object | - | - | 腾讯定位 |","description":"[系统定位](https://doc.dcloud.net.cn/uni-app-x/api/get-location.html)模块"},"modules_uni-payment":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| alipay | object | - | - | 支付宝支付 |\n| wxpay | [wxpay 配置项列表](#uni-payment-wxpay) | - | - | 微信支付 |","description":"[请求支付](https://doc.dcloud.net.cn/uni-app-x/api/request-payment.html)模块"},"uni-payment_wxpay":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| android | object | - | - | android平台微信支付配置信息 |\n| ios | [ios 配置项列表](#wxpay-ios) | - | - | ios平台微信支付配置信息 |","description":"微信支付"},"wxpay_ios":{"table":"| 属性 | 类型 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- |\n| appid | string | - | - | 微信开放平台申请的应用ID（AppID） |\n| universalLink | string | - | - | 通用链接（Universal Link），配置方式参考：[iOS通用链接](https://uniapp.dcloud.net.cn/tutorial/app-ios-capabilities.html#%E9%80%9A%E7%94%A8%E9%93%BE%E6%8E%A5-universal-link) |","description":"ios平台微信支付配置信息"},"tutorial":"## 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=collocation.manifest_json)"}
\ No newline at end of file
docs/.vuepress/utils/pagesJson.json
浏览文件 @ c856a0fb
{"pages":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| globalStyle | [globalStyle 配置项列表](#pages-globalstyle) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 默认页面的窗口表现 |\n| pages | Array\\<[PagesOptionsPage](#pagesoptionspage)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 页面路径及窗口表现 |\n| tabBar | [tabBar 配置项列表](#pages-tabbar) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 底部 tab 的表现 |\n| topWindow | [topWindow 配置项列表](#pages-topwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 上窗体 |\n| leftWindow | [leftWindow 配置项列表](#pages-leftwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 左窗体 |\n| rightWindow | [rightWindow 配置项列表](#pages-rightwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 右窗体 |\n| condition | [condition 配置项列表](#pages-condition) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式 |\n| easycom | [easycom 配置项列表](#pages-easycom) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 组件自动引入规则 |\n| uniIdRouter | [uniIdRouter 配置项列表](#pages-uniidrouter) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：[详见](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router) |"},"pages_globalStyle":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| navigationBarBackgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | `app`: #F8F8F8<br/>`web`: #F8F8F8<br/>`mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd`: #000000<br/>`mp-alipay、mp-kuaishou`: #ffffff | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏背景颜色（同状态栏背景色） |\n| navigationBarTextStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题颜色，仅支持 black/white（支付宝小程序不支持，请使用 [my.setNavigationBar](https://opendocs.alipay.com/mini/api/xwq8e6)）。 |\n| navigationBarTitleText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题文字内容 |\n| navigationStyle | 'default' \\| 'custom' | \"default\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看[使用注意](https://uniapp.dcloud.net.cn/collocation/pages.html#customnav)。 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.99\",\"x\"]]}' /> | 下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果） |\n| backgroundColorContent | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.11\",\"4.0\",\"4.11\"]]}' /> | 页面容器背景色 |\n| backgroundTextStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"dark\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"4.31\"]]}' /> | 下拉 loading 的样式，仅支持 dark / light |\n| enablePullDownRefresh | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启下拉刷新，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| onReachBottomDistance | number | 50 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 页面上拉触底事件触发时距页面底部距离，单位只支持px，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| titleImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址 |\n| transparentTitle | 'always' \\| 'auto' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明 |\n| titlePenetrate | 'YES' \\| 'NO' | \"NO\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏点击穿透 |\n| pageOrientation | 'auto' \\| 'portrait' \\| 'landscape' | \"portrait\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.13\",\"4.25\"]]}' /> | 横屏配置，屏幕旋转设置，仅支持 auto / portrait / landscape 详见 [响应显示区域变化](https://uniapp.dcloud.net.cn/collocation/pages.htmld#globalstyle)。 |\n| animationType | 'slide-in-right' \\| 'slide-in-left' \\| 'slide-in-top' \\| 'slide-in-bottom' \\| 'fade-in' \\| 'zoom-out' \\| 'zoom-fade-out' \\| 'pop-in' | \"pop-in\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.18\",\"x\"]]}' /> | 窗口显示的动画效果，详见：[窗口动画](https://uniapp.dcloud.net.cn/api/router.html#animation)。 |\n| usingComponents | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 引用小程序组件，参考 [小程序组件](https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html)。 |\n| leftWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 leftWindow时，默认是否显示 leftWindow |\n| topWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 topWindow时，默认是否显示 topWindow |\n| rightWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 rightWindow时，默认是否显示 rightWindow |\n| rpxCalcMaxDeviceWidth | number | 960 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算所支持的最大设备宽度，单位 px |\n| rpxCalcBaseDeviceWidth | number | 375 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算使用的基准设备宽度，设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算，单位 px |\n| rpxCalcIncludeWidth | number | 750 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算特殊处理的值，始终按实际的设备宽度计算，单位 rpx |\n| maxWidth | number | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选) |\n| h5 | [h5 配置项列表](#globalstyle-h5) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | H5 特有配置 |","description":"默认页面的窗口表现"},"globalStyle_h5":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| titleNView | [titleNView 配置项列表](#h5-titlenview) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏设置 |\n| pullToRefresh | [pullToRefresh 配置项列表](#h5-pulltorefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新 |","description":"H5 特有配置"},"h5_titleNView":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#f7f7f7\" | 否 | - | 背景颜色，颜色值格式为\"#RRGGBB\"。 |\n| buttons | array | - | 否 | - | 自定义按钮，参考 [buttons](https://uniapp.dcloud.net.cn/collocation/pages.html?id=h5-titlenview-buttons)。 |\n| titleColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#000000\" | 否 | - | 标题文字颜色 |\n| titleText | string | - | 否 | - | 标题文字内容 |\n| titleSize | string | - | 否 | - | 标题文字字体大小 |\n| type | 'defaultValue' \\| 'transparent' | \"defaultValue\" | 否 | - | 导航栏样式。\"default\"-默认样式；\"transparent\"-透明渐变。 |\n| searchInput | object | - | 否 | - | 导航栏上的搜索框样式，详见：[searchInput](https://uniapp.dcloud.net.cn/collocation/pages.html?id=h5-searchinput)。 |","description":"导航栏设置"},"h5_pullToRefresh":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| support | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 是否开启窗口的下拉刷新功能 |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 颜色值格式为\"#RRGGBB\"，仅\"circle\"样式下拉刷新支持此属性。 |\n| type | 'defaultValue' \\| 'circle' | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件样式 |\n| height | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 窗口的下拉刷新控件进入刷新状态的拉拽高度。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| range | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 窗口可下拉拖拽的范围。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| offset | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件的起始位置。仅对\"circle\"样式下拉刷新控件有效，用于定义刷新控件下拉时的起始位置。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| contentdown | [contentdown 配置项列表](#pulltorefresh-contentdown) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在下拉可刷新状态时下拉刷新控件显示的内容 |\n| contentover | [contentover 配置项列表](#pulltorefresh-contentover) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在释放可刷新状态时下拉刷新控件显示的内容 |\n| contentrefresh | [contentrefresh 配置项列表](#pulltorefresh-contentrefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在正在刷新状态时下拉刷新控件显示的内容 |","description":"下拉刷新"},"pullToRefresh_contentdown":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在下拉可刷新状态时下拉刷新控件显示的内容"},"pullToRefresh_contentover":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在释放可刷新状态时下拉刷新控件显示的内容"},"pullToRefresh_contentrefresh":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在正在刷新状态时下拉刷新控件显示的内容"},"PagesOptionsPage":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 配置页面路径 |\n| style | [style 配置项列表](#pagesoptionspage-style) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)。 |\n| needLogin | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 是否需要登录才可访问 |"},"PagesOptionsPage_style":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| navigationBarBackgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | `app`: #F8F8F8<br/>`web`: #F8F8F8<br/>`mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd`: #000000<br/>`mp-alipay、mp-kuaishou`: #ffffff | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏背景颜色（同状态栏背景色） |\n| navigationBarTextStyle | 'white' \\| 'black' | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题颜色，仅支持 black/white |\n| navigationBarTitleText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题文字内容 |\n| navigationBarShadow | [navigationBarShadow 配置项列表](#style-navigationbarshadow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏阴影，配置参考下方 [导航栏阴影](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style) |\n| navigationStyle | 'default' \\| 'custom' | \"default\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看[使用注意](https://uniapp.dcloud.net.cn/collocation/pages.html#customnav)。 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.99\",\"4.11\"]]}' /> | 下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果） |\n| backgroundColorContent | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.11\",\"4.0\",\"4.11\"]]}' /> | 页面容器背景色 |\n| backgroundTextStyle | 'dark' \\| 'light' | \"dark\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"4.31\"]]}' /> | 下拉 loading 的样式，仅支持 dark/light |\n| enablePullDownRefresh | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启下拉刷新，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| onReachBottomDistance | number | 50 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 页面上拉触底事件触发时距页面底部距离，单位只支持px，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| pageOrientation | 'auto' \\| 'portrait' \\| 'landscape' | \"portrait\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.13\",\"4.25\"]]}' /> | 页面旋转设置，支持 auto 设备自适应 / portrait 竖向 / landscape 横向 |\n| disableSwipeBack | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"x\",\"4.18\"]]}' /> | 是否禁用右滑手势关闭页面 |\n| titleImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址 |\n| transparentTitle | 'always' \\| 'auto' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明 |\n| titlePenetrate | 'YES' \\| 'NO' | \"NO\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏点击穿透 |\n| h5 | [h5 配置项列表](#style-h5) | - | 否 | - | 编译到 H5 平台的特定样式 |\n| usingComponents | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 引用小程序组件，参考 [小程序组件https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html#小程序自定义组件支持)。 |\n| leftWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 leftWindow时，当前页面是否显示 leftWindow |\n| topWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 topWindow时，当前页面是否显示 topWindow |\n| rightWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 rightWindow时，当前页面是否显示 rightWindow |\n| maxWidth | number | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选) |","description":"配置页面窗口表现，配置项参考下方 [pageStyle](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)。"},"style_navigationBarShadow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| colorType | 'grey' \\| 'blue' \\| 'green' \\| 'orange' \\| 'red' \\| 'yellow' | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 阴影的颜色，支持：grey、blue、green、orange、red、yellow |","description":"导航栏阴影，配置参考下方 [导航栏阴影](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)"},"style_h5":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| titleNView | [titleNView 配置项列表](#h5-titlenview) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏设置 |\n| pullToRefresh | [pullToRefresh 配置项列表](#h5-pulltorefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新 |","description":"编译到 H5 平台的特定样式"},"pages_tabBar":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上的文字默认颜色 |\n| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上的文字选中时的颜色 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 的背景色 |\n| borderStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"4.0\",\"4.11\"]]}' /> | tabbar 上边框的颜色，可选值 black、white，black对应颜色rgba(0,0,0,0.33)，white对应颜色rgba(255,255,255,0.33)。 |\n| blurEffect | 'dark' \\| 'extralight' \\| 'light' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | IOS 高斯模糊效果，可选值 dark/extralight/light/none（参考:[使用说明](https://uniapp.dcloud.net.cn//tutorial/app-blureffect.html)） |\n| list | Array\\<[PagesOptionsTabbarList](#pagesoptionstabbarlist)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 的列表，详见 list 属性说明，最少2个、最多5个 tab |\n| fontSize | string | \"10px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 文字默认大小 |\n| iconWidth | string | \"24px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 图标默认宽度（高度等比例缩放） |\n| spacing | string | \"3px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 图标和文字的间距 |\n| height | string | \"50px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | tabBar 默认高度 |\n| midButton | [midButton 配置项列表](#tabbar-midbutton) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮 仅在 list 项为偶数时有效 |\n| iconfontSrc | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | list设置 iconfont 属性时，需要指定字体文件路径 |\n| backgroundImage | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | 设置背景图片，优先级高于 backgroundColor |\n| backgroundRepeat | 'repeat' \\| 'repeat-x' \\| 'repeat-y' \\| 'no-repeat' | \"no-repeat\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | 设置标题栏的背景图平铺方式 |\n| redDotColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | tabbar上红点颜色 |","description":"底部 tab 的表现"},"PagesOptionsTabbarList":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| iconfont | [iconfont 配置项列表](#pagesoptionstabbarlist-iconfont) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标，优先级高于 iconPath |\n| pagePath | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 页面路径，必须在 pages 中先定义 |\n| text | string | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上按钮文字，在 App 和 H5 平台为非必填。例如中间可放一个没有文字的+号图标 |\n| iconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标 |\n| selectedIconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 position 为 top 时，此参数无效 |\n| visible | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 该项是否显示，默认显示 |"},"PagesOptionsTabbarList_iconfont":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| text | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字库 Unicode 码 |\n| selectedText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 选中后字库 Unicode 码 |\n| fontSize | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标字号(px) |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标颜色 |\n| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标选中颜色 |","description":"字体图标，优先级高于 iconPath"},"tabBar_midButton":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| width | string | \"80px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度 |\n| height | string | \"80px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果 |\n| text | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的文字 |\n| iconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的图片路径 |\n| iconWidth | string | \"24px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 图标默认宽度（高度等比例缩放） |\n| backgroundImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的背景图片路径 |","description":"中间按钮 仅在 list 项为偶数时有效"},"pages_topWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#topwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"上窗体"},"topWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_leftWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#leftwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"左窗体"},"leftWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_rightWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#rightwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"右窗体"},"rightWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_condition":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| current | number | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 当前激活的模式，list节点的索引值。 |\n| list | Array\\<[PagesConditionItem](#pagesconditionitem)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式列表 |","description":"启动模式"},"PagesConditionItem":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| name | string | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式名称 |\n| path | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动页面路径 |\n| query | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动参数，可在页面的 onLoad 函数里获得 |"},"pages_easycom":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| autoscan | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启自动扫描，开启后将会自动扫描符合components/组件名称/组件名称.vue/uvue目录结构的组件 |\n| custom | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 以正则方式自定义组件匹配规则。如果autoscan不能满足需求，可以使用custom自定义匹配规则 |","description":"组件自动引入规则"},"pages_uniIdRouter":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| loginPage | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 登录页面路径 |\n| resToLogin | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 是否开启自动根据响应体判断跳转登录页面，默认true（开启） |\n| needLogin | Array\\<string,[string.PageURIString](/uts/data-type.md#ide-string)> | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | - |","description":"根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：[详见](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router)"},"tutorial":"## 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=collocation.pages_json)"}
\ No newline at end of file
{"pages":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| globalStyle | [globalStyle 配置项列表](#pages-globalstyle) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 默认页面的窗口表现 |\n| pages | Array\\<[PagesOptionsPage](#pagesoptionspage)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 页面路径及窗口表现 |\n| tabBar | [tabBar 配置项列表](#pages-tabbar) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 底部 tab 的表现 |\n| topWindow | [topWindow 配置项列表](#pages-topwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 上窗体 |\n| leftWindow | [leftWindow 配置项列表](#pages-leftwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 左窗体 |\n| rightWindow | [rightWindow 配置项列表](#pages-rightwindow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 右窗体 |\n| condition | [condition 配置项列表](#pages-condition) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式 |\n| easycom | [easycom 配置项列表](#pages-easycom) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 组件自动引入规则 |\n| uniIdRouter | [uniIdRouter 配置项列表](#pages-uniidrouter) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：[详见](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router) |"},"pages_globalStyle":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| navigationBarBackgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | `app`: #F8F8F8<br/>`web`: #F8F8F8<br/>`mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd`: #000000<br/>`mp-alipay、mp-kuaishou`: #ffffff | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏背景颜色（同状态栏背景色） |\n| navigationBarTextStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题颜色，仅支持 black/white（支付宝小程序不支持，请使用 [my.setNavigationBar](https://opendocs.alipay.com/mini/api/xwq8e6)）。 |\n| navigationBarTitleText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题文字内容 |\n| navigationStyle | 'default' \\| 'custom' | \"default\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看[使用注意](https://uniapp.dcloud.net.cn/collocation/pages.html#customnav)。 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.99\",\"x\"]]}' /> | 下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果） |\n| backgroundColorContent | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.11\",\"4.0\",\"4.11\"]]}' /> | 页面容器背景色 |\n| backgroundTextStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"dark\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"4.31\"]]}' /> | 下拉 loading 的样式，仅支持 dark / light |\n| enablePullDownRefresh | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启下拉刷新，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| onReachBottomDistance | number | 50 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 页面上拉触底事件触发时距页面底部距离，单位只支持px，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| titleImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址 |\n| transparentTitle | 'always' \\| 'auto' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明 |\n| titlePenetrate | 'YES' \\| 'NO' | \"NO\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏点击穿透 |\n| pageOrientation | 'auto' \\| 'portrait' \\| 'landscape' | \"portrait\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.13\",\"4.25\"]]}' /> | 横屏配置，屏幕旋转设置，仅支持 auto / portrait / landscape 详见 [响应显示区域变化](https://uniapp.dcloud.net.cn/collocation/pages.html#globalstyle)。 |\n| showStatusBar | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"x\"]]}' /> | 是否显示系统顶部状态栏 |\n| showBottomNavigationIndicator | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"x\"]]}' /> | 是否显示系统底部导航栏 |\n| animationType | 'slide-in-right' \\| 'slide-in-left' \\| 'slide-in-top' \\| 'slide-in-bottom' \\| 'fade-in' \\| 'zoom-out' \\| 'zoom-fade-out' \\| 'pop-in' | \"pop-in\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.18\",\"x\"]]}' /> | 窗口显示的动画效果，详见：[窗口动画](https://uniapp.dcloud.net.cn/api/router.html#animation)。 |\n| usingComponents | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 引用小程序组件，参考 [小程序组件](https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html)。 |\n| leftWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 leftWindow时，默认是否显示 leftWindow |\n| topWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 topWindow时，默认是否显示 topWindow |\n| rightWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 rightWindow时，默认是否显示 rightWindow |\n| rpxCalcMaxDeviceWidth | number | 960 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算所支持的最大设备宽度，单位 px |\n| rpxCalcBaseDeviceWidth | number | 375 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算使用的基准设备宽度，设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算，单位 px |\n| rpxCalcIncludeWidth | number | 750 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | rpx 计算特殊处理的值，始终按实际的设备宽度计算，单位 rpx |\n| maxWidth | number | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选) |\n| h5 | [h5 配置项列表](#globalstyle-h5) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | H5 特有配置 |","description":"默认页面的窗口表现"},"globalStyle_h5":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| titleNView | [titleNView 配置项列表](#h5-titlenview) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏设置 |\n| pullToRefresh | [pullToRefresh 配置项列表](#h5-pulltorefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新 |","description":"H5 特有配置"},"h5_titleNView":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#f7f7f7\" | 否 | - | 背景颜色，颜色值格式为\"#RRGGBB\"。 |\n| buttons | array | - | 否 | - | 自定义按钮，参考 [buttons](https://uniapp.dcloud.net.cn/collocation/pages.html?id=h5-titlenview-buttons)。 |\n| titleColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#000000\" | 否 | - | 标题文字颜色 |\n| titleText | string | - | 否 | - | 标题文字内容 |\n| titleSize | string | - | 否 | - | 标题文字字体大小 |\n| type | 'defaultValue' \\| 'transparent' | \"defaultValue\" | 否 | - | 导航栏样式。\"default\"-默认样式；\"transparent\"-透明渐变。 |\n| searchInput | object | - | 否 | - | 导航栏上的搜索框样式，详见：[searchInput](https://uniapp.dcloud.net.cn/collocation/pages.html?id=h5-searchinput)。 |","description":"导航栏设置"},"h5_pullToRefresh":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| support | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 是否开启窗口的下拉刷新功能 |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 颜色值格式为\"#RRGGBB\"，仅\"circle\"样式下拉刷新支持此属性。 |\n| type | 'defaultValue' \\| 'circle' | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件样式 |\n| height | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 窗口的下拉刷新控件进入刷新状态的拉拽高度。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| range | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 窗口可下拉拖拽的范围。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| offset | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件的起始位置。仅对\"circle\"样式下拉刷新控件有效，用于定义刷新控件下拉时的起始位置。支持百分比，如\"10%\"；像素值，如\"50px\"。 |\n| contentdown | [contentdown 配置项列表](#pulltorefresh-contentdown) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在下拉可刷新状态时下拉刷新控件显示的内容 |\n| contentover | [contentover 配置项列表](#pulltorefresh-contentover) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在释放可刷新状态时下拉刷新控件显示的内容 |\n| contentrefresh | [contentrefresh 配置项列表](#pulltorefresh-contentrefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 在正在刷新状态时下拉刷新控件显示的内容 |","description":"下拉刷新"},"pullToRefresh_contentdown":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在下拉可刷新状态时下拉刷新控件显示的内容"},"pullToRefresh_contentover":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在释放可刷新状态时下拉刷新控件显示的内容"},"pullToRefresh_contentrefresh":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| caption | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新控件上显示的标题内容 |","description":"在正在刷新状态时下拉刷新控件显示的内容"},"PagesOptionsPage":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 配置页面路径 |\n| style | [style 配置项列表](#pagesoptionspage-style) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)。 |\n| needLogin | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 是否需要登录才可访问 |"},"PagesOptionsPage_style":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| navigationBarBackgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | `app`: #F8F8F8<br/>`web`: #F8F8F8<br/>`mp-weixin、mp-qq、mp-baidu、mp-toutiao、mp-lark、mp-jd`: #000000<br/>`mp-alipay、mp-kuaishou`: #ffffff | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏背景颜色（同状态栏背景色） |\n| navigationBarTextStyle | 'white' \\| 'black' | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题颜色，仅支持 black/white |\n| navigationBarTitleText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏标题文字内容 |\n| navigationBarShadow | [navigationBarShadow 配置项列表](#style-navigationbarshadow) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏阴影，配置参考下方 [导航栏阴影](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style) |\n| navigationStyle | 'default' \\| 'custom' | \"default\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看[使用注意](https://uniapp.dcloud.net.cn/collocation/pages.html#customnav)。 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.99\",\"4.11\"]]}' /> | 下拉刷新显示出来的窗口的背景色（无下拉刷新时，此颜色无效果） |\n| backgroundColorContent | string ([string.ColorString](/uts/data-type.md#ide-string)) | \"#ffffff\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.11\",\"4.0\",\"4.11\"]]}' /> | 页面容器背景色 |\n| backgroundTextStyle | 'dark' \\| 'light' | \"dark\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"4.31\"]]}' /> | 下拉 loading 的样式，仅支持 dark/light |\n| enablePullDownRefresh | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启下拉刷新，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| onReachBottomDistance | number | 50 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 页面上拉触底事件触发时距页面底部距离，单位只支持px，详见[页面生命周期](https://doc.dcloud.net.cn/uni-app-x/page.html)。 |\n| pageOrientation | 'auto' \\| 'portrait' \\| 'landscape' | \"portrait\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.13\",\"4.25\"]]}' /> | 页面旋转设置，支持 auto 设备自适应 / portrait 竖向 / landscape 横向 |\n| showStatusBar | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"x\"]]}' /> | 是否显示系统顶部状态栏 |\n| showBottomNavigationIndicator | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"4.31\",\"x\"]]}' /> | 是否显示系统底部导航栏 |\n| disableSwipeBack | boolean | false | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"x\",\"4.18\"]]}' /> | 是否禁用右滑手势关闭页面 |\n| titleImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址 |\n| transparentTitle | 'always' \\| 'auto' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明 |\n| titlePenetrate | 'YES' \\| 'NO' | \"NO\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏点击穿透 |\n| h5 | [h5 配置项列表](#style-h5) | - | 否 | - | 编译到 H5 平台的特定样式 |\n| usingComponents | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 引用小程序组件，参考 [小程序组件https://uniapp.dcloud.net.cn/tutorial/miniprogram-subject.html#小程序自定义组件支持)。 |\n| leftWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 leftWindow时，当前页面是否显示 leftWindow |\n| topWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 topWindow时，当前页面是否显示 topWindow |\n| rightWindow | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当存在 rightWindow时，当前页面是否显示 rightWindow |\n| maxWidth | number | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选) |","description":"配置页面窗口表现，配置项参考下方 [pageStyle](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)。"},"style_navigationBarShadow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| colorType | 'grey' \\| 'blue' \\| 'green' \\| 'orange' \\| 'red' \\| 'yellow' | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 阴影的颜色，支持：grey、blue、green、orange、red、yellow |","description":"导航栏阴影，配置参考下方 [导航栏阴影](https://doc.dcloud.net.cn/uni-app-x/collocation/pagesjson.html#pagesoptionspage-style)"},"style_h5":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| titleNView | [titleNView 配置项列表](#h5-titlenview) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 导航栏设置 |\n| pullToRefresh | [pullToRefresh 配置项列表](#h5-pulltorefresh) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 下拉刷新 |","description":"编译到 H5 平台的特定样式"},"pages_tabBar":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上的文字默认颜色 |\n| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上的文字选中时的颜色 |\n| backgroundColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 的背景色 |\n| borderStyle | string ([string.ThemeJsonString](/uts/data-type.md#ide-string)) | \"black\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"4.0\",\"4.11\"]]}' /> | tabbar 上边框的颜色，可选值 black、white，black对应颜色rgba(0,0,0,0.33)，white对应颜色rgba(255,255,255,0.33)。 |\n| blurEffect | 'dark' \\| 'extralight' \\| 'light' \\| 'none' | \"none\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | IOS 高斯模糊效果，可选值 dark/extralight/light/none（参考:[使用说明](https://uniapp.dcloud.net.cn//tutorial/app-blureffect.html)） |\n| list | Array\\<[PagesOptionsTabbarList](#pagesoptionstabbarlist)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 的列表，详见 list 属性说明，最少2个、最多5个 tab |\n| fontSize | string | \"10px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 文字默认大小 |\n| iconWidth | string | \"24px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 图标默认宽度（高度等比例缩放） |\n| spacing | string | \"3px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 图标和文字的间距 |\n| height | string | \"50px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | tabBar 默认高度 |\n| midButton | [midButton 配置项列表](#tabbar-midbutton) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮 仅在 list 项为偶数时有效 |\n| iconfontSrc | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | list设置 iconfont 属性时，需要指定字体文件路径 |\n| backgroundImage | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | 设置背景图片，优先级高于 backgroundColor |\n| backgroundRepeat | 'repeat' \\| 'repeat-x' \\| 'repeat-y' \\| 'no-repeat' | \"no-repeat\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | 设置标题栏的背景图平铺方式 |\n| redDotColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"x\",\"3.9\",\"4.18\"]]}' /> | tabbar上红点颜色 |","description":"底部 tab 的表现"},"PagesOptionsTabbarList":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| iconfont | [iconfont 配置项列表](#pagesoptionstabbarlist-iconfont) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标，优先级高于 iconPath |\n| pagePath | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 页面路径，必须在 pages 中先定义 |\n| text | string | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | tab 上按钮文字，在 App 和 H5 平台为非必填。例如中间可放一个没有文字的+号图标 |\n| iconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px，当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标 |\n| selectedIconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 position 为 top 时，此参数无效 |\n| visible | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 该项是否显示，默认显示 |"},"PagesOptionsTabbarList_iconfont":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| text | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字库 Unicode 码 |\n| selectedText | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 选中后字库 Unicode 码 |\n| fontSize | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标字号(px) |\n| color | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标颜色 |\n| selectedColor | string ([string.ColorString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.18\"]]}' /> | 字体图标选中颜色 |","description":"字体图标，优先级高于 iconPath"},"tabBar_midButton":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| width | string | \"80px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度 |\n| height | string | \"80px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果 |\n| text | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的文字 |\n| iconPath | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的图片路径 |\n| iconWidth | string | \"24px\" | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 图标默认宽度（高度等比例缩放） |\n| backgroundImage | string ([string.ImageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 中间按钮的背景图片路径 |","description":"中间按钮 仅在 list 项为偶数时有效"},"pages_topWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#topwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"上窗体"},"topWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_leftWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#leftwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"左窗体"},"leftWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_rightWindow":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| path | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面路径 |\n| style | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置页面窗口表现，配置项参考下方 [pageStyle](https://uniapp.dcloud.net.cn/collocation/pages.html?id=style) |\n| matchMedia | [matchMedia 配置项列表](#rightwindow-matchmedia) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia) |","description":"右窗体"},"rightWindow_matchMedia":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| minWidth | number | 768 | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"x\",\"x\"]]}' /> | 当设备可见区域宽度 minWidth 时，显示该 window+ |","description":"配置显示该窗口的规则，配置项参考下方 [matchMedia](https://uniapp.dcloud.net.cn/collocation/pages.html?id=matchmedia)"},"pages_condition":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| current | number | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 当前激活的模式，list节点的索引值。 |\n| list | Array\\<[PagesConditionItem](#pagesconditionitem)> | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式列表 |","description":"启动模式"},"PagesConditionItem":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| name | string | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动模式名称 |\n| path | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 是 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动页面路径 |\n| query | string | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 启动参数，可在页面的 onLoad 函数里获得 |"},"pages_easycom":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| autoscan | boolean | true | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 是否开启自动扫描，开启后将会自动扫描符合components/组件名称/组件名称.vue/uvue目录结构的组件 |\n| custom | object | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.9\",\"4.11\"]]}' /> | 以正则方式自定义组件匹配规则。如果autoscan不能满足需求，可以使用custom自定义匹配规则 |","description":"组件自动引入规则"},"pages_uniIdRouter":{"table":"| 属性 | 类型 | 默认值 | 必填 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| loginPage | string ([string.PageURIString](/uts/data-type.md#ide-string)) | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 登录页面路径 |\n| resToLogin | boolean | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | 是否开启自动根据响应体判断跳转登录页面，默认true（开启） |\n| needLogin | Array\\<string,[string.PageURIString](/uts/data-type.md#ide-string)> | - | 否 | <CompatibilityTable table='{\"headers\":[{\"title\":\"Web\"},{\"title\":\"Android\"},{\"title\":\"iOS\"}],\"rows\":[[\"4.0\",\"3.99\",\"4.11\"]]}' /> | - |","description":"根据用户登录状态、页面是否要求登录、以及接口返回的用户token验证状态自动跳转登录页面。详细教程：[详见](https://doc.dcloud.net.cn/uniCloud/uni-id/summary.html#uni-id-router)"},"tutorial":"## 参见\n[相关 Bug](https://issues.dcloud.net.cn/?mid=collocation.pages_json)"}
\ No newline at end of file
docs/.vuepress/utils/utsApiJson.json
浏览文件 @ c856a0fb
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
docs/.vuepress/utils/utsComJson.json
浏览文件 @ c856a0fb
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
docs/.vuepress/utils/utsJson.json
浏览文件 @ c856a0fb
因为 它太大了无法显示 source diff 。你可以改为 查看blob。
docs/.vuepress/utils/utsUnicloudApiJson.json
浏览文件 @ c856a0fb
{"uniCloud_props":{"name":"# uniCloud","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| config | **UniCloudInitOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 服务商，目前支持 aliyun、tencent、alipay |\n@| spaceName | string | 否 | - | - | 服务空间名 |\n@| spaceId | string | 是 | - | - | 服务空间id |\n@| clientSecret | string | 否 | - | - | 阿里云clientSecret |\n@| endpoint | string | 否 | - | - | 阿里云endpoint |\n@| spaceAppId | string | 否 | - | - | 支付宝云spaceAppId |\n@| accessKey | string | 否 | - | - | 支付宝云accessKey |\n@| secretKey | string | 否 | - | - | 支付宝云secretKey |\n@| wsEndpoint | string | 否 | - | - | 支付宝云 WebSocket Endpoint |\n| mixinDatacom | any | 是 | - | - | - | \n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","compatibility":"### callFunction 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudCallFunctionOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) | 是 | - | - | 云函数名 |\n@| data | any | 否 | - | - | 云函数参数 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudCallFunctionResult\\<T>](#unicloudcallfunctionresult-values)> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| result | T | 是 | - | - | 云函数返回结果 |\n@| requestId | string | 否 | - | - | 云函数请求id | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudFunction.callFunction)"},"cloudFunction":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-function.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-function\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-function\n\n>Template\n```vue\n<template>\n <!-- #ifdef APP -->\n <scroll-view class=\"page-scroll-view\">\n <!-- #endif -->\n <view>\n <page-head :title=\"title\"></page-head>\n <view class=\"uni-padding-wrap uni-common-mt\">\n <view class=\"uni-btn-v uni-common-mt\">\n <button type=\"primary\" @click=\"callFunction\">请求云函数</button>\n <button type=\"primary\" @click=\"callFunctionWithGeneric\">请求云函数传入泛型</button>\n </view>\n </view>\n </view>\n <!-- #ifdef APP -->\n </scroll-view>\n <!-- #endif -->\n</template>\n\n\n\n<style>\n</style>\n\n```\n\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '请求云函数',\n callFunctionResult: {},\n callFunctionError: {},\n genericDemoShowMessage: '',\n isUniTest: false\n }\n },\n onLoad() {\n },\n onUnload() {\n if (this.isUniTest) {\n uni.hideToast()\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async callFunctionWithGeneric() : Promise<void> {\n type EchoCfResult = {\n showMessage: string\n }\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction<EchoCfResult>({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n uni.hideLoading()\n this.genericDemoShowMessage = result.showMessage\n this.notify(result.showMessage, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n },\n async callFunction() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n await uniCloud.callFunction({\n name: 'echo-cf',\n data: {\n num: 1,\n str: 'ABC'\n }\n }).then(res => {\n const result = res.result\n this.callFunctionResult = result\n console.log(JSON.stringify(result))\n uni.hideLoading()\n this.notify(result['showMessage'] as string, '提示')\n }).catch((err : any | null) => {\n const error = err as UniCloudError\n this.callFunctionError = {\n errCode: error.errCode,\n errMsg: error.errMsg\n }\n uni.hideLoading()\n this.notify(error.errMsg, '错误')\n })\n }\n }\n }\n\n```\n\n:::"},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","compatibility":"### importObject 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| objectName | string ([string.CloudObjectString](/uts/data-type.md#ide-string)) | 是 | - | - | - |\n| options | **UniCloudImportObjectOptions** | 否 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| customUI | boolean | 否 | - | - | 是否移除自动展示的ui |\n@| loadingOptions | **UniCloudImportObjectLoadingOptions** | 否 | - | - | loading界面配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| title | string | 否 | - | - | 加载框标题 |\n@@| mask | boolean | 否 | - | - | 加载框是否显示mask |\n@| errorOptions | **UniCloudImportObjectErrorOptions** | 否 | - | - | 错误提示配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| type | string | 否 | - | - | 错误提示类型，可以是modal或者toast |\n@@| retry | boolean | 否 | - | - | 是否显示重试按钮 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| _obj | [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) | 是 | - | - | - |\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod\\<T = UTSJSONObject>(methodName: string, args: Array\\<any \\| null>): Promise\\<T>; @callmethod\n\n###### callMethod 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| methodName | string | 是 | - | - | - |\n| args | Array\\<any\\> | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<T> |\n \n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### protected _getArgs(...args: Array\\<any \\| null>): Array\\<any \\| null>; @_getargs\n\n##### _getArgs 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<any\\> |\n \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudObject.importObject)"},"cloudObject":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-object.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-object\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-object\n\n>Template\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodo\">添加Todo</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodoWithGeneric\">\r\n 添加Todo传入泛型\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"randomFail\">随机触发失败重试</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"fail\">云对象失败调用</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"failWithNumberErrCode\">\r\n 云对象数字错误码\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"success\">云对象成功调用</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n\r\n\r\n<style></style>\n\n```\n\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: '请求云对象',\r\n todoTitle: '学习编程',\r\n todoContent: '熟悉uts语法',\r\n returnTodoTitle: '',\r\n returnTodoContent: '',\r\n genericDemoReturnTodoTitle: '',\r\n genericDemoReturnTodoContent: '',\r\n failErrCode: '',\r\n failErrDetailTips: '',\r\n failNumberErrCode: 0,\r\n successErrCode: -1,\r\n isUniTest: false\r\n }\r\n },\r\n methods: {\r\n notify(content : string, title : string) {\r\n if (!this.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n },\r\n async addTodo() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n const title = this.todoTitle\r\n const content = this.todoContent\r\n await todo.add<UTSJSONObject>(title, content).then((res : UTSJSONObject) => {\r\n this.returnTodoTitle = res['title'] as string\r\n this.returnTodoContent = res['content'] as string\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async addTodoWithGeneric() : Promise<void> {\r\n type AddTodoResult = {\r\n title : string,\r\n content : string,\r\n showMessage : string\r\n }\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n const title = this.todoTitle\r\n const content = this.todoContent\r\n await todo.add<AddTodoResult>(title, content).then((res : AddTodoResult) => {\r\n this.genericDemoReturnTodoTitle = res.title\r\n this.genericDemoReturnTodoContent = res.content\r\n this.notify(res.showMessage, '提示')\r\n }).catch((err : any | null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async randomFail() : Promise<void> {\r\n const todoObj = uniCloud.importObject('todo', {\r\n errorOptions: {\r\n retry: true\r\n }\r\n })\r\n await todoObj.randomFail().then((res : UTSJSONObject) => {\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async fail() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.fail().then((res : UTSJSONObject) => {\r\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.failErrCode = error.errCode as string\r\n const detail = error.detail\r\n if (detail != null && detail['tips'] != null) {\r\n this.failErrDetailTips = detail['tips'] as string\r\n }\r\n console.error(error)\r\n })\r\n },\r\n async failWithNumberErrCode() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\r\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.failNumberErrCode = error.errCode as number\r\n console.error(error)\r\n })\r\n },\r\n async success() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.success().then((res : UTSJSONObject) => {\r\n this.successErrCode = res['errCode'] as number\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","compatibility":"### uploadFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| cloudPath | string | 是 | - | - | 云端路径 |\n@| cloudPathAsRealPath | boolean | 否 | - | - | 是否以云端路径是否为真实路径保存上传的文件 | \n\n### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n### (options: UniCloudUploadProgress) => any @onuploadprogress\n上传进度回调\n#### onUploadProgress 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudUploadProgress** | 是 | - | - | 上传进度回调参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| loaded | number | 是 | - | - | 已上传大小 |\n@| total | number | 是 | - | - | 总大小 | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| fileID | string | 是 | - | - | 文件id | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.uploadFile)"},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","compatibility":"### getTempFileURL 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudGetTempFileURLOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<string\\> | 是 | - | - | 文件列表 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudGetTempFileURLResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<**UniCloudGetTempFileURLResultItem**\\> | 是 | - | - | 文件列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fileID | string | 是 | - | - | 文件id |\n@@| tempFileURL | string | 是 | - | - | 文件临时url | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.chooseAndUploadFile)"},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","compatibility":"### chooseAndUploadFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\<'album' \\| 'camera'\\> | 否 | - | - | |\n@| count | number | 否 | - | - | |\n@| sizeType | Array\\<'original' \\| 'compressed'\\> | 否 | - | - | |\n@| extension | Array\\<string\\> | 否 | - | - | |\n@| compressed | boolean | 否 | - | - | |\n@| maxDuration | number | 否 | - | - | |\n@| camera | string | 否 | - | - | - |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| front | - | - |\n@@| back | - | - |\n@| crop | ChooseImageCropOptions | 否 | - | - | |\n@| type | string | 是 | - | - | - |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| image | - | - |\n@@| video | - | - |\n@@| all | - | - | \n\n### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n### (arg: UniCloudChooseAndUploadFileResult) => void \\| null @onchoosefile\n\n#### onChooseFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileResult** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseAndUploadFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean | 否 | - | - | |\n@@| url | string | 否 | - | - | |\n@@| errMsg | string | 否 | - | - | |\n@| tempFilePaths | Array\\<string\\> | 是 | - | - | - | \n\n\n### (arg: UniCloudChooseAndUploadFileProgressEvent) => void \\| null @onuploadprogress\n\n#### onUploadProgress 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileProgressEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | - |\n@| loaded | number | 是 | - | - | - |\n@| total | number | 是 | - | - | - |\n@| tempFilePath | string | 是 | - | - | - |\n@| tempFile | [UniCloudChooseAndUploadFileItem](#unicloudchooseanduploadfileitem-values) | 是 | - | - | - | \n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudChooseAndUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseAndUploadFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean | 否 | - | - | |\n@@| url | string | 否 | - | - | |\n@@| errMsg | string | 否 | - | - | |\n@| tempFilePaths | Array\\<string\\> | 是 | - | - | - | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.getTempFileURL)"},"cloudStorage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-storage\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-storage\n\n>Template\n```vue\n<template>\n <!-- #ifdef APP -->\n <scroll-view class=\"page-scroll-view\">\n <!-- #endif -->\n <view>\n <page-head :title=\"title\"></page-head>\n <view class=\"uni-padding-wrap uni-common-mt\">\n <view class=\"uni-btn-v uni-common-mt\">\n <button type=\"primary\" @click=\"uploadFile\">选择文件上传</button>\n <button type=\"primary\" @click=\"chooseAndUploadFile\">一个接口选择文件并上传</button>\n </view>\n </view>\n </view>\n <!-- #ifdef APP -->\n </scroll-view>\n <!-- #endif -->\n</template>\n\n\n<style>\n</style>\n\n```\n\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: '云存储'\n }\n },\n onLoad() {\n },\n onUnload() {\n },\n methods: {\n uploadFile: function () {\n uni.chooseImage({\n count: 1,\n success(res) : void {\n uni.showLoading({\n title: '上传中...'\n })\n const tempFilePath = res.tempFilePaths[0]\n uniCloud.uploadFile({\n filePath: tempFilePath,\n cloudPath: 'test.jpg'\n })\n .then(function (res) {\n uni.hideLoading()\n console.log(res)\n uni.showModal({\n content: '上传成功',\n showCancel: false\n });\n })\n .catch(function (err : any | null) {\n uni.hideLoading()\n const error = err as UniCloudError\n uni.showModal({\n content: '上传失败，' + error.errMsg,\n showCancel: false\n });\n })\n // .finally((_: number) : void => {\n // uni.hideLoading()\n // })\n },\n fail(err) : void {\n console.error('chooseImage fail: ', err)\n }\n })\n },\n chooseAndUploadFile() {\n uniCloud.chooseAndUploadFile({\n type: 'image'\n }).then(function (res) {\n uni.hideLoading()\n console.log(res)\n uni.showModal({\n content: '上传成功',\n showCancel: false\n });\n })\n .catch(function (err : any | null) {\n uni.hideLoading()\n const error = err as UniCloudError\n uni.showModal({\n content: '上传失败，' + error.errMsg,\n showCancel: false\n });\n })\n }\n }\n }\n\n```\n\n:::"},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","compatibility":"### databaseForJQL 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| command | any | 是 | - | - | - |\n@| Geo | any | 是 | - | - | - |\n#### Database 的方法 @database-values \n\n#### collection(...args: Array\\<any>): Collection; @collection\n\n##### collection 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Collection](#collection-values) |\n\n###### Collection 的方法 @collection-values \n\n###### where(condition: any): UniCloudDBFilter; @where\n\n###### where 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n\n###### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBGetResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | Array\\<any\\> | 是 | - | - | 添加的记录的id列表 |\n@| count | number | 否 | - | - | 匹配到的数据总量 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBCountResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| total | number | 是 | - | - | 添加的记录的id列表 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### update(data: UTSJSONObject): Promise\\<UniCloudDBUpdateResult>; @update\n\n###### update 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBUpdateResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| updated | number | 是 | - | - | 更新成功的记录数 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### remove(): Promise\\<UniCloudDBRemoveResult>; @remove\n\n###### remove 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBRemoveResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| deleted | number | 是 | - | - | 删除成功的记录数 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### where(condition: any): UniCloudDBFilter; @where\n\n###### where 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\n\n###### doc 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n\n###### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\n\n###### groupBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\n\n###### groupField 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\n\n###### distinct 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\n\n###### geoNear 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\n\n###### groupBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\n\n###### groupField 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\n\n###### distinct 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\n\n###### geoNear 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\n\n###### doc 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### aggregate(): UniCloudDBFilter; @aggregate\n\n###### aggregate 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### foreignKey(foreignKey: string): UniCloudDBFilter; @foreignkey\n\n###### foreignKey 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| foreignKey | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### add(data: UTSJSONObject): Promise\\<UniCloudDBAddResult>; @add\n\n###### add 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBAddResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 添加的记录的id |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n#### multiSend(...args: Array\\<UTSJSONObject>): Promise\\<UniCloudDBMultiSendResult>; @multisend\n合并查询请求\n##### multiSend 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 4.16 | 4.11 |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBMultiSendResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dataList | Array\\<**UniCloudDBMultiSendResultItem**\\> | 是 | - | - | 数据列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| errCode | any | 是 | - | - | 错误码，可能为字符串或数字，数字0表示成功 |\n@@| errMsg | string | 是 | - | - | 错误信息 |\n@@| data | Array\\<any\\> | 否 | - | - | 数据 |\n@| requestId | string | 否 | - | - | 请求id | \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.database.databaseForJQL)"},"database":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/database.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/database\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/database\n\n>Template\n```vue\n<template>\n <!-- #ifdef APP -->\n <scroll-view class=\"page-scroll-view\">\n <!-- #endif -->\n <view>\n <page-head :title=\"title\"></page-head>\n <view class=\"uni-padding-wrap uni-common-mt\">\n <view class=\"uni-btn-v uni-common-mt\">\n <button type=\"primary\" @click=\"dbAdd\">新增单条数据</button>\n <button type=\"primary\" @click=\"dbBatchAdd\">新增多条数据</button>\n <button type=\"primary\" @click=\"dbUpdate\">更新数据</button>\n <button type=\"primary\" @click=\"dbGet\">where传字符串获取数据</button>\n <button type=\"primary\" @click=\"dbGetWithCommand\">where传对象获取数据</button>\n <button type=\"primary\" @click=\"dbRemove\">删除数据</button>\n <button type=\"primary\" @click=\"dbLookupInit\">初始化联表查询数据</button>\n <button type=\"primary\" @click=\"dbLookup\">联表查询</button>\n <button type=\"primary\" @click=\"dbMultiSend\">合并查询查询</button>\n </view>\n </view>\n </view>\n <!-- #ifdef APP -->\n </scroll-view>\n <!-- #endif -->\n</template>\n\n\n\n<style>\n</style>\n\n```\n\n>Script\n```uts\n\n export default {\n data() {\n return {\n title: 'ClientDB',\n addId: '',\n batchAddIds: [] as Array<string>,\n batchAddinserted: 0,\n updateUpdated: 0,\n getData: [] as Array<UTSJSONObject>,\n getWithCommandData: [] as Array<UTSJSONObject>,\n removeDeleted: 0,\n lookupData: [] as Array<UTSJSONObject>,\n multiSendSuccessCount: 0,\n isUniTest: false\n }\n },\n computed: {\n dataTag() : string {\n return this.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\n }\n },\n methods: {\n notify(content : string, title : string) {\n if (!this.isUniTest) {\n uni.showModal({\n title,\n content,\n showCancel: false\n })\n } else {\n console.log(title, content)\n }\n },\n async dbAdd() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add({\n num: 1,\n tag: this.dataTag,\n date: new Date()\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.addId = res.id\n this.notify(`新增成功，id: ${res.id}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbBatchAdd() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .add([{\n num: 2,\n tag: this.dataTag,\n }, {\n num: 3,\n tag: this.dataTag,\n }])\n .then((res) => {\n uni.hideLoading()\n console.log(res)\n console.log('JSON.stringify(res.inserted)', JSON.stringify(res.inserted))\n this.batchAddIds = res.ids\n this.batchAddinserted = res.inserted\n this.notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGet() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbGetWithCommand() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where({\n num: db.command.gt(1),\n tag: this.dataTag\n })\n .field('num, tag')\n .orderBy('num desc')\n .skip(1)\n .limit(2)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.getWithCommandData = res.data\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbUpdate() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .update({\n num: 4\n })\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.updateUpdated = res.updated\n this.notify(`更新成功，更新了${res.updated}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbRemove() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('type')\n .where(\n `tag == \"${this.dataTag}\"`\n )\n .remove()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.removeDeleted = res.deleted\n this.notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookupInit() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n await db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n .then(() : Promise<UniCloudDBRemoveResult> => {\n return db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .remove()\n })\n .then(() : Promise<UniCloudDBBatchAddResult> => {\n return db.collection('local')\n .add([{\n id: \"local_1\",\n name: \"local_1_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_1\"\n }, {\n id: \"local_2\",\n name: \"local_2_name\",\n tag: this.dataTag,\n foreign_id: \"foreign_2\"\n }])\n })\n .then(() : Promise<UniCloudDBBatchAddResult> => {\n return db.collection('foreign')\n .add([{\n id: \"foreign_1\",\n name: \"foreign_1_name\",\n tag: this.dataTag\n }, {\n id: \"foreign_2\",\n name: \"foreign_2_name\",\n tag: this.dataTag\n }])\n })\n .then((_) : void => {\n uni.hideLoading()\n this.notify('数据初始化成功', '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n console.error(err)\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbLookup() : Promise<void> {\n uni.showLoading({\n title: '加载中...'\n })\n const db = uniCloud.databaseForJQL()\n const local = db.collection('local')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n const foreign = db.collection('foreign')\n .where(`tag == \"${this.dataTag}\"`)\n .getTemp()\n await db.collection(local, foreign)\n .get()\n .then(res => {\n uni.hideLoading()\n console.log(res)\n this.lookupData = res.data\n this.notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\n })\n .catch((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n this.notify(error.errMsg, '错误')\n })\n },\n async dbMultiSend() : Promise<void> {\n const db = uniCloud.databaseForJQL()\n const temp1 = db.collection('type')\n .where(\n 'tag == \"default-tag\"'\n ).getTemp()\n const temp2 = db.collection('type')\n .where(\n 'tag == \"default-tag\"'\n ).getTemp()\n await db.multiSend(temp1, temp2)\n .then<void>(res => {\n uni.hideLoading()\n let successCount = 0\n for (let i = 0; i < res.dataList.length; i++) {\n const item = res.dataList[i]\n if(item.errCode == 0) {\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\n successCount++\n } else {\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\n }\n }\n this.multiSendSuccessCount = successCount\n this.notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\n })\n .catch<void>((err : any | null) => {\n uni.hideLoading()\n const error = err as UniCloudError\n console.error(err)\n this.notify(error.errMsg, '错误')\n })\n }\n }\n }\n\n```\n\n:::"},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","compatibility":"### onResponse 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onResponse)"},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","compatibility":"### offResponse 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offResponse)"},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","compatibility":"### onRefreshToken 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onRefreshToken)"},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","compatibility":"### offRefreshToken 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offRefreshToken)"},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","compatibility":"### getCurrentUserInfo 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **UniCloudUserInfo** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| uid | string | 否 | - | - | 用户id |\n@| role | Array\\<string\\> | 是 | - | - | 用户角色列表 |\n@| permission | Array\\<string\\> | 是 | - | - | 用户权限列表 |\n@| tokenExpired | number | 是 | - | - | 用户token过期时间 | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.getCurrentUserInfo)"},"connectWebSocket":{"name":"## connectWebSocket(options) @connectwebsocket","description":"连接 WebSocket","compatibility":"### connectWebSocket 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.24 | 4.24 | 4.24 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudConnectWebSocketOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string | 是 | - | - | WebSocket云函数/云对象名称 |\n@| query | any | 否 | - | - | 建立连接时需要传递的参数, 仅在 connection 事件中接收到 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SocketTask |\n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.connectWebSocket)"}}
\ No newline at end of file
{"uniCloud_props":{"name":"# uniCloud","description":"","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| config | **UniCloudInitOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| provider | string | 是 | - | - | 服务商，目前支持 aliyun、tencent、alipay |\n@| spaceName | string | 否 | - | - | 服务空间名 |\n@| spaceId | string | 是 | - | - | 服务空间id |\n@| clientSecret | string | 否 | - | - | 阿里云clientSecret |\n@| endpoint | string | 否 | - | - | 阿里云endpoint |\n@| spaceAppId | string | 否 | - | - | 支付宝云spaceAppId |\n@| accessKey | string | 否 | - | - | 支付宝云accessKey |\n@| secretKey | string | 否 | - | - | 支付宝云secretKey |\n@| wsEndpoint | string | 否 | - | - | 支付宝云 WebSocket Endpoint |\n| mixinDatacom | any | 是 | - | - | - | \n","returnValue":"","compatibility":"","tutorial":""},"callFunction":{"name":"## callFunction(options) @callfunction","description":"请求云函数","compatibility":"### callFunction 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudCallFunctionOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string ([string.CloudFunctionString](/uts/data-type.md#ide-string)) | 是 | - | - | 云函数名 |\n@| data | any | 否 | - | - | 云函数参数 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudCallFunctionResult\\<T>](#unicloudcallfunctionresult-values)> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| result | T | 是 | - | - | 云函数返回结果 |\n@| requestId | string | 否 | - | - | 云函数请求id | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudFunction.callFunction)"},"cloudFunction":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-function.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-function\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-function\n\n>Template\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"callFunction\">请求云函数</button>\r\n <button type=\"primary\" @click=\"callFunctionWithGeneric\">请求云函数传入泛型</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n\r\n\r\n<style>\r\n</style>\n\n```\n\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: '请求云函数',\r\n callFunctionResult: {},\r\n callFunctionError: {},\r\n genericDemoShowMessage: '',\r\n isUniTest: false\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n if (this.isUniTest) {\r\n uni.hideToast()\r\n }\r\n },\r\n methods: {\r\n notify(content : string, title : string) {\r\n if (!this.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n },\r\n async callFunctionWithGeneric() : Promise<void> {\r\n type EchoCfResult = {\r\n showMessage : string\r\n }\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction<EchoCfResult>({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = res.result\r\n uni.hideLoading()\r\n this.genericDemoShowMessage = result.showMessage\r\n this.notify(result.showMessage, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n uni.hideLoading()\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async callFunction() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n await uniCloud.callFunction({\r\n name: 'echo-cf',\r\n data: {\r\n num: 1,\r\n str: 'ABC'\r\n }\r\n }).then(res => {\r\n const result = res.result\r\n this.callFunctionResult = result\r\n console.log(JSON.stringify(result))\r\n uni.hideLoading()\r\n this.notify(result['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.callFunctionError = {\r\n errCode: error.errCode,\r\n errMsg: error.errMsg\r\n }\r\n uni.hideLoading()\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\n jest_UniCloudError() {\n return new Error() instanceof UniCloudError\n }\r\n }\r\n }\r\n\n```\n\n:::"},"importObject":{"name":"## importObject(objectName, options?) @importobject","description":"引用云对象","compatibility":"### importObject 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| objectName | string ([string.CloudObjectString](/uts/data-type.md#ide-string)) | 是 | - | - | - |\n| options | **UniCloudImportObjectOptions** | 否 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| customUI | boolean | 否 | - | - | 是否移除自动展示的ui |\n@| loadingOptions | **UniCloudImportObjectLoadingOptions** | 否 | - | - | loading界面配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| title | string | 否 | - | - | 加载框标题 |\n@@| mask | boolean | 否 | - | - | 加载框是否显示mask |\n@| errorOptions | **UniCloudImportObjectErrorOptions** | 否 | - | - | 错误提示配置 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| type | string | 否 | - | - | 错误提示类型，可以是modal或者toast |\n@@| retry | boolean | 否 | - | - | 是否显示重试按钮 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudCloudObjectCaller](#unicloudcloudobjectcaller-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| _obj | [InternalUniCloudCloudObject](#internalunicloudcloudobject-values) | 是 | - | - | - |\n##### InternalUniCloudCloudObject 的方法 @internalunicloudcloudobject-values \n\n##### callMethod\\<T = UTSJSONObject>(methodName: string, args: Array\\<any \\| null>): Promise\\<T>; @callmethod\n\n###### callMethod 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| methodName | string | 是 | - | - | - |\n| args | Array\\<any\\> | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<T> |\n \n\n#### UniCloudCloudObjectCaller 的方法 @unicloudcloudobjectcaller-values \n\n#### protected _getArgs(...args: Array\\<any \\| null>): Array\\<any \\| null>; @_getargs\n\n##### _getArgs 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<any\\> |\n \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudObject.importObject)"},"cloudObject":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-object.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-object\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-object\n\n>Template\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodo\">添加Todo</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"addTodoWithGeneric\">\r\n 添加Todo传入泛型\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"randomFail\">随机触发失败重试</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"fail\">云对象失败调用</button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"failWithNumberErrCode\">\r\n 云对象数字错误码\r\n </button>\r\n </view>\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @tap=\"success\">云对象成功调用</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n\r\n\r\n<style></style>\n\n```\n\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: '请求云对象',\r\n todoTitle: '学习编程',\r\n todoContent: '熟悉uts语法',\r\n returnTodoTitle: '',\r\n returnTodoContent: '',\r\n genericDemoReturnTodoTitle: '',\r\n genericDemoReturnTodoContent: '',\r\n failErrCode: '',\r\n failErrDetailTips: '',\r\n failNumberErrCode: 0,\r\n successErrCode: -1,\r\n isUniTest: false\r\n }\r\n },\r\n methods: {\r\n notify(content : string, title : string) {\r\n if (!this.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n },\r\n async addTodo() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n const title = this.todoTitle\r\n const content = this.todoContent\r\n await todo.add<UTSJSONObject>(title, content).then((res : UTSJSONObject) => {\r\n this.returnTodoTitle = res['title'] as string\r\n this.returnTodoContent = res['content'] as string\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async addTodoWithGeneric() : Promise<void> {\r\n type AddTodoResult = {\r\n title : string,\r\n content : string,\r\n showMessage : string\r\n }\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n const title = this.todoTitle\r\n const content = this.todoContent\r\n await todo.add<AddTodoResult>(title, content).then((res : AddTodoResult) => {\r\n this.genericDemoReturnTodoTitle = res.title\r\n this.genericDemoReturnTodoContent = res.content\r\n this.notify(res.showMessage, '提示')\r\n }).catch((err : any | null) => {\r\n console.log(err)\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async randomFail() : Promise<void> {\r\n const todoObj = uniCloud.importObject('todo', {\r\n errorOptions: {\r\n retry: true\r\n }\r\n })\r\n await todoObj.randomFail().then((res : UTSJSONObject) => {\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n },\r\n async fail() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.fail().then((res : UTSJSONObject) => {\r\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.failErrCode = error.errCode as string\r\n const detail = error.detail\r\n if (detail != null && detail['tips'] != null) {\r\n this.failErrDetailTips = detail['tips'] as string\r\n }\r\n console.error(error)\r\n })\r\n },\r\n async failWithNumberErrCode() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.failWithNumberErrCode().then((res : UTSJSONObject) => {\r\n this.notify('todo.fail应调用失败，此处错误的触发了成功回调', '错误')\r\n console.log('todo.fail: ', res);\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n this.failNumberErrCode = error.errCode as number\r\n console.error(error)\r\n })\r\n },\r\n async success() : Promise<void> {\r\n const todo = uniCloud.importObject('todo', {\r\n customUI: this.isUniTest\r\n })\r\n await todo.success().then((res : UTSJSONObject) => {\r\n this.successErrCode = res['errCode'] as number\r\n this.notify(res['showMessage'] as string, '提示')\r\n }).catch((err : any | null) => {\r\n const error = err as UniCloudError\r\n console.error(error)\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"uploadFile":{"name":"## uploadFile(options) @uploadfile","description":"上传文件到云存储","compatibility":"### uploadFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudUploadFileOptions](#uniclouduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| cloudPath | string | 是 | - | - | 云端路径 |\n@| cloudPathAsRealPath | boolean | 否 | - | - | 是否以云端路径是否为真实路径保存上传的文件 | \n\n### UniCloudUploadFileOptions 的方法 @uniclouduploadfileoptions-values \n\n### (options: UniCloudUploadProgress) => any @onuploadprogress\n上传进度回调\n#### onUploadProgress 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudUploadProgress** | 是 | - | - | 上传进度回调参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| loaded | number | 是 | - | - | 已上传大小 |\n@| total | number | 是 | - | - | 总大小 | \n\n#### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| filePath | string | 是 | - | - | 文件路径 |\n@| fileID | string | 是 | - | - | 文件id | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.uploadFile)"},"getTempFileURL":{"name":"## getTempFileURL(options) @gettempfileurl","description":"获取文件临时URL","compatibility":"### getTempFileURL 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudGetTempFileURLOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<string\\> | 是 | - | - | 文件列表 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudGetTempFileURLResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| fileList | Array\\<**UniCloudGetTempFileURLResultItem**\\> | 是 | - | - | 文件列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| fileID | string | 是 | - | - | 文件id |\n@@| tempFileURL | string | 是 | - | - | 文件临时url | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.chooseAndUploadFile)"},"chooseAndUploadFile":{"name":"## chooseAndUploadFile(options) @chooseanduploadfile","description":"选择并上传文件","compatibility":"### chooseAndUploadFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | [UniCloudChooseAndUploadFileOptions](#unicloudchooseanduploadfileoptions-values) | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| sourceType | Array\\<'album' \\| 'camera'\\> | 否 | - | - | |\n@| count | number | 否 | - | - | |\n@| sizeType | Array\\<'original' \\| 'compressed'\\> | 否 | - | - | |\n@| extension | Array\\<string\\> | 否 | - | - | |\n@| compressed | boolean | 否 | - | - | |\n@| maxDuration | number | 否 | - | - | |\n@| camera | string | 否 | - | - | - |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| front | - | - |\n@@| back | - | - |\n@| crop | ChooseImageCropOptions | 否 | - | - | |\n@| type | string | 是 | - | - | - |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| image | - | - |\n@@| video | - | - |\n@@| all | - | - | \n\n### UniCloudChooseAndUploadFileOptions 的方法 @unicloudchooseanduploadfileoptions-values \n\n### (arg: UniCloudChooseAndUploadFileResult) => void \\| null @onchoosefile\n\n#### onChooseFile 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileResult** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseAndUploadFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean | 否 | - | - | |\n@@| url | string | 否 | - | - | |\n@@| errMsg | string | 否 | - | - | |\n@| tempFilePaths | Array\\<string\\> | 是 | - | - | - | \n\n\n### (arg: UniCloudChooseAndUploadFileProgressEvent) => void \\| null @onuploadprogress\n\n#### onUploadProgress 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | **UniCloudChooseAndUploadFileProgressEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | - |\n@| loaded | number | 是 | - | - | - |\n@| total | number | 是 | - | - | - |\n@| tempFilePath | string | 是 | - | - | - |\n@| tempFile | [UniCloudChooseAndUploadFileItem](#unicloudchooseanduploadfileitem-values) | 是 | - | - | - | \n\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudChooseAndUploadFileResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| tempFiles | Array\\<**UniCloudChooseAndUploadFileItem**\\> | 是 | - | - | - |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| name | string | 是 | - | - | - |\n@@| path | string | 是 | - | - | - |\n@@| cloudPath | string | 是 | - | - | - |\n@@| cloudPathAsRealPath | boolean | 否 | - | - | |\n@@| url | string | 否 | - | - | |\n@@| errMsg | string | 否 | - | - | |\n@| tempFilePaths | Array\\<string\\> | 是 | - | - | - | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.cloudStorage.getTempFileURL)"},"cloudStorage":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/cloud-storage.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/cloud-storage\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/cloud-storage\n\n>Template\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"uploadFile\">选择文件上传</button>\r\n <button type=\"primary\" @click=\"chooseAndUploadFile\">一个接口选择文件并上传</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n\r\n<style>\r\n</style>\n\n```\n\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: '云存储'\r\n }\r\n },\r\n onLoad() {\r\n },\r\n onUnload() {\r\n },\r\n methods: {\r\n uploadFile: function () {\r\n uni.chooseImage({\r\n count: 1,\r\n success(res) : void {\r\n uni.showLoading({\r\n title: '上传中...'\r\n })\r\n const tempFilePath = res.tempFilePaths[0]\r\n uniCloud.uploadFile({\r\n filePath: tempFilePath,\r\n cloudPath: 'test.jpg'\r\n })\r\n .then(function (res) {\r\n uni.hideLoading()\r\n console.log(res)\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any | null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n // .finally((_: number) : void => {\r\n // uni.hideLoading()\r\n // })\r\n },\r\n fail(err) : void {\r\n console.error('chooseImage fail: ', err)\r\n }\r\n })\r\n },\r\n chooseAndUploadFile() {\r\n uniCloud.chooseAndUploadFile({\r\n type: 'image'\r\n }).then(function (res) {\r\n uni.hideLoading()\r\n console.log(res)\r\n uni.showModal({\r\n content: '上传成功',\r\n showCancel: false\r\n });\r\n })\r\n .catch(function (err : any | null) {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n uni.showModal({\r\n content: '上传失败，' + error.errMsg,\r\n showCancel: false\r\n });\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"databaseForJQL":{"name":"## databaseForJQL() @databaseforjql","description":"获取数据库操作实例","compatibility":"### databaseForJQL 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.91，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [Database](#database-values) |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| command | any | 是 | - | - | - |\n@| Geo | any | 是 | - | - | - |\n#### Database 的方法 @database-values \n\n#### collection(...args: Array\\<any>): Collection; @collection\n\n##### collection 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| [Collection](#collection-values) |\n\n###### Collection 的方法 @collection-values \n\n###### where(condition: any): UniCloudDBFilter; @where\n\n###### where 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n\n###### UniCloudDBFilter 的方法 @uniclouddbfilter-values \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBGetResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| data | Array\\<any\\> | 是 | - | - | 添加的记录的id列表 |\n@| count | number | 否 | - | - | 匹配到的数据总量 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBCountResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| total | number | 是 | - | - | 添加的记录的id列表 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### update(data: UTSJSONObject): Promise\\<UniCloudDBUpdateResult>; @update\n\n###### update 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBUpdateResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| updated | number | 是 | - | - | 更新成功的记录数 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### remove(): Promise\\<UniCloudDBRemoveResult>; @remove\n\n###### remove 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBRemoveResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| deleted | number | 是 | - | - | 删除成功的记录数 |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### where(condition: any): UniCloudDBFilter; @where\n\n###### where 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| condition | any | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\n\n###### doc 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n\n###### UniCloudDBQuery 的方法 @uniclouddbquery-values \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\n\n###### groupBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\n\n###### groupField 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\n\n###### distinct 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\n\n###### geoNear 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupBy(field: string): UniCloudDBQuery; @groupby\n\n###### groupBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### groupField(field: string): UniCloudDBQuery; @groupfield\n\n###### groupField 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### distinct(field: string): UniCloudDBQuery; @distinct\n\n###### distinct 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| field | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### geoNear(options: UTSJSONObject): UniCloudDBQuery; @geonear\n\n###### geoNear 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n###### doc(docId: string): UniCloudDBFilter; @doc\n\n###### doc 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| docId | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### aggregate(): UniCloudDBFilter; @aggregate\n\n###### aggregate 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### foreignKey(foreignKey: string): UniCloudDBFilter; @foreignkey\n\n###### foreignKey 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| foreignKey | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBFilter](#uniclouddbfilter-values) |\n \n\n###### add(data: UTSJSONObject): Promise\\<UniCloudDBAddResult>; @add\n\n###### add 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| data | any | 是 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBAddResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| id | string | 是 | - | - | 添加的记录的id |\n@| requestId | string | 否 | - | - | 请求id | \n\n###### get(arg?: UTSJSONObject \\| null): Promise\\<UniCloudDBGetResult>; @get\n\n###### get 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| arg | any | 否 | - | - | | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBGetResult](#uniclouddbgetresult-values)> |\n \n\n###### count(): Promise\\<UniCloudDBCountResult>; @count\n\n###### count 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<[UniCloudDBCountResult](#uniclouddbcountresult-values)> |\n \n\n###### getTemp(): UTSJSONObject; @gettemp\n\n###### getTemp 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n\n###### 返回值 \n\n| 类型 |\n| :- |\n| any |\n \n\n###### field(filed: string): UniCloudDBQuery; @field\n\n###### field 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| filed | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### skip(num: number): UniCloudDBQuery; @skip\n\n###### skip 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### limit(num: number): UniCloudDBQuery; @limit\n\n###### limit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| num | number | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n\n###### orderBy(order: string): UniCloudDBQuery; @orderby\n\n###### orderBy 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| - | - | - |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| order | string | 是 | - | - | - | \n\n###### 返回值 \n\n| 类型 |\n| :- |\n| [UniCloudDBQuery](#uniclouddbquery-values) |\n \n \n\n#### multiSend(...args: Array\\<UTSJSONObject>): Promise\\<UniCloudDBMultiSendResult>; @multisend\n合并查询请求\n##### multiSend 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 4.16 | 4.11 |\n\n##### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| args | Array\\<any\\> | 否 | - | - | - | \n\n##### 返回值 \n\n| 类型 |\n| :- |\n| Promise\\<**UniCloudDBMultiSendResult**> |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| dataList | Array\\<**UniCloudDBMultiSendResultItem**\\> | 是 | - | - | 数据列表 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| errCode | any | 是 | - | - | 错误码，可能为字符串或数字，数字0表示成功 |\n@@| errMsg | string | 是 | - | - | 错误信息 |\n@@| data | Array\\<any\\> | 否 | - | - | 数据 |\n@| requestId | string | 否 | - | - | 请求id | \n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.database.databaseForJQL)"},"database":{"example":"## 示例 \n> [hello uni-app x](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/alpha//pages/API/unicloud/unicloud/database.uvue) \n ::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/unicloud/unicloud/database\n\n> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/unicloud/unicloud/database\n\n>Template\n```vue\n<template>\r\n <!-- #ifdef APP -->\r\n <scroll-view class=\"page-scroll-view\">\r\n <!-- #endif -->\r\n <view>\r\n <page-head :title=\"title\"></page-head>\r\n <view class=\"uni-padding-wrap uni-common-mt\">\r\n <view class=\"uni-btn-v uni-common-mt\">\r\n <button type=\"primary\" @click=\"dbAdd\">新增单条数据</button>\r\n <button type=\"primary\" @click=\"dbBatchAdd\">新增多条数据</button>\r\n <button type=\"primary\" @click=\"dbUpdate\">更新数据</button>\r\n <button type=\"primary\" @click=\"dbGet\">where传字符串获取数据</button>\r\n <button type=\"primary\" @click=\"dbGetWithCommand\">where传对象获取数据</button>\r\n <button type=\"primary\" @click=\"dbRemove\">删除数据</button>\r\n <button type=\"primary\" @click=\"dbLookupInit\">初始化联表查询数据</button>\r\n <button type=\"primary\" @click=\"dbLookup\">联表查询</button>\r\n <button type=\"primary\" @click=\"dbMultiSend\">合并查询查询</button>\r\n </view>\r\n </view>\r\n </view>\r\n <!-- #ifdef APP -->\r\n </scroll-view>\r\n <!-- #endif -->\r\n</template>\r\n\r\n\r\n\r\n<style>\r\n</style>\n\n```\n\n>Script\n```uts\n\r\n export default {\r\n data() {\r\n return {\r\n title: 'ClientDB',\r\n addId: '',\r\n batchAddIds: [] as Array<string>,\r\n batchAddinserted: 0,\r\n updateUpdated: 0,\r\n getData: [] as Array<UTSJSONObject>,\r\n getWithCommandData: [] as Array<UTSJSONObject>,\r\n removeDeleted: 0,\r\n lookupData: [] as Array<UTSJSONObject>,\r\n multiSendSuccessCount: 0,\r\n isUniTest: false\r\n }\r\n },\r\n computed: {\r\n dataTag() : string {\r\n return this.isUniTest ? 'default-tag' + Date.now() : 'default-tag'\r\n }\r\n },\r\n methods: {\r\n notify(content : string, title : string) {\r\n if (!this.isUniTest) {\r\n uni.showModal({\r\n title,\r\n content,\r\n showCancel: false\r\n })\r\n } else {\r\n console.log(title, content)\r\n }\r\n },\r\n async dbAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add({\r\n num: 1,\r\n tag: this.dataTag,\r\n date: new Date()\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.addId = res.id\r\n this.notify(`新增成功，id: ${res.id}`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbBatchAdd() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .add([{\r\n num: 2,\r\n tag: this.dataTag,\r\n }, {\r\n num: 3,\r\n tag: this.dataTag,\r\n }])\r\n .then((res) => {\r\n uni.hideLoading()\r\n console.log(res)\r\n console.log('JSON.stringify(res.inserted)', JSON.stringify(res.inserted))\r\n this.batchAddIds = res.ids\r\n this.batchAddinserted = res.inserted\r\n this.notify(`新增成功条数${res.inserted}, id列表: ${res.ids.join(',')}`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbGet() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${this.dataTag}\"`\r\n )\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.getData = res.data\r\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbGetWithCommand() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where({\r\n num: db.command.gt(1),\r\n tag: this.dataTag\r\n })\r\n .field('num, tag')\r\n .orderBy('num desc')\r\n .skip(1)\r\n .limit(2)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.getWithCommandData = res.data\r\n this.notify(`获取成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbUpdate() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${this.dataTag}\"`\r\n )\r\n .update({\r\n num: 4\r\n })\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.updateUpdated = res.updated\r\n this.notify(`更新成功，更新了${res.updated}条数据`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbRemove() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('type')\r\n .where(\r\n `tag == \"${this.dataTag}\"`\r\n )\r\n .remove()\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.removeDeleted = res.deleted\r\n this.notify(`删除成功，删掉了${res.deleted}条数据`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbLookupInit() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n await db.collection('local')\r\n .where(`tag == \"${this.dataTag}\"`)\r\n .remove()\r\n .then(() : Promise<UniCloudDBRemoveResult> => {\r\n return db.collection('foreign')\r\n .where(`tag == \"${this.dataTag}\"`)\r\n .remove()\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('local')\r\n .add([{\r\n id: \"local_1\",\r\n name: \"local_1_name\",\r\n tag: this.dataTag,\r\n foreign_id: \"foreign_1\"\r\n }, {\r\n id: \"local_2\",\r\n name: \"local_2_name\",\r\n tag: this.dataTag,\r\n foreign_id: \"foreign_2\"\r\n }])\r\n })\r\n .then(() : Promise<UniCloudDBBatchAddResult> => {\r\n return db.collection('foreign')\r\n .add([{\r\n id: \"foreign_1\",\r\n name: \"foreign_1_name\",\r\n tag: this.dataTag\r\n }, {\r\n id: \"foreign_2\",\r\n name: \"foreign_2_name\",\r\n tag: this.dataTag\r\n }])\r\n })\r\n .then((_) : void => {\r\n uni.hideLoading()\r\n this.notify('数据初始化成功', '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n console.error(err)\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbLookup() : Promise<void> {\r\n uni.showLoading({\r\n title: '加载中...'\r\n })\r\n const db = uniCloud.databaseForJQL()\r\n const local = db.collection('local')\r\n .where(`tag == \"${this.dataTag}\"`)\r\n .getTemp()\r\n const foreign = db.collection('foreign')\r\n .where(`tag == \"${this.dataTag}\"`)\r\n .getTemp()\r\n await db.collection(local, foreign)\r\n .get()\r\n .then(res => {\r\n uni.hideLoading()\r\n console.log(res)\r\n this.lookupData = res.data\r\n this.notify(`联表查询成功，取到了${res.data.length}条数据`, '提示')\r\n })\r\n .catch((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n this.notify(error.errMsg, '错误')\r\n })\r\n },\r\n async dbMultiSend() : Promise<void> {\r\n const db = uniCloud.databaseForJQL()\r\n const temp1 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n const temp2 = db.collection('type')\r\n .where(\r\n 'tag == \"default-tag\"'\r\n ).getTemp()\r\n await db.multiSend(temp1, temp2)\r\n .then<void>(res => {\r\n uni.hideLoading()\r\n let successCount = 0\r\n for (let i = 0; i < res.dataList.length; i++) {\r\n const item = res.dataList[i]\r\n if (item.errCode == 0) {\r\n console.log(`第${i}个请求查询到${item.data!.length}条数据`)\r\n successCount++\r\n } else {\r\n console.error(`第${i}个请求查询失败，错误信息：${item.data!.length}`)\r\n }\r\n }\r\n this.multiSendSuccessCount = successCount\r\n this.notify(`合并查询成功，成功查询的语句条数为：${successCount}`, '提示')\r\n })\r\n .catch<void>((err : any | null) => {\r\n uni.hideLoading()\r\n const error = err as UniCloudError\r\n console.error(err)\r\n this.notify(error.errMsg, '错误')\r\n })\r\n }\r\n }\r\n }\r\n\n```\n\n:::"},"onResponse":{"name":"## onResponse(callback) @onresponse","description":"监听响应事件","compatibility":"### onResponse 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onResponse)"},"offResponse":{"name":"## offResponse(callback) @offresponse","description":"移除响应事件监听","compatibility":"### offResponse 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offResponse)"},"onRefreshToken":{"name":"## onRefreshToken(callback) @onrefreshtoken","description":"监听token刷新事件","compatibility":"### onRefreshToken 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.onRefreshToken)"},"offRefreshToken":{"name":"## offRefreshToken(callback) @offrefreshtoken","description":"移除token刷新事件监听","compatibility":"### offRefreshToken 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| callback | (UniCloudResponseEvent: [UniCloudResponseEvent](#unicloudresponseevent-values)) => any | 是 | - | - | - | \n\n### UniCloudResponseEvent 的属性值 @unicloudresponseevent-values \n\n| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| type | string | 是 | - | - | 响应事件类型 |\n| name | string | 是 | - | - | 响应事件由哪个云函数触发 |\n| content | any | 是 | - | - | 响应结果、错误内容 |\n","returnValue":"","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.offRefreshToken)"},"getCurrentUserInfo":{"name":"## getCurrentUserInfo() @getcurrentuserinfo","description":"获取token内缓存的用户信息","compatibility":"### getCurrentUserInfo 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 阿里云 3.9，腾讯云 3.91，支付宝云 3.98 | 4.11 |\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| **UniCloudUserInfo** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| uid | string | 否 | - | - | 用户id |\n@| role | Array\\<string\\> | 是 | - | - | 用户角色列表 |\n@| permission | Array\\<string\\> | 是 | - | - | 用户权限列表 |\n@| tokenExpired | number | 是 | - | - | 用户token过期时间 | \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.getCurrentUserInfo)"},"connectWebSocket":{"name":"## connectWebSocket(options) @connectwebsocket","description":"连接 WebSocket","compatibility":"### connectWebSocket 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.24 | 4.28 | 4.24 |\n","param":"### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **UniCloudConnectWebSocketOptions** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| name | string | 是 | - | - | WebSocket云函数/云对象名称 |\n@| query | any | 否 | - | - | 建立连接时需要传递的参数, 仅在 connection 事件中接收到 | \n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SocketTask |\n \n","tutorial":"\n### 参见\n- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.unicloud.utils.connectWebSocket)"}}
\ No newline at end of file
docs/component/button.md
浏览文件 @ c856a0fb
......@@ -29,7 +29,7 @@
## hover-class 属性值
## button样式修改@style
### button样式修改@style
button在元素的text区域直接写文字，和text组件一样。可以这么理解，button是一个特殊的text组件，文字样式可以直接写在button组件的style或class上。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或