diff --git a/README.md b/README.md index bd9b4b4a23e7ca083d78d59ef0239aef434a877b..781cb65ef111274241509ef08a996b4e1a8be8c2 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ `uni-app`支持通过`vue-cli`命令行、`HBuilderX`可视化界面两种方式快速创建项目： -- [vue-cli命令行方式](https://uniapp.dcloud.io/quickstart?id=_2-通过vue-cli命令行)：不限IDE，适合对node熟悉的开发者，扩展阅读：[在vscode中开发uni-app](https://ask.dcloud.net.cn/article/36286) +- [vue-cli命令行方式](https://uniapp.dcloud.io/quickstart?id=_2-通过vue-cli命令行)：不限IDE，适合对node熟悉的开发者，扩展阅读：[在vscode中开发uni-app](https://ask.dcloud.net.cn/article/36286)、[在 WebStorm 中开发 uni-app](https://ask.dcloud.net.cn/article/36307) - [HBuilderX可视化界面](https://uniapp.dcloud.io/quickstart?id=_1-通过-hbuilderx-可视化界面)：专用IDE，内置相关环境，开箱即用，开发效率更高。 ## 项目案例 diff --git a/docs/api/README.md b/docs/api/README.md index 51c9f54b06575bcbcc38cf78908dd7efee61b52a..1fce98c4c8c0fb77997239d5a177c874bbe453ed 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -250,6 +250,7 @@ function async request () { |API|说明| |:-|:-| +|[uni.vibrate](api/system/vibrate?id=vibrate)|使手机发生振动| |[uni.vibrateLong](api/system/vibrate?id=vibratelong)|使手机发生较长时间的振动| |[uni.vibrateShort](api/system/vibrate?id=vibrateshort)|使手机发生较短时间的振动| ##### 手机联系人 diff --git a/docs/api/_sidebar.md b/docs/api/_sidebar.md index 987b1798fd4c35f48683a66d31eb810b63fc03ff..71bb1add428ee47245a3d202393b2582280186bf 100644 --- a/docs/api/_sidebar.md +++ b/docs/api/_sidebar.md @@ -1,15 +1,15 @@ * 基础 - * [日志打印](api/log.md) - * [uni.base64ToArrayBuffer](api/base64ToArrayBuffer?id=base64toarraybuffer) - * [uni.arrayBufferToBase64](api/arrayBufferToBase64?id=arraybuffertobase64) - * [定时器](api/timer.md) + * [日志打印](api/log.md) + * [uni.base64ToArrayBuffer](api/base64ToArrayBuffer?id=base64toarraybuffer) + * [uni.arrayBufferToBase64](api/arrayBufferToBase64?id=arraybuffertobase64) + * [定时器](api/timer.md) * [生命周期](api/lifetime.md) * 网络 * [发起请求](api/request/request.md) * [上传、下载](api/request/network-file.md) * [WebSocket](api/request/websocket.md) - * [SocketTask](api/request/socket-task.md) - * [mDNS](api/request/mDNS.md) + * [SocketTask](api/request/socket-task.md) + * [mDNS](api/request/mDNS.md) * [UDP 通信](api/request/UDP.md) * 路由与页面跳转 * [uni.navigateTo](/api/router?id=navigateto) @@ -41,8 +41,8 @@ * [视频](api/media/video.md) * [视频组件控制](api/media/video-context.md) * [相机组件控制](api/media/camera-context.md) - * [直播组件控制](api/media/live-player-context.md) - * [富文本](api/media/editor-context.md) + * [直播组件控制](api/media/live-player-context.md) + * [富文本](api/media/editor-context.md) * 设备 * [系统信息](api/system/info.md) * [内存](api/system/memory.md) @@ -56,17 +56,18 @@ * [屏幕](api/system/brightness.md) * [用户截屏事件](api/system/capture-screen.md) * [振动](api/system/vibrate.md) - * [手机联系人](api/system/contact.md) - * [蓝牙](api/system/bluetooth.md) - * [低功耗蓝牙](api/system/ble.md) - * [iBeacon](api/system/ibeacon.md) - * [Wi-Fi](api/system/wifi.md) - * [电量](api/system/batteryInfo.md) - * [NFC](api/system/nfc.md) - * [设备方向](api/system/deviceMotion.md) + * [手机联系人](api/system/contact.md) + * [蓝牙](api/system/bluetooth.md) + * [低功耗蓝牙](api/system/ble.md) + * [iBeacon](api/system/ibeacon.md) + * [Wi-Fi](api/system/wifi.md) + * [电量](api/system/batteryInfo.md) + * [NFC](api/system/nfc.md) + * [设备方向](api/system/deviceMotion.md) * [Worker](api/worder.md) * 键盘 * [uni.hideKeyboard](/api/key?id=hidekeyboard) + * [uni.onKeyboardHeightChange](/api/key?id=onkeyboardheightchange) * 界面 * [交互反馈](api/ui/prompt.md) * [设置导航条](api/ui/navigationbar.md) @@ -78,22 +79,22 @@ * [字体](api/ui/font.md) * [下拉刷新](api/ui/pulldown.md) * [节点信息](api/ui/nodes-info.md) - * [节点布局相交状态](api/ui/intersection-observer.md) - * [自定义组件](api/ui/nextTick.md) - * [菜单](api/ui/menuButton.md) -* 页面和窗体 - * [页面](api/window/window.md) - * [页面通讯](api/window/communication.md) - * [subNVue原生子窗体](api/window/subNVues.md) + * [节点布局相交状态](api/ui/intersection-observer.md) + * [自定义组件](api/ui/nextTick.md) + * [菜单](api/ui/menuButton.md) +* 页面和窗体 + * [页面](api/window/window.md) + * [页面通讯](api/window/communication.md) + * [subNVue原生子窗体](api/window/subNVues.md) * 文件 * [uni.saveFile](/api/file/file?id=savefile) * [uni.getSavedFileList](/api/file/file?id=getSavedFileList) * [uni.getSavedFileInfo](/api/file/file?id=getSavedFileInfo) * [uni.removeSavedFile](/api/file/file?id=removeSavedFile) * [uni.getFileInfo](/api/file/file?id=getFileInfo) - * [uni.openDocument](/api/file/file?id=openDocument) - * [uni.getFileSystemManager](/api/file/getFileSystemManager) -* 绘画 + * [uni.openDocument](/api/file/file?id=openDocument) + * [uni.getFileSystemManager](/api/file/getFileSystemManager) +* 绘画 * [uni.createOffscreenCanvas](api/canvas/createOffscreenCanvas.md) * [uni.createCanvasContext](api/canvas/createCanvasContext.md) * [uni.canvasToTempFilePath](api/canvas/canvasToTempFilePath.md) @@ -115,16 +116,16 @@ * [设置](api/other/setting.md) * [收货地址](api/other/choose-address.md) * [获取发票抬头](api/other/invoice-title.md) - * [小程序跳转](api/other/open-miniprogram.md) - * [账号信息](api/other/getAccountInfoSync.md) - * [生物认证(指纹及人脸识别)](api/other/authentication.md) + * [小程序跳转](api/other/open-miniprogram.md) + * [账号信息](api/other/getAccountInfoSync.md) + * [生物认证(指纹及人脸识别)](api/other/authentication.md) * [运动(计步器)](api/other/sport.md) - * [统计](api/other/report.md) + * [统计](api/other/report.md) * [卡券](api/other/card.md) * [模板消息](api/other/template.md) * [小程序更新](api/other/update.md) * [调试](api/other/set-enable-debug.md) - * [获取第三方平台数据](api/other/get-extconfig.md) + * [获取第三方平台数据](api/other/get-extconfig.md) * [广告](api/other/advertisement.md)
  • @@ -145,43 +146,44 @@
    -
    官方QQ交流群
    -
    群26：147867597  点此加入
    -
    群35：713420817（2000人已满）
    -
    群34：530305531（2000人已满）
    -
    群33：498071674（2000人已满）
    -
    群32：166188631（500人已满）
    -
    群31：567471669（500人已满）
    -
    群30：371046920（500人已满）
    -
    群29：202965481（500人已满）
    -
    群28：166188776（2000人已满
    -
    群27：811363410（2000人已满
    - -
    群25：165297000（500人已满）
    -
    群24：672494800（500人已满）
    -
    群23：599958679（500人已满）
    -
    群22：687186952（1000人已满）
    -
    群21：717019120（2000人已满）
    -
    群20：165796402（500人已满）
    -
    群19：165657124（1000人已满）
    -
    群18：698592271（500人已满）
    -
    群17：951348804（1000人已满）
    -
    群16：719211033（1000人已满）
    -
    群15：516984120（500人已满）
    -
    群14：465953250（500人已满）
    -
    群13：699478442（500人已满）
    -
    群12：884860657（500人已满）
    -
    群11：296811328（1000人已满）
    -
    群10：959059626（2000人已满）
    -
    群9：775128777（500人已满）
    -
    群8：695442854（500人已满）
    -
    群7：942061423（500人已满）
    -
    群6：697264024（2000人已满）
    -
    群5：731951419（500人已满）
    -
    群4：942702595（1000人已满）
    -
    群3：773794803（1000人已满）
    -
    群2：901474938（1000人已满）
    -
    群1：531031261（1000人已满）
    +
    官方QQ交流群
    +
    群26：147867597  点此加入
    +
    群35：713420817（2000人已满）
    +
    群34：530305531（2000人已满）
    +
    群33：498071674（2000人已满）
    +
    群32：166188631（500人已满）
    +
    群31：567471669（500人已满）
    +
    群30：371046920（500人已满）
    +
    群29：202965481（500人已满）
    +
    群28：166188776（2000人已满
    +
    群27：811363410（2000人已满
    + +
    群25：165297000（500人已满）
    +
    群24：672494800（500人已满）
    +
    群23：599958679（500人已满）
    +
    群22：687186952（1000人已满）
    +
    群21：717019120（2000人已满）
    +
    群20：165796402（500人已满）
    +
    群19：165657124（1000人已满）
    +
    群18：698592271（500人已满）
    +
    群17：951348804（1000人已满）
    +
    群16：719211033（1000人已满）
    +
    群15：516984120（500人已满）
    +
    群14：465953250（500人已满）
    +
    群13：699478442（500人已满）
    +
    群12：884860657（500人已满）
    +
    群11：296811328（1000人已满）
    +
    群10：959059626（2000人已满）
    +
    群9：775128777（500人已满）
    +
    群8：695442854（500人已满）
    +
    群7：942061423（500人已满）
    +
    群6：697264024（2000人已满）
    +
    群5：731951419（500人已满）
    +
    群4：942702595（1000人已满）
    +
    群3：773794803（1000人已满）
    +
    群2：901474938（1000人已满）
    +
    群1：531031261（1000人已满）
    @@ -191,4 +193,4 @@
    - \ No newline at end of file + diff --git a/docs/api/key.md b/docs/api/key.md index 060ce08f156f62e14c64cfd7a4b23dea7e7bb8f8..66b3d73d9217d4b29c35ff13020704d4c000d312 100644 --- a/docs/api/key.md +++ b/docs/api/key.md @@ -1,7 +1,7 @@ -#### uni.hideKeyboard() +#### uni.hideKeyboard() + +隐藏软键盘 -隐藏软键盘 - 隐藏已经显示的软键盘，如果软键盘没有显示则不做任何操作。 **平台差异说明** @@ -10,8 +10,8 @@ |:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√|√|√|√|x|√|√| - -#### uni.onKeyboardHeightChange(CALLBACK) + +#### uni.onKeyboardHeightChange(CALLBACK) 监听键盘高度变化 @@ -19,18 +19,18 @@ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|HBuilderX 2.2.2+|x|基础库2.7+|x|x|x|√| - +|HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√| + **CALLBACK 返回参数** |参数|类型|说明| |:-|:-|:-| -|height|Number|键盘高度| - -**示例代码** - -```js -uni.onKeyboardHeightChange(res => { - console.log(res.height) -}) -``` +|height|Number|键盘高度| + +**示例代码** + +```js +uni.onKeyboardHeightChange(res => { + console.log(res.height) +}) +``` diff --git a/docs/api/location/location.md b/docs/api/location/location.md index b25acbc605dd132dcd035d7a7b04517ec9b4bc25..de3a1dc6be74bba08fc6992593fa10041580b2a8 100644 --- a/docs/api/location/location.md +++ b/docs/api/location/location.md @@ -67,9 +67,9 @@ uni.getLocation({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|x| **OBJECT 参数说明** @@ -81,8 +81,9 @@ uni.getLocation({ |complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| **注意** -- keyword参数，HBuilderX 2.1.4 以后版本支持 - 因平台差异，如果SDK配置百度地图，需要设置keyword，才能显示相关地点 +- nvue下只支持高德地图，不支持百度地图 +- 纯nvue项目（manifest中renderer为native），暂不支持此API。可自行基于map组件封装。 **success 返回参数说明** @@ -111,4 +112,3 @@ uni.chooseLocation({ - 不同端，使用地图选择时基于的底层地图引擎不一样，如微信小程序和H5是腾讯地图，App是高德地图，详见地图map组件的使用注意事项 - 微信内置浏览器中可使用微信js sdk，[详见](https://ask.dcloud.net.cn/article/35380) - chooseLocation属于封装型API，开发者若觉得不够灵活，可自行基于原始的map组件进行封装 -- HBuilderX 1.9.2的Android平台chooseLocation失效，请更新到更高版本。 \ No newline at end of file diff --git a/docs/api/location/map.md b/docs/api/location/map.md index 0fc0ce14bf7aa91a4dd62e1458daf9489ac13ce2..95e9c1a7c9d6f97aa9052287d4add37abdd74101 100644 --- a/docs/api/location/map.md +++ b/docs/api/location/map.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|x|x| mapContext diff --git a/docs/api/location/open-location.md b/docs/api/location/open-location.md index ad01b923d3e88530524cf526ba40268aeb7ec998..42d89e501c126c3e9f8d7a050b2259fd93e23554 100644 --- a/docs/api/location/open-location.md +++ b/docs/api/location/open-location.md @@ -1,6 +1,12 @@ ### uni.openLocation(OBJECT) 使用应用内置地图查看位置。 +**平台差异说明** + +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|√|√|√|x| + **OBJECT 参数说明** |参数名|类型|必填|说明|平台差异说明| @@ -38,6 +44,7 @@ uni.getLocation({ - 本API是一个非原子的封装界面，开发者如有定制需求，可自己做页面实现类似功能。 - H5 端获取定位信息，需要部署在 **https** 服务上，本地预览（localhost）仍然可以使用 http 协议。 - 无 GPS 模块的 PC 设备使用 Chrome 浏览器的时候，位置信息是连接谷歌服务器获取的，国内用户可能获取位置信息失败。 +- 纯nvue项目（manifest中renderer为native），App端暂不支持此API。可自行基于map组件封装。 - ```` 组件默认为国测局坐标，调用 ``uni.getLocation`` 返回结果传递给 ```` 组件时，需指定 type 为 gcj02。 - App 端使用地图组件需要向高德或百度等三方服务商申请SDK资质，获取AppKey，打包时需要在manifest的SDK配置中填写Appkey。在manifest可视化界面有详细申请指南。 - iOS端 如需使用第三方地图进行导航，需要在 manifest.json 文件内增加 ``urlschemewhitelist`` 节点，在线打包即可 @@ -55,6 +62,6 @@ uni.getLocation({ } } } -``` - -- 点击返回也会进入 `fail` 回调中 \ No newline at end of file +``` + +- 点击返回也会进入 `fail` 回调中 diff --git a/docs/api/other/authorize.md b/docs/api/other/authorize.md index dec55315fc145a00bc10cc4845b22e9b6f0a517b..ddbb01b58e5c342d4f0339d1a78d1d1772cc0065 100644 --- a/docs/api/other/authorize.md +++ b/docs/api/other/authorize.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|√|√| **OBJECT 参数说明** @@ -23,14 +23,16 @@ |---|---|---|---| |scope.userInfo |[uni.getUserInfo](/api/plugins/login?id=getuserinfo) |用户信息|| |scope.userLocation|[uni.getLocation](/api/location/location?id=getlocation), [uni.chooseLocation](/api/location/location?id=chooselocation) |地理位置|| -|scope.address |[uni.chooseAddress](/api/other/choose-address) |收货地址|| -|scope.invoiceTitle|[uni.chooseInvoiceTitle](/api/other/invoice-title) |发票抬头|| +|scope.userLocationBackground|wx.userLocationBackground|后台定位|微信小程序| +|scope.address |[uni.chooseAddress](/api/other/choose-address) |通信地址|| |scope.record |[uni.getRecorderManager](/api/media/record-manager?id=getrecordermanager) |录音功能|| -|scope.writePhotosAlbum |[uni.saveImageToPhotosAlbum](/api/media/image?id=saveimagetophotosalbum), [uni.saveVideoToPhotosAlbum](/api/media/video?id=savevideotophotosalbum) |保存到相册|| -|scope.camera |[````](/component/camera) 组件 |摄像头 |微信小程序| -|scope.invoice |[wx.chooseInvoice](https://developers.weixin.qq.com/miniprogram/dev/api/wx.chooseInvoice.html) |获取发票|微信小程序| +|scope.writePhotosAlbum |[uni.saveImageToPhotosAlbum](/api/media/image?id=saveimagetophotosalbum), [uni.saveVideoToPhotosAlbum](/api/media/video?id=savevideotophotosalbum) |保存到相册|头条小程序的返回值是scope.album| +|scope.camera |[````](/component/camera) 组件，头条下的扫码、拍照、选择相册 |摄像头 || +|scope.invoice |[wx.chooseInvoice](https://developers.weixin.qq.com/miniprogram/dev/api/wx.chooseInvoice.html) |获取发票|微信小程序、QQ小程序| +|scope.invoiceTitle|[uni.chooseInvoiceTitle](/api/other/invoice-title) |发票抬头|微信小程序、百度小程序、QQ小程序| |scope.werun |[wx.getWeRunData](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getWeRunData.html) |微信运动步数 |微信小程序| + **代码示例** ```javascript @@ -40,4 +42,4 @@ uni.authorize({ uni.getLocation() } }) -``` \ No newline at end of file +``` diff --git a/docs/api/other/getAccountInfoSync.md b/docs/api/other/getAccountInfoSync.md index 62e00c8e4f4ede6a8838bcd58196d3ea674fd417..626bd2a53fa4767358b88bf84626a42585437589 100644 --- a/docs/api/other/getAccountInfoSync.md +++ b/docs/api/other/getAccountInfoSync.md @@ -1,6 +1,49 @@ -#### wx.getAccountInfoSync() +#### uni.getAccountInfoSync() 获取当前帐号信息，可以返回小程序的Appid。如果使用了微信小程序的云端插件，还可以反馈插件的id和版本 -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getAccountInfoSync.html) \ No newline at end of file +**平台差异说明** + +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| +|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x| + +**返回值** + +**Object** + +帐号信息 + +| 属性 | 类型 | 说明 | +| --- | --- | --- | +| miniProgram | Object| 小程序帐号信息 | +| plugin | Object | 插件帐号信息（仅在插件中调用时包含这一项） | +| appName | string| 智能小程序名称 (仅百度小程序支持) | +| lastAppURL | string| 智能小程序最近一次打开的调起协议 (仅百度小程序支持) | +| scheme | string| 调起协议的协议头 (仅百度小程序支持) | + + +**miniProgram 的结构** + +| 属性 | 类型 | 说明 | +| --- | --- | --- | +| appId | string | 小程序 appId | + + +**plugin 的结构** + +| 属性 | 类型 | 说明 | +| --- | --- | --- | +| appId | string | 插件 appId (百度小程序不支持) | +| version | string | 插件版本号 | + + +**示例代码** + +```js +const accountInfo = uni.getAccountInfoSync(); +console.log(accountInfo.miniProgram.appId); // 小程序 appId +console.log(accountInfo.plugin.appId); // 插件 appId +console.log(accountInfo.plugin.version); // 插件版本号， 'a.b.c' 这样的形式 +``` diff --git a/docs/api/other/open-miniprogram.md b/docs/api/other/open-miniprogram.md index 595cc0370d0bc813724d632857d2bf0dd45a855f..016341ec4a1309c3808589ed9965f14c2645aa82 100644 --- a/docs/api/other/open-miniprogram.md +++ b/docs/api/other/open-miniprogram.md @@ -4,9 +4,12 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|x| +|App|H5|[微信小程序](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/miniprogram-navigate/wx.navigateToMiniProgram.html)|[支付宝小程序](https://docs.alipay.com/mini/api/zwi8gx)|[百度小程序](https://smartprogram.baidu.com/docs/develop/api/open_smartprogram/#swan-navigateToSmartProgram/)|[头条小程序](https://developer.toutiao.com/docs/open/navigateToMiniProgram.html)|[QQ小程序](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_change.html#qq-navigatetominiprogram)| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x(见下)|x|√|√|√|√(1.15.0+)|√| + +- App平台打开微信小程序，使用plus.share的[launchMiniProgram](https://www.html5plus.org/doc/zh_cn/share.html#plus.share.ShareService.launchMiniProgram)。注意uni-app不需要plus ready，将plus ready里的代码写到页面的onLoad生命周期即可。使用此功能需在manifest中配置微信分享SDK信息，打包后生效。 +- 各小程序平台对跳转到其他小程序有一些限制和规定，需要遵守，具体见各平台文档。 **OBJECT 参数说明** @@ -35,15 +38,17 @@ uni.navigateToMiniProgram({ }) ``` + + ### uni.navigateBackMiniProgram(OBJECT) 跳转回上一个小程序，只有当另一个小程序跳转到当前小程序时才会能调用成功。 **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|√| **OBJECT参数说明** @@ -63,4 +68,4 @@ uni.navigateBackMiniProgram({ // 返回成功 } }) -``` \ No newline at end of file +``` diff --git a/docs/api/other/report.md b/docs/api/other/report.md index 531372022308b951f8072277477facc4cbf84ef4..1afa18ec460c7a0b03258826e6cb68482cceda08 100644 --- a/docs/api/other/report.md +++ b/docs/api/other/report.md @@ -1,18 +1,103 @@ -#### 统计 - -各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 - +#### 统计 + +从uni-app 2.2.3起，支持uni统计。一张报表，掌握全端数据。业务介绍详见[https://tongji.dcloud.net.cn](https://tongji.dcloud.net.cn) + +自定义事件是统计中不可获取的功能。开发者可通过本API自定义上报统计数据，如统计登录、注册、点击某个按钮，我们都可以称之为自定义事件。 + +##### uni.report( eventName , options) + +**参数说明** + +|参数 |类型 |描述 | +|--- |--- |--- | +|eventName|String |事件名称，最大长度不超过 255 个字符 | +|options |String 、 Object |事件参数 | + +Tips +- eventName 为 String 类型，并且字符长度必须小于255 +- options 为 String 类型时，字符长度必须小于255 +- options 为 Object 类型时，该对象的值只能为 String 类型 +- 字符串支持特殊字符但不包括（英文逗号 , 英文冒号 : 点 .） +- eventName 为 `title` 时为内容标题上报，用户不能自定义。此时数据会展现在uni统计的首页-内容统计及左侧导航的内容统计中。方便查看内容页数据。 +- 用户在使用 `uni.login()` 会执行登录事件，不携带参数。如果如需上报携带具体参数的数据，需要手动调用 `uni.report('login',{...})` +- 用户在使用 `uni.share()` 或触发 `onShareAppMessage` 会执行分享事件，不携带参数。如果如需上报携带具体参数的数据，需要手动调用 `uni.report('share',{...})` +- 用户在使用 `uni.requestPayment()` 会执行支付事件，不携带参数。如果如需上报携带具体参数的数据，需要手动调用 `uni.report('pay_success',{...})` 和 `uni.report('pay_fail',{...})` + +**示例** + +```javascript +// 内容统计 +// 当 eventName 为 title 时，options 只能为 String 类型 +uni.report('title','首页') + +// 登录 +uni.report('lgoin',{ + 'name':'uni-app', + 'age':'21', + // ... +}) + +// 分享 +uni.report('share','分享') + +// 支付成功 +uni.report('pay_success','支付成功') +// or +uni.report('pay_success',{ + "订单金额":'20元', + "订单名称":'鼠标', + // ... +}) + +// 支付失败 +uni.report('pay_fail','支付失败') +// or +uni.report('pay_fail',{ + "订单金额":'20元', + "订单名称":'鼠标', + // ... +}) + +// 注册 +uni.report('register',{ + 'name':'uni-app', + 'age':'21', + // ... +}) + +// 搜索 +uni.report('search','搜索内容') +// or +uni.report('search',{ + '内容':'搜索内容' +}) + +``` + +自定义事件上报后，在统计后台的`事件和转换`栏目中，可以看到上报的事件情况。 + +**TIPS:** +- 小程序平台，需将`tongji.dcloud.net.cn`配入域名白名单，[详见](https://ask.dcloud.net.cn/article/36298) +- uni统计使用教程：[https://ask.dcloud.net.cn/article/36303](https://ask.dcloud.net.cn/article/36303) + +除了官方的uni统计，如果开发者还需要调用小程序平台的自定义统计，给小程序的后台上报数据，那么需使用条件编译，在各端调用此自己的API。 + ##### 微信小程序平台： - 数据上报：[wx.reportMonitor](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/report/wx.reportMonitor.html) -- 数据分析：[wx.reportAnalytics](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/data-analysis/wx.reportAnalytics.html) +- 数据分析：[wx.reportAnalytics](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/data-analysis/wx.reportAnalytics.html) ##### 支付宝小程序平台： - 自定义分析数据的上报接口：[my.reportAnalytics](https://docs.alipay.com/mini/api/report) ##### 百度小程序平台： - 数据分析：[swan.reportAnalytics](https://smartprogram.baidu.com/docs/develop/api/data/#swan-reportAnalytics/) - -##### App平台： -App平台有DCloud统计服务和友盟统计这两种。 -- DCloud统计：[https://dcloud.io/unistat.html](https://dcloud.io/unistat.html) -- 友盟统计：[开发规范](http://www.html5plus.org/doc/zh_cn/statistic.html)，[配置文档](https://ask.dcloud.net.cn/article/74) \ No newline at end of file + +##### 头条小程序平台： +- [reportAnalytics](https://developer.toutiao.com/docs/open/reportAnalytics.html) + +##### QQ小程序平台： +- 数据上报：[qq.reportMonitor](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_dataup.html) +- 数据分析：[qq.reportAnalytics](https://q.qq.com/wiki/develop/miniprogram/API/open_port/port_dataanalysis.html#qq-reportanalytics) + +##### App平台的友盟统计： +- 友盟统计：[开发规范](http://www.html5plus.org/doc/zh_cn/statistic.html)，[配置文档](https://ask.dcloud.net.cn/article/74) diff --git a/docs/api/other/setting.md b/docs/api/other/setting.md index f64d072f468eb51a45b217bb6fd453c6140612c7..3429d902c748ca74fcac28dc14f4f8c020385ba5 100644 --- a/docs/api/other/setting.md +++ b/docs/api/other/setting.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|√| |属性|类型|必填|说明| |---|---|---|---|---| @@ -35,9 +35,9 @@ uni.openSetting({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序| -|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|√|√| |属性|类型|必填|说明| |---|---|---|---|---| diff --git a/docs/api/other/sport.md b/docs/api/other/sport.md index 571f55f6b5e2487c80db73d0631b4240dc242fe0..7ffa3d27ac9f18d7b1b2612f0bd332a83abb217d 100644 --- a/docs/api/other/sport.md +++ b/docs/api/other/sport.md @@ -1,9 +1,9 @@ -#### sport 运动 - +#### sport 运动 + 此功能为计步器，用于获取手机用户的运动步数。 -仅微信小程序平台、App平台支持，各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 - -- 微信小程序平台：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.getWeRunData.html) - -- App 平台：需使用原生插件，详见[计步器插件](https://ext.dcloud.net.cn/search?q=%E8%AE%A1%E6%AD%A5%E5%99%A8) \ No newline at end of file +各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 + +- App 平台：需使用原生插件，详见[计步器插件](https://ext.dcloud.net.cn/search?q=%E8%AE%A1%E6%AD%A5%E5%99%A8) +- 微信小程序平台：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/werun/wx.getWeRunData.html) +- 支付宝小程序平台：[规范详情](https://docs.alipay.com/mini/api/gxuu7v) diff --git a/docs/api/request/websocket.md b/docs/api/request/websocket.md index 5bc8a0b236c88d8fc6a466910f646ba42c970a9c..dd50f5f0ac14c041244e66c743f8a54fd69dd813 100644 --- a/docs/api/request/websocket.md +++ b/docs/api/request/websocket.md @@ -47,29 +47,15 @@ var socketTask = uni.connectSocket({ 如果没有传入 success / fail / complete 参数，则会返回封装后的 Promise 对象：[Promise 封装](/api/README?id=promise-%E5%B0%81%E8%A3%85) -**注意事项** - -- 网络请求的 ``超时时间`` 可以统一在 ``manifest.json`` 中配置 [networkTimeout](/collocation/manifest?id=networktimeout)。 -- 目前不支持 ``ArrayBuffer`` 类型的数据收发，可以使用 [plus-websocket](http://ext.dcloud.net.cn/plugin?id=647) 插件替代。 -- 自定义组件模式下是基于 `weex` 的 `v8` 引擎运行，所有 `vue` 页面的 `js` 都是在同一个 `weex` 的 `js` 环境中运行。目前 `weex` 限制一个 `js` 环境中只支持一个 `websocket` 连接，所以导致所有 `vue` 页面只能使用一个 `websocket` 连接。 - -**临时解决方案：** - - - 回退使用非自定义组件模式（不推荐） - - 多个 websocket 在独立的 nvue 页面中使用 - - 使用 [plus-websocket](http://ext.dcloud.net.cn/plugin?id=647) 插件替代 - -后续我们会修改 `weex` 的限制，以支持多个 `websocket` 连接 +**注意事项** + +- 网络请求的 ``超时时间`` 可以统一在 ``manifest.json`` 中配置 [networkTimeout](/collocation/manifest?id=networktimeout)。 +- App目前不支持 ``ArrayBuffer`` 类型的数据收发。可以使用 [plus-websocket](https://ext.dcloud.net.cn/plugin?id=647) 插件替代。 +- 自定义组件模式下所有 `vue` 页面只能使用一个 `websocket` 连接。可以使用 [plus-websocket](https://ext.dcloud.net.cn/plugin?id=647) 插件替代。 ### uni.onSocketOpen(CALLBACK) 监听WebSocket连接打开事件。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **CALLBACK 返回参数** |属性|类型|说明| @@ -91,12 +77,6 @@ uni.onSocketOpen(function (res) { ### uni.onSocketError(CALLBACK) 监听WebSocket错误。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **示例代码** ```javascript @@ -114,12 +94,6 @@ uni.onSocketError(function (res) { ### uni.sendSocketMessage(OBJECT) 通过 WebSocket 连接发送数据，需要先 [uni.connectSocket](/api/request/websocket?id=connectsocket)，并在 [uni.onSocketOpen](/api/request/websocket?id=onsocketopen) 回调之后才能发送。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **OBJECT 参数说明：** |参数名|类型|必填|说明| @@ -161,12 +135,6 @@ function sendSocketMessage(msg) { ### uni.onSocketMessage(CALLBACK) 监听WebSocket接受到服务器的消息事件。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **CALLBACK 返回参数** |参数|类型|说明| @@ -188,12 +156,6 @@ uni.onSocketMessage(function (res) { ### uni.closeSocket(OBJECT) 关闭 WebSocket 连接。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - **OBJECT 参数说明** |参数名|类型|必填|说明| @@ -207,12 +169,6 @@ uni.onSocketMessage(function (res) { ### uni.onSocketClose(CALLBACK) 监听WebSocket关闭。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|√|√|√| - ```javascript uni.connectSocket({ url: 'wss://www.example.com/socket' diff --git a/docs/api/system/barcode.md b/docs/api/system/barcode.md index 1ba78e0cb4f048e12044460d1c64ee9ce99c89c6..c439c7481e3c03e6698d4f165d0b126000b02b24 100644 --- a/docs/api/system/barcode.md +++ b/docs/api/system/barcode.md @@ -3,16 +3,16 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **OBJECT 参数说明** |参数名|类型|必填|说明|平台差异说明| |:-|:-|:-|:-|:-:| -|onlyFromCamera|Boolean|否|是否只能从相机扫码，不允许从相册选择图片|头条小程序不支持| -|scanType|Array|否|扫码类型，参数类型是数组，二维码是'qrCode'，一维码是'barCode'，DataMatrix是‘datamatrix’，pdf417是‘pdf417’。|头条小程序不支持| +|onlyFromCamera|Boolean|否|是否只能从相机扫码，不允许从相册选择图片|头条小程序不支持此参数| +|scanType|Array|否|扫码类型，参数类型是数组，二维码是'qrCode'，一维码是'barCode'，DataMatrix是‘datamatrix’，pdf417是‘pdf417’。|头条小程序不支持此参数，支付宝只支持条码和二维码| |success|Function|否|接口调用成功的回调，返回内容详见返回参数说明。|| |fail|Function|否|接口调用失败的回调函数（识别失败、用户取消等情况下触发）|| |complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| | @@ -22,9 +22,9 @@ |参数|说明|平台差异说明| |:-|:-|:-| |result|所扫码的内容|| -|scanType|所扫码的类型|5+App、微信小程序、百度小程序| -|charSet|所扫码的字符集|5+App、微信小程序、百度小程序| -|path|当所扫的码为当前应用的合法二维码时，会返回此字段，内容为二维码携带的 path。|5+App、微信小程序、百度小程序| +|scanType|所扫码的类型|5+App、微信小程序、百度小程序、QQ小程序| +|charSet|所扫码的字符集|5+App、微信小程序、百度小程序、QQ小程序| +|path|当所扫的码为当前应用的合法二维码时，会返回此字段，内容为二维码携带的 path。|5+App、微信小程序、百度小程序、QQ小程序| **示例** @@ -44,11 +44,24 @@ uni.scanCode({ console.log('条码类型：' + res.scanType); console.log('条码内容：' + res.result); } +}); + +// 调起条码扫描 +uni.scanCode({ + scanType: 'barCode', + success: function (res) { + console.log('条码类型：' + res.scanType); + console.log('条码内容：' + res.result); + } }); ``` **Tip** -- App端如果想自定义扫码，可参考[uni-app中如何使用5+的原生界面控件](http://ask.dcloud.net.cn/article/35036)和[plus.barcode API](https://www.html5plus.org/doc/zh_cn/barcode.html) -- 微信内嵌浏览器运行H5版时，可通过js sdk实现扫码，需要引入一个单独的js，[详见](https://ask.dcloud.net.cn/article/35380) -- 点击返回也会进入 `fail` 回调中 \ No newline at end of file +- App-vue如果想自定义扫码，可参考[uni-app中如何使用5+的原生界面控件](http://ask.dcloud.net.cn/article/35036)和[plus.barcode API](https://www.html5plus.org/doc/zh_cn/barcode.html) +- App-nvue，支持barcode组件，可自定义扫码界面。[详见](https://uniapp.dcloud.io/component/barcode) +- 微信小程序自定义扫码界面，可使用camera组件。[详见](https://uniapp.dcloud.io/component/camera) +- App下纯nvue项目（manifest中renderer为native），不支持此API，请使用barcode组件来替代。 +- 微信内嵌浏览器运行H5版时，可通过js sdk实现扫码，需要引入一个单独的js，[详见](https://ask.dcloud.net.cn/article/35380) +- 在扫码界面点击返回也会进入 `fail` 回调中 +- 支付宝小程序不支持 `success` 回调中的 `scanType`，`charSet`，`path` diff --git a/docs/api/system/batteryInfo.md b/docs/api/system/batteryInfo.md index 44a1220334ddee1a8a8d456b84e57e26a0f1f608..0aaed2f4a4e01be83565904d4197b4a5091ea5cf 100644 --- a/docs/api/system/batteryInfo.md +++ b/docs/api/system/batteryInfo.md @@ -1,3 +1,8 @@ #### 电量 -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getBatteryInfoSync.html) \ No newline at end of file +电量API暂未统一，需分平台条件编译编写。 + +- 微信小程序平台：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getBatteryInfoSync.html) +- 百度小程序平台：[规范详情](https://smartprogram.baidu.com/docs/develop/api/device_battery/#swan-getBatteryInfo/) +- 支付宝小程序平台：[规范详情](https://docs.alipay.com/mini/api/nrnziy) +- QQ小程序平台：[规范详情](https://q.qq.com/wiki/develop/miniprogram/API/equipment/ibeacon_battery.html) diff --git a/docs/api/system/ble.md b/docs/api/system/ble.md index f33653b8af3dc757c6881fae63c3585e27580b29..04fe45ff7a01616a1ab294cef645b441b189a7da 100644 --- a/docs/api/system/ble.md +++ b/docs/api/system/ble.md @@ -1,8 +1,8 @@ **低功耗蓝牙 API 平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序| -|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|x|x|x| ### uni.writeBLECharacteristicValue(OBJECT) @@ -436,4 +436,4 @@ uni.closeBLEConnection({ console.log(res) } }) -``` \ No newline at end of file +``` diff --git a/docs/api/system/bluetooth.md b/docs/api/system/bluetooth.md index 63cb2577441a911a4a1b57125ce0c38193152a4f..8aa4f2c74f62d9a4ee4ce17948d2cc316971a8bc 100644 --- a/docs/api/system/bluetooth.md +++ b/docs/api/system/bluetooth.md @@ -1,8 +1,8 @@ **蓝牙 API 平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|x|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|x|x|x| ### uni.openBluetoothAdapter(OBJECT) @@ -406,4 +406,4 @@ uni.closeBluetoothAdapter({ console.log(res) } }) -``` \ No newline at end of file +``` diff --git a/docs/api/system/brightness.md b/docs/api/system/brightness.md index f8b3de758a34237e653d7d099cb52dddd33669ae..7a764e3b68e6dbc097abbf03592cd5264ffa3e9e 100644 --- a/docs/api/system/brightness.md +++ b/docs/api/system/brightness.md @@ -3,9 +3,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|x|√| **OBJECT 参数说明** @@ -32,9 +32,9 @@ uni.setScreenBrightness({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|x|√| **OBJECT 参数说明** @@ -65,9 +65,9 @@ uni.getScreenBrightness({ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| **OBJECT 参数说明** @@ -91,5 +91,5 @@ uni.getScreenBrightness({ uni.setKeepScreenOn({ keepScreenOn: true }); -``` - +``` + diff --git a/docs/api/system/capture-screen.md b/docs/api/system/capture-screen.md index 90d58b145b5f20e142295966bbded3253670b93b..99acedbfec55974b1eee47b6d756c3e52417787c 100644 --- a/docs/api/system/capture-screen.md +++ b/docs/api/system/capture-screen.md @@ -4,9 +4,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|√|√|x|√| **CALLBACK返回参数：** @@ -18,4 +18,4 @@ uni.onUserCaptureScreen(function() { console.log('用户截屏了') }); -``` \ No newline at end of file +``` diff --git a/docs/api/system/clipboard.md b/docs/api/system/clipboard.md index 18aaf0568145d8ab2ad2533fc5c510e69afd1fc1..70e2436c604445a2bf00cce84deb47c8045af424 100644 --- a/docs/api/system/clipboard.md +++ b/docs/api/system/clipboard.md @@ -1,8 +1,8 @@ **剪贴板 API 平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序| -|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|√|√| ### uni.setClipboardData(OBJECT) 设置系统剪贴板的内容。 @@ -55,5 +55,5 @@ uni.getClipboardData({ #### **注意** -- 设置剪贴板内容后，小程序平台会自动弹出轻提示。App平台默认与小程序保持一致策略。如不希望在App平台弹出提示，可使用Native.js自行操作剪贴板，[http://ask.dcloud.net.cn/question/2034](http://ask.dcloud.net.cn/question/2034) -- H5的复制粘贴，可去插件市场搜索[剪贴板](https://ext.dcloud.net.cn/search?q=%E5%89%AA%E8%B4%B4%E6%9D%BF) \ No newline at end of file +- 设置剪贴板内容后，小程序平台会自动弹出轻提示。App平台默认与小程序保持一致策略。如不希望在App平台弹出提示，可使用Native.js自行操作剪贴板，插件市场有封装好的示例[https://ext.dcloud.net.cn/plugin?id=712](https://ext.dcloud.net.cn/plugin?id=712) +- H5的复制粘贴，可去插件市场搜索[剪贴板](https://ext.dcloud.net.cn/search?q=%E5%89%AA%E8%B4%B4%E6%9D%BF) diff --git a/docs/api/system/compass.md b/docs/api/system/compass.md index bfed1a68a1aa95e5b2dcd47807ad7064a604d7e4..95c14152020069490580da970b90d682bfc032e8 100644 --- a/docs/api/system/compass.md +++ b/docs/api/system/compass.md @@ -23,9 +23,9 @@ uni.onCompassChange(function (res) { **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|√| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|√|√|x|√|√|√| **OBJECT 参数说明** @@ -56,4 +56,4 @@ uni.startCompass(); ```javascript uni.stopCompass(); -``` \ No newline at end of file +``` diff --git a/docs/api/system/contact.md b/docs/api/system/contact.md index 67a03d11d770fe3e56ac49ecd31291f9a8d009c6..a305dacd1e87e3f662d3935290248a776768d634 100644 --- a/docs/api/system/contact.md +++ b/docs/api/system/contact.md @@ -1,13 +1,13 @@ ### uni.addPhoneContact(OBJECT) 调用后，用户可以选择将该表单以“新增联系人”或“添加到已有联系人”的方式（APP端目前没有选择步骤，将直接写入），写入手机系统通讯录，完成手机通讯录联系人和联系方式的增加。 -App平台提供了更多通讯录相关API，详见：[https://www.html5plus.org/doc/zh_cn/contacts.html](https://www.html5plus.org/doc/zh_cn/contacts.html) +App平台提供了更多通讯录相关API，包括读取联系人，详见：[https://www.html5plus.org/doc/zh_cn/contacts.html](https://www.html5plus.org/doc/zh_cn/contacts.html) **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|√|x|x| **OBJECT 参数说明** diff --git a/docs/api/system/deviceMotion.md b/docs/api/system/deviceMotion.md index bb119c97ae243eddf71993a3201b48a5dad49a41..371f768c43a4000997731141abff4bd0a2f53439 100644 --- a/docs/api/system/deviceMotion.md +++ b/docs/api/system/deviceMotion.md @@ -1,4 +1,5 @@ -#### 设备方向 +#### 监听设备方向变化 仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/device/motion/wx.startDeviceMotionListening.html) +在App平台，也可以通过监听窗体大小变化onResize来实现此类需求。[详见](https://uniapp.dcloud.io/collocation/frame/lifetime?id=%e9%a1%b5%e9%9d%a2%e7%94%9f%e5%91%bd%e5%91%a8%e6%9c%9f) diff --git a/docs/api/system/ibeacon.md b/docs/api/system/ibeacon.md index 2ed411c799bdab528e7cdeee463d84b1c53ce2c3..bf6008048171be0fbb3b845ac28c7bd9b322837a 100644 --- a/docs/api/system/ibeacon.md +++ b/docs/api/system/ibeacon.md @@ -1,8 +1,8 @@ **iBeacon API 平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序| -|:-:|:-:|:-:|:-:|:-:| -|√|x|√|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√|x|√|√|x|x|x| ### uni.onBeaconServiceChange(CALLBACK) @@ -116,4 +116,4 @@ uni.startBeaconDiscovery({ |minor|string|iBeacon 设备的次 id| |proximity|number|表示设备距离的枚举值| |accuracy|number|iBeacon 设备的距离| -|rssi|number|表示设备的信号强度| \ No newline at end of file +|rssi|number|表示设备的信号强度| diff --git a/docs/api/system/memory.md b/docs/api/system/memory.md index 4881a9072d4914181d72b8a520cef739dc47e93b..07a3278b9b58f17eb7de2341dc00789786f0990b 100644 --- a/docs/api/system/memory.md +++ b/docs/api/system/memory.md @@ -6,9 +6,9 @@ **平台差异说明** -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|x|x|√|x|√|x| +|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序|QQ小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x|x|√|x|√|x|√| **CALLBACK返回参数：** @@ -30,4 +30,4 @@ uni.onMemoryWarning(function () { console.log('onMemoryWarningReceive') }) -``` \ No newline at end of file +``` diff --git a/docs/api/system/vibrate.md b/docs/api/system/vibrate.md index d34e4430e30c04dc1dec84eca7614b918e3d3adc..ed6b98ef29fe989d7ef31395e64b443dadc3d2bf 100644 --- a/docs/api/system/vibrate.md +++ b/docs/api/system/vibrate.md @@ -1,3 +1,24 @@ +### uni.vibrate(OBJECT) +使手机发生振动。 + +**OBJECT 参数说明** + +|参数名|类型|必填|说明| +|:-|:-|:-|:-| +|success|Function|否|接口调用成功的回调| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| + +**示例** + +```javascript +uni.vibrate({ + success: function () { + console.log('success'); + } +}); +``` + ### uni.vibrateLong(OBJECT) 使手机发生较长时间的振动（400ms）。 @@ -42,4 +63,5 @@ uni.vibrateShort({ **注意** - iOS上只有长震动，没有短震动 -- iOS上需要手机设置“打开响铃时震动”或“静音时震动”，否则无法震动 \ No newline at end of file +- iOS上需要手机设置“打开响铃时震动”或“静音时震动”，否则无法震动 +- vibrate只适用于钉钉小程序、支付宝小程序 \ No newline at end of file diff --git a/docs/api/system/wifi.md b/docs/api/system/wifi.md index ef5a3d3cfaad0eb52ae4560f2425252517499f98..ff20e7ea1f00ce3e2f965bcc5fdb8c4e3eed940d 100644 --- a/docs/api/system/wifi.md +++ b/docs/api/system/wifi.md @@ -1,9 +1,10 @@ #### Wi-Fi -仅微信小程序平台、App平台支持，各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 +仅微信小程序平台、App平台、头条小程序支持，各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 微信小程序平台实现参考：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.startWifi.html) +头条小程序的wifi API参考：[规范详情](https://developer.toutiao.com/docs/api/getConnectedWifi.html) App 平台实现参考 @@ -11,4 +12,4 @@ App 平台实现参考 - [获取WIFI列表](https://ask.dcloud.net.cn/question/12113) **ios：** -- [打开ios的WIFI设置页面](https://ask.dcloud.net.cn/question/7797) \ No newline at end of file +- [打开ios的WIFI设置页面](https://ask.dcloud.net.cn/question/7797) diff --git a/docs/api/ui/bgcolor.md b/docs/api/ui/bgcolor.md index 648b3cc4d37254f7a648c4813a58c99f8136ff39..cebb9c4b7baba5ab9e2842d5f9fc42e6286d6f0c 100644 --- a/docs/api/ui/bgcolor.md +++ b/docs/api/ui/bgcolor.md @@ -15,9 +15,9 @@ |backgroundColor|String||否|窗口的背景色，必须为十六进制颜色值| |backgroundColorTop|String||否|顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持| |backgroundColorBottom|String||否|底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持| -|success|Funtion||否|接口调用成功的回调函数| -|fail|Funtion||否|接口调用失败的回调函数| -|complete|Funtion||否|接口调用结束的回调函数（调用成功、失败都会执行）| +|success|Function||否|接口调用成功的回调函数| +|fail|Function||否|接口调用失败的回调函数| +|complete|Function||否|接口调用结束的回调函数（调用成功、失败都会执行）| **代码示例** @@ -42,11 +42,11 @@ uni.setBackgroundColor({ **参数说明** |属性|类型|必填|说明| -|:-|:-|:-|:-|:-| +|:-|:-|:-|:-| |textStyle|String|是|下拉背景字体、loading 图的样式，值为：dark、light| -|success|Funtion|否|接口调用成功的回调函数| -|fail|Funtion|否|接口调用失败的回调函数| -|complete|Funtion|否|接口调用结束的回调函数（调用成功、失败都会执行）| +|success|Function|否|接口调用成功的回调函数| +|fail|Function|否|接口调用失败的回调函数| +|complete|Function|否|接口调用结束的回调函数（调用成功、失败都会执行）| **代码示例** @@ -54,4 +54,4 @@ uni.setBackgroundColor({ uni.setBackgroundTextStyle({ textStyle: 'dark' // 下拉背景字体、loading 图的样式为dark }) -``` \ No newline at end of file +``` diff --git a/docs/api/ui/intersection-observer.md b/docs/api/ui/intersection-observer.md index c6e515d7ba052350c83e26f01556c4ee0abf20aa..24fc30daebcb9f251f5c02e7eafc246e39592fc2 100644 --- a/docs/api/ui/intersection-observer.md +++ b/docs/api/ui/intersection-observer.md @@ -3,12 +3,6 @@ ### uni.createIntersectionObserver([this], [options]) 创建并返回一个 ``IntersectionObserver`` 对象实例。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|HBuilderX 2.0.4+|√|√|√|√| - **options 的可选参数为：** |字段名|类型|说明| @@ -133,4 +127,4 @@ uni.createIntersectionObserver(this).relativeTo('.scroll',{bottom: 100}}).observ } -``` \ No newline at end of file +``` diff --git a/docs/api/ui/menuButton.md b/docs/api/ui/menuButton.md index 059528e3ae1888d8e4b20913c59592a2c2eeb6b3..3833cef7af9ba1c995d5383cd916e6082e7681f4 100644 --- a/docs/api/ui/menuButton.md +++ b/docs/api/ui/menuButton.md @@ -1,13 +1,13 @@ -#### getMenuButtonBoundingClientRect() - +#### getMenuButtonBoundingClientRect() + 在小程序平台，如果原生导航栏被隐藏，仍然在右上角会有一个悬浮按钮，微信下也被称为胶囊按钮。本API用于获取小程序下该菜单按钮的布局位置信息，方便开发者布局顶部内容时避开该按钮。 -坐标信息以屏幕左上角为原点。 +坐标信息以屏幕左上角为原点。 各平台开发方式暂未统一，使用时需注意用[条件编译](https://uniapp.dcloud.io/platform)调用不同平台的代码。 - -微信小程序：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getMenuButtonBoundingClientRect.html) - -百度小程序：[规范详情](https://smartprogram.baidu.com/docs/develop/api/menu_info/) -支付宝小程序：其逻辑与微信小程序不同，它提供了菜单点击后按钮的自定义功能，可以选择显示那些系统按钮，[规范详情](https://docs.alipay.com/mini/api/optionmenuitem) \ No newline at end of file +- 微信小程序：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.getMenuButtonBoundingClientRect.html) +- 百度小程序：[规范详情](https://smartprogram.baidu.com/docs/develop/api/menu_info/) +- 支付宝小程序：其逻辑与微信小程序不同，它提供了菜单点击后按钮的自定义功能，可以选择显示那些系统按钮，[规范详情](https://docs.alipay.com/mini/api/optionmenuitem) +- 头条小程序：[规范详情](https://developer.toutiao.com/docs/game/ui/menu/tt.getMenuButtonBoundingClientRect.html) +- QQ小程序：[规范详情](https://q.qq.com/wiki/develop/game/API/interface/menu.html#qq-getmenubuttonboundingclientrect) diff --git a/docs/api/ui/nextTick.md b/docs/api/ui/nextTick.md index b4db3e53eee9e062a0d6c59c76f9fdaad2a16389..08359dadf66a2c9e258ddba95adbcb3eca11b7f0 100644 --- a/docs/api/ui/nextTick.md +++ b/docs/api/ui/nextTick.md @@ -1,5 +1,6 @@ #### nextTick(function callback) -延迟一部分操作到下一个时间片再执行。（类似于 setTimeout） - -仅微信小程序平台支持，[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.nextTick.html) +在小程序自定义组件，如wxcomponents中使用。延迟一部分操作到下一个时间片再执行。（类似于 setTimeout） 。其他平台无此概念。 +- 微信小程序：[规范详情](https://developers.weixin.qq.com/miniprogram/dev/api/wx.nextTick.html) +- 百度小程序：[规范详情](https://smartprogram.baidu.com/docs/develop/api/custom_component/#swan-nextTick/) +- QQ小程序：[规范详情](https://q.qq.com/wiki/develop/miniprogram/API/interface/interface_nexttick.html#qq-nexttick) diff --git a/docs/api/ui/pulldown.md b/docs/api/ui/pulldown.md index fd4ea7bbd10e11c964c4a3256b5a2319ae2d21be..f3d2045aec2d979586fcb4a9706e9d3946cad76f 100644 --- a/docs/api/ui/pulldown.md +++ b/docs/api/ui/pulldown.md @@ -7,12 +7,6 @@ ### uni.startPullDownRefresh(OBJECT) 开始下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 -**平台差异说明** - -|5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| -|:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|√| - **OBJECT 参数说明** |参数名|类型|必填|说明| @@ -75,12 +69,18 @@ export default { } ``` +**注意** + +- 支付宝小程序```startPullDownRefresh```在开发者工具里会提示``暂未开放，请勿使用`` +- 支付宝小程序```startPullDownRefresh```请使用真机调试（非真机预览） +- 后续支付宝小程序开发工具更新可能会有所修改 + ### FAQ Q：如何暂时禁用掉下拉刷新，待需要的时候再重新开启？ -A：`5+App` 平台下可以处理此类场景，详细参考：[uni-app 中实现动态禁用/开启下拉刷新](http://ask.dcloud.net.cn/article/35134) +A：`5+App` 平台下可以处理此类场景，详细参考：[uni-app 中实现动态禁用/开启下拉刷新](https://ask.dcloud.net.cn/article/35134) Q：自定义title如何让下拉刷新在title之下 -A：App和H5端使用circle方式的下拉刷新，设offset在title高度之下。hello uni-app的模板-导航栏中有示例。小程序端无法实现，除非放弃原生下拉刷新，自己模拟。 +A：App和H5端使用circle方式的下拉刷新，设offset在title高度之下。hello uni-app的模板-导航栏中有示例。小程序端无法实现，除非放弃原生下拉刷新，自己模拟下拉刷新，插件市场有类似插件，但性能不如原生下拉刷新。 Q：如何自定义下拉刷新样式 -A：小程序端的原生下拉刷新样式是固定的；App端原生的下拉刷新有2种样式可选择，下拉漏出雪花和下拉circle圈。如果使用nvue，也可以自己实现下拉刷新，都是原生渲染。如果想使用scroll-view在前端实现自定义下拉刷新，需要注意列表不可太长和太复杂，否则会有性能问题。[插件市场](https://ext.dcloud.net.cn/)搜索下拉刷新有示例。 +A：小程序端的原生下拉刷新样式是固定的；App端原生的下拉刷新有2种样式可选择，下拉漏出雪花和下拉circle圈。如果使用nvue，可以使用[refresh组件](https://uniapp.dcloud.io/component/refresh)自定义下拉刷新，都是原生渲染。如果想使用scroll-view在前端实现自定义下拉刷新，需要注意列表不可太长和太复杂，否则会有性能问题。[插件市场](https://ext.dcloud.net.cn/)搜索下拉刷新有示例。 diff --git a/docs/api/ui/tabbar.md b/docs/api/ui/tabbar.md index 2e76a50db2a82af431df86c489e69f063e17fa71..f746dfce1178885560f355f4cfb349c8aac0a20c 100644 --- a/docs/api/ui/tabbar.md +++ b/docs/api/ui/tabbar.md @@ -6,7 +6,7 @@ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -39,7 +39,7 @@ uni.setTabBarItem({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -72,7 +72,7 @@ uni.setTabBarStyle({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -91,7 +91,7 @@ uni.setTabBarStyle({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -109,7 +109,7 @@ uni.setTabBarStyle({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -137,7 +137,7 @@ uni.setTabBarBadge({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -155,7 +155,7 @@ uni.setTabBarBadge({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** @@ -173,7 +173,7 @@ uni.setTabBarBadge({ |5+App|H5|微信小程序|支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|√|x| +|√|√|√|√|√|x| **OBJECT参数说明：** diff --git a/docs/api/ui/window.md b/docs/api/ui/window.md index ebec1ff598b7b8ad325bce8a9bbd141c0af784d4..f3f0c62b3838ee057cc245e9f65bac878aaa75df 100644 --- a/docs/api/ui/window.md +++ b/docs/api/ui/window.md @@ -7,7 +7,7 @@ |5+App|H5|微信小程序 |支付宝小程序|百度小程序|头条小程序| |:-:|:-:|:-:|:-:|:-:|:-:| -|√|√|√|x|x|x| +|√(nvue不支持)|√|√|x|x|x| **CALLBACK 参数说明** @@ -24,6 +24,10 @@ uni.onWindowResize((res) => { }) ``` +**TIPS** +- 如App端设置软键盘弹出方式为adjustResize ，则在键盘弹出时，会触发此事件。 +- 横竖屏切换时，会触发此事件。 + ### uni.offWindowResize(CALLBACK) 取消监听窗口尺寸变化事件 diff --git a/docs/case.md b/docs/case.md index db67f0ee051c1e68673044754e4ac88de449f6ba..5c1929777e7a6bf32b6b6f6628a4c8efd520f770 100644 --- a/docs/case.md +++ b/docs/case.md @@ -25,6 +25,7 @@ uni-app已经有几十万开发者，创建了几十万个项目，是开发者 + + ### 第三方开发者案例 + CSDN： 专业 IT 技术社区，致力于为中国软件开发者提供知识传播、在线学习、职业发展等全生命周期服务。
    @@ -93,6 +97,14 @@ uni-app已经有几十万开发者，创建了几十万个项目，是开发者 百度小程序码 + + + QQ小程序码 + + + + 头条/抖音小程序码 +
    垃圾分类：垃圾分一分，环境美十分。参与垃圾分类，保护地球家园，共创美好世界。（作者：怎么会这样） @@ -114,7 +126,8 @@ uni-app已经有几十万开发者，创建了几十万个项目，是开发者 头条小程序码 - + +