tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/component/ad.md

@@ -0,0 +1,124 @@
+::: sourceCode
+## ad
+
+广告
+
+ad组件是一种展现在页面中间的广告。它可以用于banner广告，也可以用于信息流广告。
+
+- uni-ad的业务介绍：[详见](https://uniapp.dcloud.net.cn/uni-ad/intro.html)
+
+上述文档是uni-app和uni-app x的通用文档，如遇到uni-app x不一致的文档，需以uni-app x文档为准。
+
+开通广告，需在 [https://uniad.dcloud.net.cn/](https://uniad.dcloud.net.cn/) 管理后台开通。
+
+开通时需要进行开发者认证和应用资质审核。
+
+2. 获取和使用广告位id
+
+开通uni-ad后，在[uni-ad后台](https://uniad.dcloud.net.cn/)给应用创建信息流广告位后，需要拿到广告位id（adpid），传入ad组件的属性 `adpid`中。
+
+3. 配置广告模块
+
+App平台在manifest中配置添加三方广告SDK。具体配置可参考[文档](../collocation/manifest-modules.md#uni-ad)。
+
+打正式包或自定义基座后可生效。标准基座包含的是测试广告位，无法为你产生收益。
+
+### 兼容性 
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | 4.31 | 4.31 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
+
+### 属性 
+| 名称 | 类型 | 兼容性 | 描述 |
+| :- | :- |  :-: | :- |
+| adpid | string | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS x（部分支持，见上） | 广告位id，在uniAD官网申请广告位 |
+| unit-id | string | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(string)*<br/>广告单元id，可在[小程序管理后台](https://mp.weixin.qq.com)的流量主模块新建 |
+| ad-intervals | number | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(number)*<br/>广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 Banner 广告不会自动刷新） |
+| ad-type | string | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(string)*<br/>广告类型，默认为展示banner，可通过设置该属性为`video`展示视频广告, `grid`为格子广告 |
+| ad-theme | string | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(string)*<br/> |
+| @load | (event: UniEvent) => void | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS x（部分支持，见上） | 广告加载成功的回调 |
+| @close | (event: UniEvent) => void | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS x（部分支持，见上） | 广告关闭的回调 |
+| @error | (e:[UniAdErrorEvent](#uniaderrorevent)) => void | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS x（部分支持，见上） | 广告加载失败的回调 |
+| @clicked | Event |   |   |
+
+### 事件
+#### UniAdErrorEvent
+
+##### UniAdErrorEvent 的属性值
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| detail | **IUniAdError** | 是 |  |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | 错误码<br/>- -5001 广告位标识adpid为空，请传入有效的adpid<br/>- -5002 无效的广告位标识adpid，请使用正确的adpid<br/>- -5003 广告位未开通广告，请在广告平台申请并确保已审核通过<br/>- -5004 无广告模块，打包时请配置要使用的广告模块<br/>- -5005 广告加载失败，请稍后重试<br/>- -5006 广告已经展示过了，请重新加载<br/>- -5007 广告不可用或已过期，请重新请求<br/>- -5008 广告不可用或已过期，请重新请求<br/>- -5009 广告类型不符，请检查后再试<br/>- -5011 打包或开通的渠道，不支持此类型广告<br/>- -5013 广告播放失败，请重新加载 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+| bubbles | boolean | 是 | 是否冒泡 |
+| cancelable | boolean | 是 | 是否可以取消 |
+| type | string | 是 | 事件类型 |
+| target | UniElement | 否 | 触发事件的组件 |
+| currentTarget | UniElement | 否 | 当前组件 |
+| timeStamp | Long | 是 | 事件发生时的时间戳 |
+
+##### UniAdErrorEvent 的方法
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |
+| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |
+
+### 子组件 @children-tags
+不可以嵌套组件
+
+## Tips
+
++ uni-app x 标准基座信息流广告测试广告位id为`1111111111`。正式开发需配置自己的广告位id，并且打包自定义基座后生效。
++ `<ad>` 组件测试广告位是上图下文，uni-ad后台申请的广告位默认左图右文。
++ 信息流广告不需要设置`height`属性，广告渲染成功之后会自动撑开。
+
+### 示例
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/component/ad/ad.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/component/ad/ad.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/component/ad/ad
+```uvue
+<template>
+  <view>
+    <page-head title="信息流广告"></page-head>
+    
+    <ad adpid="1111111111" style="width: 100%;" @load="loadFun" @error="errorFun"></ad>
+    
+    
+    <view class="uni-center">微信小程序平台暂不支持测试广告位，需要开通uni-ad后可测试</view>
+    
+    <view v-if="tips" class="uni-center">信息流广告加载失败，请退出当前页面重试。</view>
+    
+    <button @click="pushList">列表-信息流</button>
+    
+    <button @click="pushVideoAd">视频贴片-非全屏</button>
+    <button @click="pushVideoAdL">视频贴片-横向全屏</button>
+    <button @click="pushVideoAdP">视频贴片-竖向全屏</button>
+  </view>
+</template>
+
+
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=component.ad.ad)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/component/ad.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/component/ad.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=ad&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=ad&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=ad&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=ad&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=ad)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=ad&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)

package/data/uniappx/component/animation-view.md

@@ -0,0 +1,51 @@
+::: sourceCode
+## animation-view
+
+> GitCode: https://gitcode.com/dcloud/uni-component/tree/alpha/uni_modules/uni-animation-view
+
+> GitHub: https://github.com/dcloudio/uni-component/tree/alpha/uni_modules/uni-animation-view
+
+Lottie 动画
+
+> 本 Component 是 uni ext component，需下载插件：[animation-view](https://ext.dcloud.net.cn/plugin?id=28623)
+
+### 兼容性 
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| √ | √ | 3.9 | 4.11 | 5.0 |
+
+标准基座并不包含本插件，下载插件后需编写调用代码并打包自定义基座才可运行。
+
+### 属性 
+| 名称 | 类型 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| path | string | "" | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 动画资源地址，目前只支持绝对路径 |
+| loop | boolean | false | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 动画是否循环播放 |
+| autoplay | boolean | false | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 动画是否自动播放 |
+| action | string | "stop" | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 动画操作，可取值 play、pause、stop |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| play | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 播放 |
+| pause | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 暂停 |
+| stop | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 停止 |
+| hidden | boolean | false | Web √ / 微信小程序 √ / Android 3.9 / iOS 4.11 / HarmonyOS 5.0 | 是否隐藏动画 |
+| @ended | (event: UniEvent) => void |   | Web √ / 微信小程序 x / Android 3.9 / iOS 4.11 / HarmonyOS 5.0（部分支持，见上） |   |
+
+### 子组件 @children-tags
+不可以嵌套组件
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=component.media.animation-view)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/component/animation-view.html)
+- [插件市场](https://ext.dcloud.net.cn/plugin?id=28623)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=animation-view&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=animation-view&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=animation-view&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=animation-view&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=animation-view&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=animation-view)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=animation-view&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)

package/data/uniappx/component/aria-component.md

@@ -0,0 +1,21 @@
+::: sourceCode
+## aria-component
+
+### 兼容性 
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=component.wx.other.aria-component)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/component/aria-component.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=aria-component&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=aria-component&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=aria-component&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=aria-component&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=aria-component)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=aria-component&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)

package/data/uniappx/component/audio.md

@@ -0,0 +1,4 @@
+layout: SimpleLayout
+
+::: danger
+该组件不支持

package/data/uniappx/component/block.md

@@ -0,0 +1,26 @@
+::: sourceCode
+## block
+
+block节点
+
+推荐使用 `<template>` ，更跨端。`<block>` 仅为向下兼容而保留
+
+### 兼容性 
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.11 | 4.61 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=component.other.block)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/tutorial/page.html#template-block)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/reference/wxml/conditional.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=block&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=block&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=block&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=block&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=block)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=block&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)

package/data/uniappx/component/button.md

@@ -0,0 +1,298 @@
+::: sourceCode
+## button
+
+> 组件类型：UniButtonElement 
+
+ 按钮
+
+### 兼容性 
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.9 | 4.11 | 4.61 |
+
+### 属性 
+| 名称 | 类型 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| disabled | boolean | false | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 是否禁用 |
+| hover-class | string(string.ClassString) | "button-hover" | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 指定按下去的样式类。当 hover-class="none" 时，没有点击态效果 |
+| hover-stop-propagation | boolean | false | Web x / 微信小程序 4.41 / Android(VDOM) x / Android(Vapor) 5.21 / iOS(VDOM) x / iOS(Vapor) 5.11 / HarmonyOS(Vapor) 5.0（部分支持，见上） | 指定是否阻止本节点的祖先节点出现点击态 |
+| hover-start-time | number | 20 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 按住后多久出现点击态，单位毫秒 |
+| hover-stay-time | number | 70 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 手指松开后点击态保留时间，单位毫秒 |
+| size | string | "default" | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 按钮大小 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| default | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 默认大小 |
+| mini | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 小尺寸 |
+| type | string | "default" | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 按钮类型 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| default | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 白色 |
+| primary | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 蓝色 |
+| warn | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 红色 |
+| plain | boolean | false | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 按钮是否镂空，背景色透明 |
+| loading | boolean | false | Web 4.0 / 微信小程序 4.41 / Android(VDOM) x / Android(Vapor) 5.21 / iOS(VDOM) x / iOS(Vapor) 5.11 / HarmonyOS(VDOM) x / HarmonyOS(Vapor) 5.0（部分支持，见上） | 名称前是否带 loading 图标 |
+| form-type | string |   | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 用于 form 组件，点击分别会触发 form 组件的 submit/reset 事件 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| submit | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 提交表单 |
+| reset | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 重置表单 |
+| open-type | string |   | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS 4.61（部分支持，见上） | 开放能力 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| agreePrivacyAuthorization | Web x / 微信小程序 4.41 / Android 4.31 / iOS 4.31 / HarmonyOS 4.61（部分支持，见上） | 用户同意隐私协议按钮。用户点击一次此按钮后，所有已声明过的隐私接口可以正常调用。 |
+| feedback | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开“意见反馈”页面，用户可提交反馈内容并上传日志 |
+| share | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 触发用户转发 |
+| getUserInfo | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 获取用户信息，可以从@getuserinfo回调中获取到用户信息 |
+| contact | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开客服会话，如果用户在会话中点击消息卡片后返回应用，可以从 @contact 回调中获得具体信息 |
+| getPhoneNumber | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 获取用户手机号，可以从@getphonenumber回调中获取到用户信息 |
+| launchApp | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开APP，可以通过app-parameter属性设定向APP传的参数 |
+| openSetting | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开授权设置页 |
+| chooseAvatar | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 获取用户头像，可以从@chooseavatar回调中获取到头像信息 |
+| getAuthorize | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 支持小程序授权 |
+| lifestyle | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 关注生活号 |
+| contactShare | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 分享到通讯录好友 |
+| openGroupProfile | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 呼起QQ群资料卡页面，可以通过group-id属性设定需要打开的群资料卡的群号，同时manifest.json中必须配置groupIdList |
+| openGuildProfile | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 呼起频道页面，可以通过guild-id属性设定需要打开的频道ID |
+| openPublicProfile | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 打开公众号资料卡，可以通过public-id属性设定需要打开的公众号资料卡的号码，同时manifest.json中必须配置publicIdList |
+| shareMessageToFriend | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 在自定义开放数据域组件中,向指定好友发起分享 |
+| addFriend | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 添加好友，对方需要通过该小程序进行授权，允许被加好友后才能调用成功用户授权 |
+| addColorSign | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 添加彩签，点击后添加状态有用户提示，无回调 |
+| addGroupApp | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 添加群应用（只有管理员或群主有权操作），添加后给button绑定@addgroupapp事件接收回调数据 |
+| addToFavorites | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 收藏当前页面，点击按钮后会触发Page.onAddToFavorites方法 |
+| chooseAddress | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 选择用户收货地址，可以从@chooseaddress回调中获取到用户选择的地址信息 |
+| chooseInvoiceTitle | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 选择用户发票抬头，可以从@chooseinvoicetitle回调中获取到用户选择发票抬头信息 |
+| login | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 登录，可以从@login回调中确认是否登录成功 |
+| subscribe | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 订阅类模板消息，需要用户授权才可发送 |
+| favorite | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 触发用户收藏 |
+| watchLater | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 触发用户稍后再看 |
+| openProfile | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 触发打开用户主页 |
+| liveActivity | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 通过前端获取[新的一次性订阅消息下发机制](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message-2.html)使用的 code |
+| getRealtimePhoneNumber | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 手机号实时验证，向用户申请，并在用户同意后，快速填写和实时验证手机号。[具体说明]((getRealtimePhoneNumber)) （*小程序插件中不能使用*） |
+| lang | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。 |
+| 合法值 | 兼容性 | 描述 |
+| :- |  :-: | :- |
+| en | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 英文 |
+| zh_CN | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 简体中文 |
+| zh_TW | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 繁体中文 |
+| session-from | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 会话来源 |
+| send-message-title | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 会话内消息卡片标题 |
+| send-message-path | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 会话内消息卡片点击跳转应用路径 |
+| send-message-img | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 会话内消息卡片图片 |
+| show-message-card | boolean |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 显示会话内消息卡片 |
+| app-parameter | string |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开 APP 时，向 APP 传递的参数 |
+| group-id | string |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 打开群资料卡时，传递的群号 |
+| guild-id | string |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 打开频道页面时，传递的频道号 |
+| public-id | string |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 打开公众号资料卡时，传递的号码 |
+| phone-number-no-quota-toast | boolean |   | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(boolean)*<br/>当手机号快速验证或手机号实时验证额度用尽时，是否对用户展示“申请获取你的手机号，但该功能使用次数已达当前小程序上限，暂时无法使用”的提示，默认展示，open-type="getPhoneNumber" 或 open-type="getRealtimePhoneNumber" 时有效 |
+| createliveactivity | eventhandle |   | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(eventhandle)*<br/>[新的一次性订阅消息下发机制](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message-2.html)回调，open-type=liveActivity时有效 |
+| loading-class | string(string.ClassString) |   | Android(Vapor) 5.21 / iOS(Vapor) 5.11 / HarmonyOS(Vapor) 5.0（部分支持，见上） | loading 图标的类名 |
+| loading-text-class | string(string.ClassString) |   | Android(Vapor) 5.21 / iOS(Vapor) 5.21 / HarmonyOS(Vapor) 5.21（部分支持，见上） | loading 文案的类名 |
+| ios-loading-snow | boolean | false | iOS(Vapor) 5.11（部分支持，见上） | iOS 雪花加载效果 |
+| @getuserinfo | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与uni.getUserInfo返回的一致 |
+| @contact | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 客服消息回调 |
+| @getphonenumber | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 获取用户手机号回调 |
+| @error | (event: UniEvent) => void |   | 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 当使用开放能力时，发生错误的回调 |
+| @opensetting | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 在打开授权设置页后回调 |
+| @launchapp | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 打开 APP 成功的回调 |
+| @chooseavatar | (event: UniEvent) => void |   | Web x / 微信小程序 4.41 / Android x / iOS x（部分支持，见上） | 获取用户头像回调 |
+| @chooseaddress | (event: UniEvent) => void |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 调起用户编辑并选择收货地址的回调 |
+| @chooseinvoicetitle | (event: UniEvent) => void |   | 微信小程序 x / Android x / iOS x（部分支持，见上） | 用户选择发票抬头的回调 |
+| @addgroupapp | (event: UniEvent) => void |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 添加群应用的回调 |
+| @subscribe | (event: UniEvent) => void |   | 微信小程序 x / Android x / iOS x（部分支持，见上） | 订阅消息授权回调 |
+| @login | (event: UniEvent) => void |   | Web x / 微信小程序 x / Android x / iOS x（部分支持，见上） | 登录回调 |
+| @getrealtimephonenumber | eventhandle |   | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(eventhandle)*<br/>手机号实时验证回调，open-type=getRealtimePhoneNumber 时有效。Tips：在触发 bindgetrealtimephonenumber 回调后应立即隐藏手机号按钮组件，或置为 disabled 状态，避免用户重复授权手机号产生额外费用。 |
+| @agreeprivacyauthorization | eventhandle |   | Web x / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | *(eventhandle)*<br/>用户同意隐私协议事件回调，open-type=agreePrivacyAuthorization时有效 （Tips: 如果使用 onNeedPrivacyAuthorization 接口，需要在 bindagreeprivacyauthorization 触发后再调用 `resolve({ event: "agree", buttonId })`） |
+
+### 子组件 @children-tags
+不可以嵌套组件
+
+### 示例
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/component/button/button.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/component/button/button.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/component/button/button
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/component/button/button
+
+>示例
+```vue
+
+
+<template>
+  <view class="main">
+    <button id="testButton" :loading="data.loading" :disabled="data.disabled_boolean"
+      :size="data.size_enum[data.size_enum_current].name" :type="data.type_enum[data.type_enum_current].name"
+      :plain="data.plain_boolean" @touchstart="button_touchstart" @touchmove="button_touchmove"
+      @touchcancel="button_touchcancel" @touchend="button_touchend" @tap="button_tap" @click="button_click"
+      @longpress="button_longpress" class="btn"
+      :loading-text-class="data.loading ? (data.type_enum[data.type_enum_current].name == 'default' ? 'black-loading-text' : 'white-loading-text') : ''"
+      :class="data.default_style ? (data.disabled_boolean ? 'custom-btn-disable' : 'custom-btn') : ''"
+      :hover-class="data.default_style ? 'is-hover' : 'button-hover'">
+      {{ data.text }}
+    </button>
+  </view>
+  <scroll-view style="flex: 1">
+    <view class="content">
+      <boolean-data :defaultValue="false" title="按钮是否镂空，背景色透明" @change="change_plain_boolean"></boolean-data>
+      <boolean-data :defaultValue="false" title="是否禁用" @change="change_disabled_boolean"></boolean-data>
+      <boolean-data :defaultValue="false" title="修改默认样式和点击效果(高优先)" @change="change_default_style"></boolean-data>
+      <boolean-data :defaultValue="false" title="显示loading（限小程序和蒸汽模式的App）" @change="change_loading"></boolean-data>
+      <enum-data :items="data.size_enum" title="按钮的大小" @change="radio_change_size_enum"></enum-data>
+      <enum-data :items="data.type_enum" title="按钮的类型" @change="radio_change_type_enum"></enum-data>
+      <input-data :defaultValue="data.text" title="按钮的文案" type="text" @confirm="confirm_text_input"></input-data>
+      <view style="height: 10px;"></view>
+      <button @click="navigateToChild">更多button示例</button>
+      <view style="height: 10px;"></view>
+      
+      <button @click="openPrivacyDialog">open-type实现App隐私政策弹框</button>
+      <view style="height: 10px;"></view>
+      
+    </view>
+
+    
+      <navigator url="/pages/template/button-100/button-100">
+        <button>组件性能测试</button>
+      </navigator>
+    
+  </scroll-view>
+</template>
+
+<style>
+  .main {
+    padding: 5px 0;
+    border-bottom: 1px solid rgba(0, 0, 0, 0.06);
+    flex-direction: row;
+    justify-content: center;
+  }
+
+  .custom-btn {
+    color: #ffffff;
+    background-color: #1AAD19;
+    border-color: #1AAD19;
+  }
+
+  .custom-btn-disable {
+    color: rgba(255, 255, 255, 0.7);
+    background-color: rgba(26, 173, 25, 0.7);
+    border-color: rgba(26, 173, 25, 0.7);
+  }
+
+  .is-hover {
+    color: rgba(255, 255, 255, 0.6);
+    background-color: #179b16;
+    border-color: #179b16;
+  }
+
+  .button-hover {
+    color: rgba(0, 0, 0, 0.6);
+    background-color: #dedede;
+  }
+
+  .default-button {
+    color: #000000;
+    background-color: #f8f8f8;
+    border-color: rgba(0, 0, 0, 0.2);
+  }
+
+  .black-loading-text {
+    color: #000000
+  }
+
+  .white-loading-text {
+    color: #ffffff
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=component.form-component.button)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/component/button.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/component/button.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=button&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=button&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=button&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=button&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=button)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=button&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)
+
+## 样式修改 @style
+
+button 的 size、type 属性是预置样式，适合快速使用；如需修改文字、背景、边框、尺寸等样式，可直接在 button 组件上使用 style 或 class 覆盖。如需保持样式一致，建议不要依赖 type 的默认颜色。
+
+APP 蒸汽模式不支持属性选择器，建议使用 class 或 style 自定义样式。
+
+APP蒸汽模式、WEB 和微信小程序平台的 button 组件在 `plain` 为 `true` 时，通过 class 配置的 `background-color` 样式不生效，只能通过 style 设置。
+
+```html
+<template>
+	<button class="custom-button" hover-class="custom-button-hover">按钮</button>
+</template>
+
+<style>
+.custom-button {
+	color: #ffffff;
+	background-color: #1AAD19;
+	border-color: #1AAD19;
+}
+
+.custom-button-hover {
+	color: rgba(255, 255, 255, 0.6);
+	background-color: #179b16;
+	border-color: #179b16;
+}
+</style>
+```
+
+## 暗黑模式
+
+App平台蒸汽模式从 5.25+ 起内置适配 button 默认样式的暗黑模式。暗黑模式下，默认按钮背景色为 `#343434`，文字色为 `#d6d6d6`；按下时背景色为 `rgba(255, 255, 255, 0.1)`；禁用时背景色为 `rgba(255, 255, 255, 0.08)`，文字色为 `rgba(255, 255, 255, 0.2)`。
+
+暗黑模式下，默认镂空按钮背景色为 `transparent`，边框色和文字色为 `#353535`；镂空按钮按下时背景色为 `rgba(50, 50, 50, 0.2)`，边框色和文字色为 `rgba(150, 150, 150, 0.6)`；镂空按钮禁用时背景色为 `transparent`，边框色和文字色为 `rgba(255, 255, 255, 0.2)`。
+
+## hover-class 属性值
+
+button 按下后触发 hover-class 效果。点击态取消后的触发规则如下：
+
+- Android 平台：手指不松开并持续在屏幕上移动，离开 button 组件范围后，hover-class 效果消失。
+- iOS 平台：手指按下后，hover-class 效果会保持到手指抬起时消失。
+- 鸿蒙平台、Web 平台：手指移动一点后，即便未离开 button 范围，hover-class 效果也会消失。
+
+button 设置 hover-class 属性规则如下：
+
+- 如果 hover-class 属性值设置为 button-hover 或者不设置 hover-class 属性值，在 style 样式里面设置了同名的 button-hover 样式，点击效果将使用 button-hover 样式。
+- 如果 hover-class 属性值设置为无效值（或非法值），没有点击态效果。
+
+## 点击跳转
+
+button 组件没有 url 属性，点击后需要跳转页面时，可在 @click 中调用路由 API，也可以使用 [navigator](./navigator.md) 组件实现声明式跳转。
+
+```html
+<template>
+	<view>
+		<button @click="gotoAbout">跳转到 about 页面</button>
+		<navigator url="/pages/about/about" open-type="navigate">
+			<button>使用 navigator 跳转到 about 页面</button>
+		</navigator>
+	</view>
+</template>
+
+```
+
+## 隐私协议授权
+
+`open-type="agreePrivacyAuthorization"` 用于开发者在让用户同意隐私协议时，放置“同意”按钮。它不是强制拦截能力，只是开发者和插件作者之间的一种通信方式；未点击该按钮，并不代表技术上会拦截涉及隐私的 API 调用。[详见](../api/privacy.md)
+
+## 文本显示
+
+- 如果 button 组件的文本内容包含 `\n`，VDOM 模式 APP 和 web 会被渲染为字符，不会换行，微信小程序会移除换行符号。蒸汽模式 APP 会移除 `\n` 旁的文字。
+- VDOM 模式 button 默认文字大小为 18px，文字行高为 2.5。自定义高度时，需要同步调整 line-height。
+- APP 蒸汽模式下，button 的文字居中依赖 padding。调整 height 和 line-height 时，建议同时将 padding-top、padding-bottom 设置为 0。
+
+```html
+<template>
+	<button style="height: 50px; line-height: 50px; padding-top: 0; padding-bottom: 0;">按钮</button>
+</template>
+```