From c036b00a54f24937823b4d6aa8a54a98270f5283 Mon Sep 17 00:00:00 2001 From: wanganxp Date: Wed, 11 Sep 2019 06:24:26 +0800 Subject: [PATCH] no message --- docs/api/README.md | 20 ++++++++- docs/api/_sidebar.md | 2 +- docs/api/arrayBufferToBase64.md | 2 +- docs/api/base64ToArrayBuffer.md | 2 +- docs/api/canvas/CanvasContext.md | 8 ++-- docs/api/file/file.md | 36 ++++++++-------- docs/api/file/getFileSystemManager.md | 4 +- docs/api/key.md | 4 +- docs/api/lifecycle.md | 16 ++++---- docs/api/log.md | 12 ------ docs/api/media/audio-context.md | 6 +-- docs/api/media/background-audio-manager.md | 13 +++--- docs/api/media/live-player-context.md | 19 +++++---- docs/api/other/advertisement.md | 11 +++-- docs/api/other/choose-address.md | 6 +-- docs/api/other/get-extconfig.md | 12 +++--- docs/api/other/getAccountInfoSync.md | 6 +-- docs/api/other/invoice-title.md | 6 +-- docs/api/other/set-enable-debug.md | 6 +-- docs/api/other/template.md | 42 +++++++++---------- docs/api/other/update.md | 6 +-- docs/api/plugins/login.md | 18 ++++---- docs/api/plugins/payment.md | 6 +-- docs/api/plugins/provider.md | 2 +- docs/api/router.md | 2 +- docs/api/ui/animation.md | 6 +-- docs/api/ui/bgcolor.md | 12 +++--- docs/api/ui/font.md | 6 +-- docs/api/ui/menuButton.md | 16 ++++---- docs/api/ui/navigationbar.md | 22 ++++++---- docs/api/ui/nodes-info.md | 6 +-- docs/api/ui/pulldown.md | 2 +- docs/api/ui/tabbar.md | 48 +++++++++++----------- docs/api/ui/window.md | 6 +-- docs/api/worker.md | 6 ++- docs/collocation/manifest.md | 19 ++++++--- docs/component/ad.md | 4 +- docs/component/button.md | 25 ++++++----- docs/component/canvas.md | 2 +- docs/component/live-pusher.md | 17 +++++--- 40 files changed, 252 insertions(+), 212 deletions(-) diff --git a/docs/api/README.md b/docs/api/README.md index 1fce98c4c..b35437c1f 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,11 +1,27 @@ -框架提供丰富的 API，可以方便的调起客户端提供的能力，如获取用户信息，本地存储，支付功能等。 +`uni-app`的js API由标准ECMAScript的js API 和 uni 扩展 API 这两部分组成。 -JS API命名与小程序相同。各端受自身限制，可能某些API无法使用，具体见每个API的兼容性说明。 +标准ecmascript的API非常多，本文档没有必要列全，仅以console、settimeout为例做简要说明。扩展 API 命名与小程序相同。 + +## 标准js和浏览器js的区别 + +`uni-app`的js代码，h5端运行于浏览器中。非h5端，Android平台运行在v8引擎中，iOS平台运行在iOS自带的jscore引擎中。 + +非H5端，虽然不支持window、document、navigator等浏览器的js API，但也支持标准ECMAScript。 + +开发者不要把浏览器里的js等价于标准js。 + +ECMAScript由Ecma国际管理，是基础js语法。浏览器基于标准js扩充了window、document等js API；Node.js基于标准js扩充了fs等模块；小程序也基于标准js扩展了各种wx.xx、my.xx、swan.xx的API。 + +所以uni-app的非H5端，一样支持标准js，支持if、for等语法，支持字符串、数组、时间等变量及各种处理方法。仅仅是不支持浏览器专用对象。 + +## 各端特色API调用 除了uni-app框架内置的跨端API，各端自己的特色API也可通过[条件编译](https://uniapp.dcloud.io/platform)自由使用。 各端特色API规范参考各端的开发文档。其中App端的JS API参考[html5plus.org](https://www.html5plus.org/doc/h5p.html)；uni-app也支持通过扩展原生插件来丰富App端的开发能力，具体参考[插件开发文档](http://ask.dcloud.net.cn/article/35408) +各平台的API新增，不需要uni-app升级，开发者就可以直接使用。 + ## 说明 - uni.on 开头的 API 是监听某个事件发生的 API 接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数。 diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md index f7c8aa395..325fdcefe 100644 --- a/docs/api/_sidebar.md +++ b/docs/api/_sidebar.md @@ -64,7 +64,7 @@ * [电量](api/system/batteryInfo.md) * [NFC](api/system/nfc.md) * [设备方向](api/system/deviceMotion.md) -* [Worker](api/worder.md) +* [Worker](api/worker.md) * 键盘 * [uni.hideKeyboard](/api/key?id=hidekeyboard) * [uni.onKeyboardHeightChange](/api/key?id=onkeyboardheightchange) diff --git a/docs/api/arrayBufferToBase64.md b/docs/api/arrayBufferToBase64.md index 9f03654e0..18765d89c 100644 --- a/docs/api/arrayBufferToBase64.md +++ b/docs/api/arrayBufferToBase64.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|x|x|x| diff --git a/docs/api/base64ToArrayBuffer.md b/docs/api/base64ToArrayBuffer.md index 1146f5aba..a063fd324 100644 --- a/docs/api/base64ToArrayBuffer.md +++ b/docs/api/base64ToArrayBuffer.md @@ -4,7 +4,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| |√|x|√|x|x|x| diff --git a/docs/api/canvas/CanvasContext.md b/docs/api/canvas/CanvasContext.md index 096364d59..b5dac7102 100644 --- a/docs/api/canvas/CanvasContext.md +++ b/docs/api/canvas/CanvasContext.md @@ -2,9 +2,11 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|x|√| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|√|√| + +App-nvue下如需使用canvas，暂未封装为uni API，可参考[文档](https://github.com/dcloudio/NvueCanvasDemo)使用。 ### CanvasContext.fillStyle string diff --git a/docs/api/file/file.md b/docs/api/file/file.md index b5006944e..9e44219f4 100644 --- a/docs/api/file/file.md +++ b/docs/api/file/file.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **注意：saveFile 会把临时文件移动，因此调用成功后传入的 tempFilePath 将不可用。** @@ -45,9 +45,9 @@ uni.chooseImage({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **OBJECT 参数说明：** @@ -87,9 +87,9 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|x|√| **OBJECT 参数说明：** @@ -125,9 +125,9 @@ uni.getSavedFileInfo({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **OBJECT 参数说明：** @@ -160,9 +160,9 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **OBJECT 参数说明：** @@ -187,9 +187,9 @@ uni.getSavedFileList({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|x|√| **OBJECT 参数说明：** diff --git a/docs/api/file/getFileSystemManager.md b/docs/api/file/getFileSystemManager.md index eab6e4998..5650d6e85 100644 --- a/docs/api/file/getFileSystemManager.md +++ b/docs/api/file/getFileSystemManager.md @@ -3,4 +3,6 @@ 获取全局唯一的文件管理器 -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getFileSystemManager.html) \ No newline at end of file +- 微信小程序平台，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getFileSystemManager.html) +- 头条小程序平台，[规范详情](https://developer.toutiao.com/docs/api/getFileSystemManager.html) +- QQ小程序平台，[规范详情](https://q.qq.com/wiki/develop/miniprogram/API/file/qq.getFileSystemManager.html) \ No newline at end of file diff --git a/docs/api/key.md b/docs/api/key.md index 66b3d73d9..b93065bd4 100644 --- a/docs/api/key.md +++ b/docs/api/key.md @@ -6,7 +6,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|√|√|√|x|√|√| @@ -17,7 +17,7 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√| diff --git a/docs/api/lifecycle.md b/docs/api/lifecycle.md index c4a7fa516..6669916b5 100644 --- a/docs/api/lifecycle.md +++ b/docs/api/lifecycle.md @@ -25,17 +25,17 @@ |onReady|监听页面初次渲染完成。注意如果渲染速度快，会在页面进入动画完成前触发||| |onHide|监听页面隐藏||| |onUnload|监听页面卸载||| -|onResize|监听窗口尺寸变化|5+App、微信小程序|| +|onResize|监听窗口尺寸变化|App、微信小程序|| |onPullDownRefresh|监听用户下拉动作，一般用于下拉刷新，参考[示例](api/ui/pulldown)||| |onReachBottom|页面滚动到底部的事件（不是scroll-view滚到底），常用于上拉加载下一页数据。如使用scroll-view导致页面级没有滚动，则触底事件不会被触发||| -|onTabItemTap|点击 tab 时触发，参数为Object，具体见下方注意事项|微信小程序、百度小程序、H5、5+App（自定义组件模式）|| +|onTabItemTap|点击 tab 时触发，参数为Object，具体见下方注意事项|微信小程序、百度小程序、H5、App（自定义组件模式）|| |onShareAppMessage|用户点击右上角分享|微信小程序、百度小程序、头条小程序、支付宝小程序|| |onPageScroll|监听页面滚动，参数为Object||| -|onNavigationBarButtonTap|监听原生标题栏按钮点击事件，参数为Object|5+ App、H5|| -|onBackPress|监听页面返回，返回 event = {from:backbutton、 navigateBack} ，backbutton 表示来源是左上角返回按钮或 android 返回键；navigateBack表示来源是 uni.navigateBack ；详细说明及使用：[onBackPress 详解](http://ask.dcloud.net.cn/article/35120)|5+App、H5|| -|onNavigationBarSearchInputChanged|监听原生标题栏搜索输入框输入内容变化事件|5+App、H5|1.6.0| -|onNavigationBarSearchInputConfirmed|监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。|5+App、H5|1.6.0| -|onNavigationBarSearchInputClicked|监听原生标题栏搜索输入框点击事件|5+App、H5|1.6.0| +|onNavigationBarButtonTap|监听原生标题栏按钮点击事件，参数为Object|App、H5|| +|onBackPress|监听页面返回，返回 event = {from:backbutton、 navigateBack} ，backbutton 表示来源是左上角返回按钮或 android 返回键；navigateBack表示来源是 uni.navigateBack ；详细说明及使用：[onBackPress 详解](https://ask.dcloud.net.cn/article/35120)|App、H5|| +|onNavigationBarSearchInputChanged|监听原生标题栏搜索输入框输入内容变化事件|App、H5|1.6.0| +|onNavigationBarSearchInputConfirmed|监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。|App、H5|1.6.0| +|onNavigationBarSearchInputClicked|监听原生标题栏搜索输入框点击事件|App、H5|1.6.0| ``onPageScroll`` 参数说明： @@ -80,4 +80,4 @@ export default { **注意** -- nvue 页面支持的生命周期参考：[nvue 生命周期介绍](/use-weex?id=生命周期)。 +- nvue 页面的weex编译模式支持的生命周期，[参考](/use-weex?id=生命周期)。 diff --git a/docs/api/log.md b/docs/api/log.md index ca50c825c..645be1efb 100644 --- a/docs/api/log.md +++ b/docs/api/log.md @@ -1,15 +1,3 @@ -`uni-app`的js代码，h5端运行于浏览器中。非h5端，Android平台运行在v8引擎中，iOS平台运行在iOS自带的jscore引擎中。 - -即便非H5端，虽然不支持window、document、navigator等浏览器的js API，但也支持标准ECMAScript。 - -开发者不要把浏览器里的js等价于标准js。 - -ECMAScript由Ecma国际管理，是基础js语法。浏览器基于标准js扩充了window、document等js API；Node.js基于标准js扩充了fs等模块；小程序也基于标准js扩展了各种wx.xx、my.xx、swan.xx的API。 - -所以uni-app的非H5端，一样支持标准js，支持if、for等语法，支持字符串、数组、时间等变量及各种处理方法。仅仅是不支持浏览器专用对象。 - -标准ecmascript的API非常多，这里没有必要列全，仅以console、settimeout为例做简要说明。 - ## console 向控制台打印日志信息。 ### debug diff --git a/docs/api/media/audio-context.md b/docs/api/media/audio-context.md index 7b38c744a..85a1f3c89 100644 --- a/docs/api/media/audio-context.md +++ b/docs/api/media/audio-context.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|x|√|√|√| **innerAudioContext 对象的属性列表** diff --git a/docs/api/media/background-audio-manager.md b/docs/api/media/background-audio-manager.md index 261f5ab02..637a2f690 100644 --- a/docs/api/media/background-audio-manager.md +++ b/docs/api/media/background-audio-manager.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|x|√|x|√| **backgroundAudioManager 对象的属性列表** @@ -64,6 +64,7 @@ bgAudioMannager.src = 'https://img-cdn-qiniu.dcloud.net.cn/uniapp/audio/music.mp ``` -Tips: - -* ios应用背景播放需在manifest.json -> app-plus -> distribute -> ios 节点添加 ``"UIBackgroundModes":["audio"]`` 才能保证音乐可以后台播放（打包成ipa生效）。 \ No newline at end of file +**注意** +因为背景音频播放耗费手机电量，所以平台都有管控，需在manifest中填写申请。 +- ios App平台，背景播放需在manifest.json -> app-plus -> distribute -> ios 节点添加 ``"UIBackgroundModes":["audio"]`` 才能保证音乐可以后台播放（打包成ipa生效） +- 小程序平台，需在manifest.json 对应的小程序节点下，填写"requiredBackgroundModes": ["audio"]。发布小程序时平台会审核 \ No newline at end of file diff --git a/docs/api/media/live-player-context.md b/docs/api/media/live-player-context.md index 16226be66..ae08cef2a 100644 --- a/docs/api/media/live-player-context.md +++ b/docs/api/media/live-player-context.md @@ -52,10 +52,19 @@ App平台的直播播放，不使用此API，而直接使用video的API。 **平台差异说明** -|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|见下|x|√|x|x|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|见下|x|√|x|x|x|x| + +- app-nvue 平台 2.2.5(alpha)+ 支持 uni.createLivePusherContext(livePusherId, this) +- app-nvue 平台 2.2.5(alpha)- 需要同时设置组件属性id和ref ````，或者直接使用 ref，例如 ``this.$refs.livepusher1`` +- app-vue 平台，需要编写条件编译代码，使用 `plus.video.LivePusher`，[业务指南](https://ask.dcloud.net.cn/article/13416)、[规范文档](http://www.html5plus.org/doc/zh_cn/video.html#plus.video.LivePusher) +使用nvue做直播，比使用vue的优势有： +1. nvue可一套代码直接编译到App和微信 +2. nvue的cover-view比vue的cover-view更强大，在视频上绘制元素更容易。如果只考虑App端的话，不用cover-view，任意组件都可以覆盖live-pusher组件 +3. 若需要视频内嵌在swiper里上下滑动（类抖音、映客首页模式），App端只有nvue才能实现 +当然nvue相比vue的坏处是css写法受限，如果只开发微信小程序，不考虑App，那么使用vue页面也是一样的。 **参数说明** @@ -70,10 +79,6 @@ auto-focus|Boolean|true|否|自动聚集。 beauty|Number|0|否|美颜，取值范围 0-9（iOS取值范围为1） ，0 表示关闭。 whiteness|Number|0|否|美白，取值范围 0-9（iOS取值范围为1） ，0 表示关闭。 -**注意：** -- app-nvue 平台 2.2.5(alpha)+ 支持 uni.createLivePusherContext(livePusherId, this) -- app-nvue 平台 2.2.5(alpha)- 需要同时设置组件属性id和ref ````，或者直接使用 ref，例如 ``this.$refs.livepusher1`` - #### API #### start(callback) > 开始推流 diff --git a/docs/api/other/advertisement.md b/docs/api/other/advertisement.md index aac6e024f..65d2c0d6a 100644 --- a/docs/api/other/advertisement.md +++ b/docs/api/other/advertisement.md @@ -1,7 +1,12 @@ #### 广告 -仅微信小程序平台、App平台支持 +广告API -微信小程序平台实现参考：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.createRewardedVideoAd.html) +广告能力在不同小程序端实现不同，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 -App平台实现参考：[DCloud广告联盟](http://ask.dcloud.net.cn/article/13084) \ No newline at end of file +- App平台：无需编码，在打包App时可直接勾选广告位，[详见](https://dcloud.io/dad.html) +- 微信小程序：[规范文档](https://developers.weixin.qq.com/miniprogram/dev/api/wx.createRewardedVideoAd.html) +- 百度小程序：有组件但无API +- 支付宝小程序：不支持此能力 +- 头条小程序：仅小游戏可用，小程序不可用，不适用于uni-app +- QQ小程序：[规范文档](https://q.qq.com/wiki/develop/miniprogram/API/ad/qq.createRewardedVideoAd.html) \ No newline at end of file diff --git a/docs/api/other/choose-address.md b/docs/api/other/choose-address.md index 076849e40..c554d0538 100644 --- a/docs/api/other/choose-address.md +++ b/docs/api/other/choose-address.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|√|x| **OBJECT参数说明** diff --git a/docs/api/other/get-extconfig.md b/docs/api/other/get-extconfig.md index 5a46ff914..7bce3d799 100644 --- a/docs/api/other/get-extconfig.md +++ b/docs/api/other/get-extconfig.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|√|x| **OBJECT参数说明** @@ -45,9 +45,9 @@ if (uni.getExtConfig) { **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|√|x| **返回值(Object)** diff --git a/docs/api/other/getAccountInfoSync.md b/docs/api/other/getAccountInfoSync.md index 626bd2a53..08c8fda74 100644 --- a/docs/api/other/getAccountInfoSync.md +++ b/docs/api/other/getAccountInfoSync.md @@ -5,9 +5,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|√| **返回值** diff --git a/docs/api/other/invoice-title.md b/docs/api/other/invoice-title.md index 47ac905c6..71bbe04c2 100644 --- a/docs/api/other/invoice-title.md +++ b/docs/api/other/invoice-title.md @@ -6,9 +6,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **OBJECT参数说明** diff --git a/docs/api/other/set-enable-debug.md b/docs/api/other/set-enable-debug.md index 9a22fe71e..3053a9a89 100644 --- a/docs/api/other/set-enable-debug.md +++ b/docs/api/other/set-enable-debug.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|√| **OBJECT说明** diff --git a/docs/api/other/template.md b/docs/api/other/template.md index 97a34ddfe..087a25dca 100644 --- a/docs/api/other/template.md +++ b/docs/api/other/template.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** @@ -66,9 +66,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templateadd?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** ``` @@ -120,9 +120,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** @@ -229,9 +229,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/libraryget?access_toke **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** @@ -318,9 +318,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/librarylist?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** @@ -416,9 +416,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatelist?access_to **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|x| **请求地址** @@ -549,9 +549,9 @@ POST https://openapi.baidu.com/rest/2.0/smartapp/template/templatedel?access_tok **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|x|√|x|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|x|√|x|x|x| **请求地址** diff --git a/docs/api/other/update.md b/docs/api/other/update.md index 71ae914fa..4acc78c2e 100644 --- a/docs/api/other/update.md +++ b/docs/api/other/update.md @@ -8,9 +8,9 @@ App的更新不使用本API，另见文档： **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|√| **updateManager 对象的方法列表：** diff --git a/docs/api/plugins/login.md b/docs/api/plugins/login.md index 37ebb9d11..e698e1a8a 100644 --- a/docs/api/plugins/login.md +++ b/docs/api/plugins/login.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| H5平台登陆注意事项： - 微信内嵌浏览器运行H5版时，可通过js sdk实现微信登陆，需要引入一个单独的js，[详见](https://ask.dcloud.net.cn/article/35380) @@ -56,9 +56,9 @@ uni.login({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|√|√| |属性|类型|必填|说明| |:-|:-|:-|:-| @@ -73,9 +73,9 @@ uni.login({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **注意：** 微信小程序端，在用户未授权过的情况下调用此接口，不会出现授权弹窗，会直接进入 fail 回调（详见[《微信小程序公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01)）。在用户已授权的情况下调用此接口，可成功获取用户信息。 diff --git a/docs/api/plugins/payment.md b/docs/api/plugins/payment.md index 77cb82b0a..338f6e5a3 100644 --- a/docs/api/plugins/payment.md +++ b/docs/api/plugins/payment.md @@ -11,9 +11,9 @@ uni.requestPayment是一个统一各平台的客户端支付API，不管是在 **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|[说明](/api/plugins/payment?id=h5-payment)|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|[说明](/api/plugins/payment?id=h5-payment)|√|√|√|√|√| **OBJECT 参数说明** diff --git a/docs/api/plugins/provider.md b/docs/api/plugins/provider.md index 0069bfeec..89dc2e0fa 100644 --- a/docs/api/plugins/provider.md +++ b/docs/api/plugins/provider.md @@ -1,5 +1,5 @@ ### uni.getProvider(OBJECT) -获取服务供应商。 +获取服务供应商。仅App平台支持。 在App平台，可用的服务商，是打包环境中配置的服务商，与手机端安装了什么app没有关系。 diff --git a/docs/api/router.md b/docs/api/router.md index 15dafabcc..3d22b415e 100644 --- a/docs/api/router.md +++ b/docs/api/router.md @@ -177,7 +177,7 @@ Tips： * 不能在 ```App.vue``` 里面进行页面跳转。 #### 窗口动画@animation -> 本API仅App端vue页面支持。小程序自身不支持自定义动画。app下纯nvue项目也暂不支持。H5的窗体动画可使用常规单页动画处理方案，见[H5下单页动画示例](https://ext.dcloud.net.cn/plugin?id=659&tdsourcetag=s_pctim_aiomsg) +> 本API仅App端vue页面支持。小程序自身不支持自定义动画。app下纯nvue项目也暂不支持（固定为pop-in动画）。H5的窗体动画可使用常规单页动画处理方案，见[H5下单页动画示例](https://ext.dcloud.net.cn/plugin?id=659&tdsourcetag=s_pctim_aiomsg) 窗口的显示/关闭动画效果，支持在 API、组件、pages.json 中配置，优先级为：`API = 组件 > pages.json`。 diff --git a/docs/api/ui/animation.md b/docs/api/ui/animation.md index 049b0338e..b0b619a7e 100644 --- a/docs/api/ui/animation.md +++ b/docs/api/ui/animation.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|HBuilderX 2.0.4+|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|HBuilderX 2.0.4+|√|√|√|√|√| **注意:** - export 方法每次调用后会清掉之前的动画操作 diff --git a/docs/api/ui/bgcolor.md b/docs/api/ui/bgcolor.md index cebb9c4b7..637b86a50 100644 --- a/docs/api/ui/bgcolor.md +++ b/docs/api/ui/bgcolor.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|√| **参数说明** @@ -35,9 +35,9 @@ uni.setBackgroundColor({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|√| **参数说明** diff --git a/docs/api/ui/font.md b/docs/api/ui/font.md index c148346be..617a83e5c 100644 --- a/docs/api/ui/font.md +++ b/docs/api/ui/font.md @@ -12,9 +12,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|1.9.0+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|基础库 2.1.0+|x|x|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|1.9.0+ [自定义组件编译模式](https://ask.dcloud.net.cn/article/35843)|x|基础库 2.1.0+|x|x|x|x| **参数说明** diff --git a/docs/api/ui/menuButton.md b/docs/api/ui/menuButton.md index 696935863..e307b7325 100644 --- a/docs/api/ui/menuButton.md +++ b/docs/api/ui/menuButton.md @@ -6,19 +6,19 @@ **平台差异说明** -|5+App|H5 |微信小程序 |支付宝小程序 |百度小程序 |头条小程序 |QQ小程序 | -|:-: |:-:|:-: |:-: |:-: |:-: |:-: | -|x |x |√ |x |√ |√ |√ | +|5+App |H5 |微信小程序 |支付宝小程序 |百度小程序 |头条小程序 |QQ小程序 | +|:-: |:-:|:-: |:-: |:-: |:-: |:-: | +|x |x |√ |x |√ |√ |√ | **返回值说明** -|属性 |类型 |说明 | -|width |number |宽度，单位：px | -|height |number |高度，单位：px | -|top |number |上边界坐标，单位：px | +|属性 |类型 |说明 | +|width |number |宽度，单位：px | +|height |number |高度，单位：px | +|top |number |上边界坐标，单位：px | |right |number |右边界坐标，单位：px | |bottom |number |下边界坐标，单位：px | -|left |number |左边界坐标，单位：px | +|left |number |左边界坐标，单位：px | **示例** diff --git a/docs/api/ui/navigationbar.md b/docs/api/ui/navigationbar.md index 210fc81d9..f14cde54c 100644 --- a/docs/api/ui/navigationbar.md +++ b/docs/api/ui/navigationbar.md @@ -26,9 +26,9 @@ uni.setNavigationBarTitle({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明** @@ -82,9 +82,11 @@ uni.setNavigationBarColor({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|√|√|√|√|x|√| + +App平台调用此API时会在屏幕中间悬浮显示loading **OBJECT参数说明** @@ -106,9 +108,11 @@ uni.showNavigationBarLoading() **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|√|√|√|√|x|√| + +App平台调用此API时会关闭屏幕中间悬浮显示的loading **OBJECT参数说明** diff --git a/docs/api/ui/nodes-info.md b/docs/api/ui/nodes-info.md index ffcd0a7db..537403aa4 100644 --- a/docs/api/ui/nodes-info.md +++ b/docs/api/ui/nodes-info.md @@ -108,9 +108,9 @@ query.select('#id').boundingClientRect(data => { **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|x|x|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|x|x|x|√| **callback 返回参数** diff --git a/docs/api/ui/pulldown.md b/docs/api/ui/pulldown.md index f3d2045ae..166a92337 100644 --- a/docs/api/ui/pulldown.md +++ b/docs/api/ui/pulldown.md @@ -77,7 +77,7 @@ export default { ### FAQ Q：如何暂时禁用掉下拉刷新，待需要的时候再重新开启？ -A：`5+App` 平台下可以处理此类场景，详细参考：[uni-app 中实现动态禁用/开启下拉刷新](https://ask.dcloud.net.cn/article/35134) +A：`App` 平台下可以处理此类场景，详细参考：[uni-app 中实现动态禁用/开启下拉刷新](https://ask.dcloud.net.cn/article/35134) Q：自定义title如何让下拉刷新在title之下 A：App和H5端使用circle方式的下拉刷新，设offset在title高度之下。hello uni-app的模板-导航栏中有示例。小程序端无法实现，除非放弃原生下拉刷新，自己模拟下拉刷新，插件市场有类似插件，但性能不如原生下拉刷新。 diff --git a/docs/api/ui/tabbar.md b/docs/api/ui/tabbar.md index f746dfce1..64a94855f 100644 --- a/docs/api/ui/tabbar.md +++ b/docs/api/ui/tabbar.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -37,9 +37,9 @@ uni.setTabBarItem({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -70,9 +70,9 @@ uni.setTabBarStyle({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -89,9 +89,9 @@ uni.setTabBarStyle({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -107,9 +107,9 @@ uni.setTabBarStyle({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -135,9 +135,9 @@ uni.setTabBarBadge({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -153,9 +153,9 @@ uni.setTabBarBadge({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** @@ -171,9 +171,9 @@ uni.setTabBarBadge({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|√| **OBJECT参数说明：** diff --git a/docs/api/ui/window.md b/docs/api/ui/window.md index f3f0c62b3..4afd970ce 100644 --- a/docs/api/ui/window.md +++ b/docs/api/ui/window.md @@ -5,9 +5,9 @@ **平台差异说明** -|5+App|H5|微信小程序 |支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√(nvue不支持)|√|√|x|x|x| +|5+App|H5|微信小程序 |支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√(nvue不支持)|√|√|x|x|x|√| **CALLBACK 参数说明** diff --git a/docs/api/worker.md b/docs/api/worker.md index 9e5b64a96..5c6ae8040 100644 --- a/docs/api/worker.md +++ b/docs/api/worker.md @@ -1,3 +1,7 @@ #### Worker -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html) \ No newline at end of file +目前需分平台编写 + +- 微信小程序：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html) +- 头条小程序：[规范详情](https://developer.toutiao.com/docs/game/worker/tt.createWorker.html) +- QQ小程序：[规范详情](https://q.qq.com/wiki/develop/miniprogram/API/worker/worker.html) \ No newline at end of file diff --git a/docs/collocation/manifest.md b/docs/collocation/manifest.md index 33605f21a..6b0ba1d97 100644 --- a/docs/collocation/manifest.md +++ b/docs/collocation/manifest.md @@ -296,7 +296,7 @@ Tips：关于摇树优化（treeShaking）原理及优化结果，参考：[http |resizable|Boolean|在iPad上小程序是否支持屏幕旋转，默认关闭| |navigateToMiniProgramAppIdList|Array|需要跳转的小程序列表，[详见](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/miniprogram-navigate/wx.navigateToMiniProgram.html)| |permission|Object|微信小程序接口权限相关设置，比如申请位置权限必须填此处[详见](https://developers.weixin.qq.com/miniprogram/dev/framework/config.html)| -|workers|String|Worker 代码放置的目录，**HBuilderX 2.0.0+ Alpha** 支持。 [详见](https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html)| +|workers|String|Worker 代码放置的目录。 [详见](https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html)| #### setting @@ -321,6 +321,8 @@ Tips：关于摇树优化（treeShaking）原理及优化结果，参考：[http |:-|:-|:-| |appid|String|百度小程序的 AppID，登录 [https://smartprogram.baidu.com/docs/introduction/enter_application/](https://smartprogram.baidu.com/docs/introduction/enter_application/) 申请| |usingComponents|Boolean| 是否启用自定义组件模式，`v2.0+`，默认为false，[编译模式区别详情](https://ask.dcloud.net.cn/article/35843)| +|requiredBackgroundModes|Array|小程序需要在后台使用的能力，目前支持背景音频播放，"requiredBackgroundModes": ["audio"]，[详见](https://smartprogram.baidu.com/docs/develop/tutorial/process/#requiredBackgroundModes) | +|prefetches|Array|预请求的所有url的列表，[详见](https://smartprogram.baidu.com/docs/develop/tutorial/process/#prefetches) | ### mp-toutiao @@ -329,6 +331,7 @@ Tips：关于摇树优化（treeShaking）原理及优化结果，参考：[http |appid|String|头条小程序的 AppID，登录 [https://developer.toutiao.com/](https://developer.toutiao.com/) 申请| |setting|Object|头条小程序项目设置，参考[头条小程序项目设置](/collocation/manifest?id=mp-toutiao-setting)| |usingComponents|Boolean| 是否启用自定义组件模式，`v2.0+`，默认为false，[编译模式区别详情](https://ask.dcloud.net.cn/article/35843)| +|navigateToMiniProgramAppIdList |Array|需要跳转的小程序列表，[详见](https://developer.toutiao.com/docs/framework/globalSetting.html#%E5%85%A8%E5%B1%80%E9%85%8D%E7%BD%AE) | #### 头条小程序项目设置@mp-toutiao-setting @@ -341,10 +344,16 @@ Tips：关于摇树优化（treeShaking）原理及优化结果，参考：[http ### mp-qq -|属性|类型|说明| -|:-|:-|:-| -|appid|String|qq 小程序的 AppID，登录 [https://q.qq.com](https://q.qq.com) 申请| -|usingComponents|Boolean| 是否启用自定义组件模式，`v2.0+`，默认为false，[编译模式区别详情](https://ask.dcloud.net.cn/article/35843)。mp-qq只支持自定义组件模式| +|属性 |类型 |说明 | +|:- |:- |:- | +|appid |String |qq 小程序的 AppID，登录 [https://q.qq.com](https://q.qq.com) 申请 | +|requiredBackgroundModes |Array |小程序需要在后台使用的能力，目前支持背景音频播放，"requiredBackgroundModes": ["audio"]，[详见](https://q.qq.com/wiki/develop/miniprogram/frame/dispose.html#requiredbackgroundmodes) | +|navigateToMiniProgramAppIdList |Array |需要跳转的小程序列表，[详见](https://q.qq.com/wiki/develop/miniprogram/frame/dispose.html#navigatetominiprogramappidlist) | +|permission |Object |小程序接口权限相关设置，比如申请位置权限必须填此处[详见](https://q.qq.com/wiki/develop/miniprogram/frame/dispose.html#permission) | +|workers |String |Worker 代码放置的目录。 [详见](https://q.qq.com/wiki/develop/miniprogram/frame/dispose.html#workers) | +|groupIdList |String Array |需要打开群资料卡的群号列表，详见button的open-type | + +mp-qq只支持自定义组件模式，不存在usingComponents配置 ### 完整 manifest.json diff --git a/docs/component/ad.md b/docs/component/ad.md index 342c42676..ab5981d4d 100644 --- a/docs/component/ad.md +++ b/docs/component/ad.md @@ -1,12 +1,12 @@ #### ad -Banner 广告。 +广告组件 广告能力在不同小程序端实现不同，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 +- App平台：无需编码，在打包App时可直接勾选广告位，[详见](https://dcloud.io/dad.html) - 微信小程序：[规范文档](https://developers.weixin.qq.com/miniprogram/dev/component/ad.html) - 百度小程序：[规范文档](https://smartprogram.baidu.com/docs/develop/component/ad/) - 支付宝小程序：不支持此能力 - 头条小程序：仅小游戏可用，小程序不可用，不适用于uni-app - QQ小程序：[规范文档](https://q.qq.com/wiki/develop/miniprogram/component/open-ability/ad.html) -- App平台：无需编码，在打包App时可直接勾选广告位，[详见](https://dcloud.io/dad.html) diff --git a/docs/component/button.md b/docs/component/button.md index cddb602db..b3996ffc5 100644 --- a/docs/component/button.md +++ b/docs/component/button.md @@ -51,21 +51,20 @@ |值|说明|平台差异说明| |:-|:-|:-| -|feedback|打开“意见反馈”页面，用户可提交反馈内容并上传日志|5+App、微信小程序| -|share|触发用户转发|微信小程序、百度小程序、支付宝小程序、头条小程序| -|getUserInfo|获取用户信息，可以从@getuserinfo回调中获取到用户信息，包括手机号、头像、昵称等信息|微信小程序、百度小程序| -| contact | 打开客服会话，如果用户在会话中点击消息卡片后返回应用，可以从 @contact 回调中获得具体信息 |微信小程序| -| getPhoneNumber | 获取用户手机号，可以从@getphonenumber回调中获取到用户信息|微信小程序、百度小程序、头条小程序 | -| launchApp | 打开APP，可以通过app-parameter属性设定向APP传的参数|微信小程序| -| openSetting | 打开授权设置页 |微信小程序、百度小程序| -| getAuthorize | 支持小程序授权 | 支付宝小程序 | -| contactShare | 分享到通讯录好友 | 支付宝小程序 | -| lifestyle | 关注生活号 | 支付宝小程序 | - - +|feedback|打开“意见反馈”页面，用户可提交反馈内容并上传日志|App、微信小程序、QQ小程序| +|share|触发用户转发|微信小程序、百度小程序、支付宝小程序、头条小程序、QQ小程序| +|getUserInfo|获取用户信息，可以从@getuserinfo回调中获取到用户信息，包括手机号、头像、昵称等信息|微信小程序、百度小程序、QQ小程序| +|contact | 打开客服会话，如果用户在会话中点击消息卡片后返回应用，可以从 @contact 回调中获得具体信息 |微信小程序、百度小程序| +|getPhoneNumber | 获取用户手机号，可以从@getphonenumber回调中获取到用户信息|微信小程序、百度小程序、头条小程序 | +|launchApp | 打开APP，可以通过app-parameter属性设定向APP传的参数|[微信小程序](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html)、[QQ小程序](https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_app.html)| +|openSetting | 打开授权设置页 |微信小程序、百度小程序| +|getAuthorize | 支持小程序授权 | 支付宝小程序 | +|contactShare | 分享到通讯录好友 | 支付宝小程序 | +|lifestyle | 关注生活号 | 支付宝小程序 | +|openGroupProfile|呼起QQ群资料卡页面，可以通过group-id属性设定需要打开的群资料卡的群号，同时manifest中必须配置groupIdList|QQ小程序基础库1.4.7版本+| **注意** -- 在小程序中，开发者可以登录 [小程序管理后台](https://mp.weixin.qq.com/) 后进入左侧菜单“客服反馈”页面获取反馈内容。 +- 在小程序中，开发者可以登录 [微信小程序管理后台](https://mp.weixin.qq.com/) 、[QQ小程序后台](https://q.qq.com/#/)后，进入菜单“客服反馈”页面获取反馈内容。 - 在 App 中，开发者登录 [DCloud开发者中心](https://dev.dcloud.net.cn/) 后点击应用名称，进入左侧菜单“用户反馈”页面获取反馈内容。 - 点击 share 分享按钮时会触发 [onShareAppMessage](/api/plugins/share) - 支付宝小程序平台，获取用户手机号时，建议先通过条件编译的方式，调用支付宝原生API，[参考](https://docs.alipay.com/mini/api/getphonenumber) diff --git a/docs/component/canvas.md b/docs/component/canvas.md index f17b533d4..7e4f61d53 100644 --- a/docs/component/canvas.md +++ b/docs/component/canvas.md @@ -20,7 +20,7 @@ * canvas 标签默认宽度 300px、高度 225px，动态修改 canvas 大小后需要重新绘制。 * 同一页面中的 canvas-id 不可重复，如果使用一个已经出现过的 canvas-id，该 canvas 标签对应的画布将被隐藏并不再正常工作。 * canvas 在微信小程序、百度小程序、QQ小程序中为原生组件，层级高于前端组件，请勿内嵌在 scroll-view、swiper、picker-view、movable-view 中使用。解决 canvas 层级过高无法覆盖，参考 [native-component](/component/native-component)。 -* canvas 在App端 vue 页面不是原生组件，目前App端 nvue 还不支持 canvas 组件。 +* canvas 在App端 vue 页面不是原生组件。App-nvue下如需使用canvas，暂未封装为uni API，可参考[文档](https://github.com/dcloudio/NvueCanvasDemo)使用。 **示例：** diff --git a/docs/component/live-pusher.md b/docs/component/live-pusher.md index 4d9545806..a729188cf 100644 --- a/docs/component/live-pusher.md +++ b/docs/component/live-pusher.md @@ -2,15 +2,20 @@ 实时音视频录制，也称直播推流。 -- 微信小程序：[规范文档](https://developers.weixin.qq.com/miniprogram/dev/component/live-pusher.html) -- App平台：nvue文件下也支持live-pusher组件，API与微信相同。如果是vue文件，则需要单独编写条件编译代码，使用plus.video.LivePusher，[业务指南](https://ask.dcloud.net.cn/article/13416)、[规范文档](http://www.html5plus.org/doc/zh_cn/video.html#plus.video.LivePusher) - - **平台差异说明** |App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|x|x|x|x| +|√(仅nvue)|x|√|x|x|x|x| + +如app平台的vue页面需要支持直播推流，需编写条件编译代码，使用 `plus.video.LivePusher`，[业务指南](https://ask.dcloud.net.cn/article/13416)、[规范文档](http://www.html5plus.org/doc/zh_cn/video.html#plus.video.LivePusher) + +使用nvue做直播，比使用vue的优势有： +1. nvue可一套代码直接编译到App和微信 +2. nvue的cover-view比vue的cover-view更强大，在视频上绘制元素更容易。如果只考虑App端的话，不用cover-view，任意组件都可以覆盖live-pusher组件，因为nvue没有层级问题。 +3. 若需要视频内嵌在swiper里上下滑动（类抖音、映客首页模式），App端只有nvue才能实现 +当然nvue相比vue的坏处是css写法受限，如果只开发微信小程序，不考虑App，那么使用vue页面也是一样的。 + **参数说明** @@ -118,5 +123,5 @@ whiteness|Number|0|否|美白，取值范围 0-9（iOS取值范围为1） ，0 **注意** -* live-pusher 是原生组件，在小程序端层级高于前端组件，请勿在 scroll-view、swiper、picker-view、movable-view 中使用，需使用cover-view覆盖。在App端的nvue文件中，live-pusher没有这类限制。 +* live-pusher 是原生组件，在小程序端层级高于前端组件，需使用cover-view覆盖。在低版本微信中，live-pusher无法内嵌于 scroll-view、swiper、picker-view、movable-view 中。在App端的nvue文件中，live-pusher没有这类限制。 * App平台：使用 `` 组件，打包 App 时必须勾选 manifest.json->App 模块权限配置->LivePusher(直播推流) 模块。 -- GitLab