tmui-cli 2.0.3 → 2.0.4

package/data/uniappx/api/choose-video.md

@@ -0,0 +1,165 @@
+::: sourceCode
+## uni.chooseVideo(options) @choosevideo
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-media
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-media
+
+拍摄视频或从手机相册中选视频，返回视频的临时文件路径。
+
+### chooseVideo 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.18 | 4.18 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **ChooseVideoOptions** | 是 |
+| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- | :- |  :-: | :- |
+| pageOrientation | string | 否 |  | Web x / 微信小程序 4.41 / Android 4.33 / iOS 4.33 / HarmonyOS x（部分支持，见上） | 屏幕方向。默认为pages.json中的pageOrientation。 |
+@@| 合法值 | 描述 |
+@@| :- | :- |
+@@| "auto" | 自动 |
+@@| portrait | 竖屏显示 |
+@@| landscape | 横屏显示 |
+| sourceType | Array<string> | 否 |  | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | album 从相册选视频，camera 使用相机拍摄，默认为：\['album', 'camera'\] |
+| maxDuration | number | 否 |  | Web x / 微信小程序 4.41 / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | 拍摄视频最长拍摄时间，单位秒。最长支持 60 秒 |
+| camera | string | 否 |  | Web x / 微信小程序 4.41 / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | 摄像切换<br/> |
+@@| 合法值 | 描述 |
+@@| :- | :- |
+@@| front | 前置摄像头 |
+@@| back | 后置摄像头 |
+| extension | Array&lt;string&gt; | 否 |  | 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 根据文件拓展名过滤，每一项都不能是空字符串。默认不过滤。 |
+| success | (callback: [ChooseVideoSuccess](#choosevideosuccess-values)) => void | 否 |  | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 接口调用成功，返回视频文件的临时文件路径，详见返回参数说明 |
+| fail | (callback: [ChooseVideoFail](#choosevideofail-values)) => void | 否 |  | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (callback: any) => void | 否 |  | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） |
+| ~~albumMode~~ | string | 否 | "custom" | Web x / Android 4.33 / iOS x / HarmonyOS x（部分支持，见上） | 视频选择模式  **已废弃，仅为了向下兼容保留** |
+@@| 合法值 | 描述 |
+@@| :- | :- |
+@@| "custom" | 自定义媒体选择器 |
+@@| system | 系统媒体选择器 |
+| ~~compressed~~ | boolean | 否 | true | Web x / 微信小程序 4.41 / Android 4.18 / iOS 4.18 / HarmonyOS x（部分支持，见上） | 是否压缩所选的视频源文件，默认值为true，需要压缩  **已废弃，仅为了向下兼容保留** | 
+
+#### ChooseVideoSuccess 的属性值 @choosevideosuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| tempFilePath | string | 是 | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 选定视频的临时文件路径 |
+| duration | number | 是 | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 选定视频的时间长度 |
+| size | number | 是 | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 选定视频的数据量大小 |
+| height | number | 是 | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 返回选定视频的长 |
+| width | number | 是 | 微信小程序 4.41 / Android 4.18 / iOS 4.18（部分支持，见上） | 返回选定视频的宽 |
+
+#### ChooseVideoFail 的属性值 @choosevideofail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 1101001 | 用户取消 |
+| 1101002 | urls至少包含一张图片地址 |
+| 1101003 | 文件不存在 |
+| 1101004 | 图片加载失败 |
+| 1101005 | 未获取权限 |
+| 1101006 | 图片或视频保存失败 |
+| 1101007 | 图片裁剪失败 |
+| 1101008 | 拍照或录像失败 |
+| 1101009 | 图片压缩失败 |
+| 1101010 | 其他错误 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.media.chooseVideo)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/media/video.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseVideo.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=chooseVideo&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=chooseVideo&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=chooseVideo&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=chooseVideo&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=chooseVideo)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=chooseVideo&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/choose-video/choose-video.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/choose-video/choose-video.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/choose-video/choose-video
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/choose-video/choose-video
+
+>示例
+```vue
+<template>
+  
+  <scroll-view style="flex:1">
+  
+    <page-head :title="title"></page-head>
+    <view class="uni-padding-wrap">
+      
+      <view class="uni-title">
+        <text class="uni-subtitle-text">视频信息</text>
+      </view>
+      <text>{{videoInfo}}</text>
+      <view class="uni-btn-v">
+        <button type="primary" @click="chooseVideo">选取视频</button>
+      </view>
+      <enum-data title="视频来源" :items="sourceTypeItemTypes" @change="onSourceTypeChange"></enum-data>
+      
+      <enum-data title="屏幕方向" :items="orientationTypeItemTypes" @change="onOrientationTypeChange"></enum-data>
+      
+      <enum-data title="摄像头" :items="cameraItemTypes" @change="onCameraChange"></enum-data>
+      
+      <enum-data title="相册模式" :items="albumModeTypes" @change="onAlbumModeChange"></enum-data>
+      
+    </view>
+    <input-data title="最长拍摄时间，单位秒" defaultValue="60" type="number" @confirm="onMaxDurationConfirm"></input-data>
+    
+    <view class="uni-padding-wrap">
+      <boolean-data title="是否压缩（HamonyOS 不支持，推荐使用 uni.compressVideo 进行压缩）" :defaultValue="true" @change="onCompressedChange"></boolean-data>
+    </view>
+    
+  
+  </scroll-view>
+  
+</template>
+
+
+
+<style>
+  .video {
+    align-self: center;
+    width: 300px;
+    height: 225px;
+  }
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |
+
+## Tips
+* 视频选择的相册，在入参option中，推荐设置albumMode为system，即选择系统相册来选择视频。这样可以避免权限问题，并且google play上架也有要求。[google play 照片和视频权限政策](https://support.google.com/googleplay/android-developer/answer/14115180)。后续会废弃custom方式。
+* 当设置`albumMode`为`system`时，可以正常上架google play。同时需要注意在manifest.json中将`<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />`和`<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />`权限移除。配置方式参考[移除Android权限](https://uniapp.dcloud.net.cn/tutorial/app-nativeresource-android.html#removepermissions).
+* 系统相册选择界面的主题和国际化，跟随手机rom，而不是跟随app。
+* 不推荐使用本API的压缩参数，大视频选择时，会卡在视频选择页面很久。应该在选择完毕视频后，自行择机（比如上传视频时）调用uni.compressVideo来压缩视频。
+* 本API会自动申请摄像头，如需手动获取app是否拥有摄像头，参考 [uni.getAppAuthorizeSetting](get-app-authorize-setting.md)。（如使用system方式的相册选择，则不需要权限）
+* app端拍摄会在应用沙盒目录的cache目录产生临时文件，位置[详见](file-system-spec.md#cache)。如需主动删除临时文件，使用[uni.getFileSystemManager](get-file-system-manager.md)。
+* android端由于系统或ROM的限制，拍照的`maxDuration`和`camera`属性在部分手机上不生效。
+* 从HBuilderX4.41版起，uni.chooseVideo在`sourceType`为`['album']`、`albumMode`为`system`、`compressed`为`true`时，支持返回Uri地址。
+* 系统视频选择器的`sizeType`仅支持设置`['original']`或`['compressed']`。在Android 11及以上的系统中，设置`system`调用的是系统的视频选择器，低于android 11的系统中会调用系统的文件选择器。

package/data/uniappx/api/clipboard.md

@@ -0,0 +1,155 @@
+::: sourceCode
+## uni.getClipboardData(options) @getclipboarddata
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-clipboard
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-clipboard
+
+获得系统剪贴板的内容
+
+### getClipboardData 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.71 | 4.71 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **GetClipboardDataOptions** | 是 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| success | (result: [GetClipboardDataSuccess](#getclipboarddatasuccess-values)) => void | 否 | 成功返回的回调函数 |
+| fail | (result: [GetClipboardDataFail](#getclipboarddatafail-values)) => void | 否 | 失败的回调函数 |
+| complete | (result: any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） | 
+
+#### GetClipboardDataSuccess 的属性值 @getclipboarddatasuccess-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| data | string | 是 | 剪贴板的内容 |
+
+#### GetClipboardDataFail 的属性值 @getclipboarddatafail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 |  |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+**注意**
+
+- 读取剪贴板，在一些新的Android设备上，被列为单独的权限，如没有相关权限，则无法读取剪贴板。
+- 在鸿蒙上，读取剪贴板是一个高敏感权限，较难申请，参考[鸿蒙文档](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/get-pastedata-permission-guidelines?ha_source=Dcloud&ha_sourceId=89000448)
+
+<md-hperm permissions="ohos.permission.READ_PASTEBOARD" />
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.clipboard.getClipboardData)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/clipboard.html#getclipboarddata)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/clipboard/wx.getClipboardData.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getClipboardData&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getClipboardData&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getClipboardData&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getClipboardData&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getClipboardData)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=getClipboardData&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+::: sourceCode
+## uni.setClipboardData(options) @setclipboarddata
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-clipboard
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-clipboard
+
+设置系统剪贴板的内容
+
+### setClipboardData 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.71 | 4.71 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **SetClipboardDataOptions** | 是 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| data | string | 是 | 需要设置的内容 |
+| showToast | boolean | 否 | 是否弹出提示，默认弹出提示 |
+| success | (result: SetClipboardDataSuccess) => void | 否 | 成功返回的回调函数 |
+| fail | (result: [SetClipboardDataFail](#setclipboarddatafail-values)) => void | 否 | 失败的回调函数 |
+| complete | (result: any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） | 
+
+#### SetClipboardDataFail 的属性值 @setclipboarddatafail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 |  |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.clipboard.setClipboardData)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/clipboard.html#setclipboarddata)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/clipboard/wx.setClipboardData.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=setClipboardData&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=setClipboardData&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=setClipboardData&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=setClipboardData&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=setClipboardData)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=setClipboardData&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/clipboard/clipboard.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/clipboard/clipboard.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/clipboard/clipboard
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/clipboard/clipboard
+
+>示例
+```vue
+<template>
+  <view>
+    <page-head :title="title"></page-head>
+    <view class="uni-padding-wrap">
+      <view class="uni-title">请输入剪贴板内容</view>
+      <view class="uni-list">
+        <view class="uni-list-cell">
+          <input class="uni-input" type="text" placeholder="请输入剪贴板内容" :value="data.data" @input="dataChange" />
+        </view>
+      </view>
+      <view class="uni-btn-v">
+        <button type="primary" @click="setClipboard">存储数据</button>
+        <button @tap="getClipboard">读取数据</button>
+      </view>
+    </view>
+  </view>
+</template>
+
+
+<style>
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/compass.md

@@ -0,0 +1,351 @@
+## uni.onCompassChange(callback) @oncompasschange
+
+监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听
+
+### onCompassChange 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 5.08 | 5.08 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| callback | (result: [OnCompassChangeCallbackResult](#oncompasschangecallbackresult-values)) => void | 是 | 罗盘数据变化事件的监听函数 | 
+
+### OnCompassChangeCallbackResult 的属性值 @oncompasschangecallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| direction | number | 是 | 面对的方向度数 |
+| accuracy | number \| string | 否 | 精度 |
+| errMsg | string | 否 | 错误信息 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.onCompassChange)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/compass.html#oncompasschange)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.onCompassChange.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=onCompassChange&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=onCompassChange&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=onCompassChange&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=onCompassChange&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=onCompassChange)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=onCompassChange&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## uni.offCompassChange(callback) @offcompasschange
+
+取消监听罗盘数据
+
+### offCompassChange 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 5.08 | 5.08 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| callback | (result: [OnCompassChangeCallbackResult](#oncompasschangecallbackresult-values)) => void | 否 | onCompassChange 传入的监听函数。不传此参数则移除所有监听函数。 | 
+
+### OnCompassChangeCallbackResult 的属性值 @oncompasschangecallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| direction | number | 是 | 面对的方向度数 |
+| accuracy | number \| string | 否 | 精度 |
+| errMsg | string | 否 | 错误信息 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.offCompassChange)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/compass.html#offcompasschange)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.offCompassChange.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=offCompassChange&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=offCompassChange&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=offCompassChange&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=offCompassChange&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=offCompassChange)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=offCompassChange&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## uni.startCompass(options?) @startcompass
+
+开始监听罗盘数据
+
+### startCompass 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 5.08 | 5.08 | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **StartCompassOptions** | 否 | 开始监听罗盘数据的参数 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| success | (res: [StartCompassSuccess](#startcompasssuccess-values)) => void | 否 | 开始监听罗盘数据调用成功的回调函数 |
+| fail | (res: [StartCompassFail](#startcompassfail-values)) => void | 否 | 开始监听罗盘数据调用失败的回调函数 |
+| complete | (res: [StartCompassSuccess](#startcompasssuccess-values) \| [StartCompassFail](#startcompassfail-values)) => void | 否 | 开始监听罗盘数据调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### StartCompassSuccess 的属性值 @startcompasssuccess-values 
+
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| errMsg | string | 否 |
+
+#### StartCompassFail 的属性值 @startcompassfail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 |  |
+| 合法值 |
+| :- |
+| 601 |
+| 602 |
+| 603 |
+| 604 |
+| 701 |
+| 702 |
+| 703 |
+| 704 |
+| 801 |
+| 802 |
+| 803 |
+| 804 |
+| 501 |
+| 502 |
+| 503 |
+| 504 |
+| 901 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.startCompass)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/compass.html#startcompass)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.startCompass.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=startCompass&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=startCompass&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=startCompass&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=startCompass&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=startCompass)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=startCompass&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## uni.stopCompass(options?) @stopcompass
+
+停止监听罗盘数据
+
+### stopCompass 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 5.08 | 5.08 | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **StopCompassOptions** | 否 | 停止监听罗盘数据的参数 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| success | (res: [StopCompassSuccess](#stopcompasssuccess-values)) => void | 否 | 停止监听罗盘数据调用成功的回调函数 |
+| fail | (res: [StopCompassFail](#stopcompassfail-values)) => void | 否 | 停止监听罗盘数据调用失败的回调函数 |
+| complete | (res: [StopCompassSuccess](#stopcompasssuccess-values) \| [StopCompassFail](#stopcompassfail-values)) => void | 否 | 停止监听罗盘数据调用结束的回调函数（调用成功、失败都会执行） | 
+
+#### StopCompassSuccess 的属性值 @stopcompasssuccess-values 
+
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| errMsg | string | 否 |
+
+#### StopCompassFail 的属性值 @stopcompassfail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 |  |
+| 合法值 |
+| :- |
+| 601 |
+| 602 |
+| 603 |
+| 604 |
+| 701 |
+| 702 |
+| 703 |
+| 704 |
+| 801 |
+| 802 |
+| 803 |
+| 804 |
+| 501 |
+| 502 |
+| 503 |
+| 504 |
+| 901 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.stopCompass)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/compass.html#stopcompass)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.stopCompass.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=stopCompass&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=stopCompass&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=stopCompass&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=stopCompass&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=stopCompass)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=stopCompass&from=docs)
+- [京东小程序文档](https://mp-docs.jd.com/doc/dev/framework/-1)
+- [华为快应用文档](https://developer.huawei.com/consumer/cn/doc/quickApp-References/webview-frame-overview-0000001124793625)
+- [360小程序文档](https://mp.360.cn/doc/miniprogram/dev/#/b770a184ff1f06c6b3393a0fd1132380)
+
+## 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/compass/compass.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/compass/compass.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/compass/compass
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/compass/compass
+
+>示例
+```vue
+<template>
+	
+	<scroll-view style="flex: 1;padding: 6px;">
+	
+		<text class="uni-h2">罗盘 API</text>
+		<text class="notice">演示 `uni.startCompass`、`uni.stopCompass`、`uni.onCompassChange`、`uni.offCompassChange` 的完整流程。靠近强磁场或金属物体时数据可能抖动，可做“8”字校准。Web平台需使用https</text>
+		<text class="margin-v">先绑定监听，再启动采集，更容易观察回调是否生效。</text>
+
+		<text class="uni-h3">实时信息</text>
+		<view class="panel-list">
+			<text class="panel-item" v-for="item in infoItems" :key="item.label">{{ item.label }}：{{ item.value }}</text>
+		</view>
+
+		<text class="uni-h3">当前方位</text>
+		<view class="compass-card">
+			<view class="bg-compass-line"></view>
+			<image class="bg-compass" src="/static/compass.png" :style="compassStyle" />
+			<view class="direction-center">
+				<text class="direction-value">{{ directionText }}</text>
+				<text class="direction-degree">{{ degreeText }}</text>
+			</view>
+		</view>
+
+		<view class="uni-row">
+			<button id="btn-bind-primary-listener" class="margin-v" @tap="bindPrimaryListener">注册罗盘Change</button>
+			<button id="btn-remove-primary-listener" class="margin-v" style="margin-left: 3px;" @tap="removePrimaryListener">注销罗盘Change</button>
+		</view>
+		<view class="uni-row">
+			<button id="btn-start-compass" class="margin-v" type="primary" @tap="startCompassListen">uni.startCompass</button>
+			<button id="btn-stop-compass" class="margin-v" style="margin-left: 3px;" @tap="stopCompassListen">uni.stopCompass</button>
+		</view>
+		<text>重复绑定测试</text>
+		<view class="uni-row">
+			<button id="btn-bind-secondary-listener" class="margin-v" @tap="bindSecondaryListener">注册罗盘Change2</button>
+			<button id="btn-remove-secondary-listener" class="margin-v" style="margin-left: 3px;" @tap="removeSecondaryListener">注销罗盘Change2</button>
+		</view>
+		<text class="uni-h3">监听日志</text>
+		<view class="panel-list">
+			<text class="panel-item" v-for="item in logItems" :key="item.id">{{ item.text }}</text>
+		</view>
+	
+	</scroll-view>
+	
+</template>
+
+<style>
+	.margin-v {
+		margin: 5px 0;
+	}
+
+	.notice {
+		color: #6b2d16;
+		font-size: 14px;
+	}
+
+	.panel-list {
+		margin: 5px 0;
+		padding: 10px;
+		border: 1px solid #ccc;
+		display: flex;
+		flex-direction: column;
+	}
+
+	.panel-item {
+		font-size: 14px;
+		margin: 4px 0;
+	}
+
+	.compass-card {
+		position: relative;
+		margin: 12px auto;
+		width: 270px;
+		height: 270px;
+		display: flex;
+		flex-direction: column;
+		align-items: center;
+		justify-content: center;
+	}
+
+	.direction-center {
+		position: relative;
+		z-index: 1;
+		display: flex;
+		flex-direction: column;
+		align-items: center;
+	}
+
+	.direction-value {
+		font-size: 30px;
+	}
+
+	.direction-degree {
+		font-size: 16px;
+		margin-top: 6px;
+	}
+
+	.bg-compass {
+		position: absolute;
+		top: 0;
+		left: 0;
+		width: 270px;
+		height: 270px;
+		transition-duration: 0.1s;
+	}
+
+	.bg-compass-line {
+		position: absolute;
+		left: 134px;
+		top: -5px;
+		width: 3px;
+		height: 28px;
+		background-color: #1aad19;
+		border-radius: 100px;
+		z-index: 1;
+	}
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |