tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/api/theme.md

@@ -0,0 +1,3 @@
+layout: SimpleLayout
+
+文档已迁移，请前往[themeChange](theme-change.md)查看最新文档

package/data/uniappx/api/toast.md

@@ -0,0 +1,180 @@
+::: sourceCode
+## uni.showToast(options) @showtoast
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-prompt
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-prompt
+
+显示消息提示框
+
+### showToast 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **ShowToastOptions** | 是 | uni.showToast参数定义 |
+| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- | :- |  :-: | :- |
+| title | string | 是 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 提示的内容，长度与 icon 取值有关。 |
+| icon | string | 否 | "success" | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | icon值说明 |
+@@| 合法值 | 兼容性 | 描述 |
+@@| :- |  :-: | :- |
+@@| "success" | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 显示成功图标 |
+@@| error | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 显示错误图标 |
+@@| fail | Web x / 微信小程序 x / Android x / iOS x / HarmonyOS x（不支持） | 显示错误图标，此时title文本无长度显示，支付宝、抖音小程序生效 |
+@@| exception | Web x / 微信小程序 x / Android x / iOS x / HarmonyOS x（不支持） | 显示异常图标，此时title文本无长度显示，支付宝小程序生效 |
+@@| loading | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 显示加载图标 |
+@@| none | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 不显示图标 |
+| image | string.ImageURIString | 否 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 自定义图标的本地路径（app-android/app-ios端暂不支持gif） |
+| mask | boolean | 否 | false | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 5.25 | 是否显示透明蒙层，防止触摸穿透 |
+| duration | number | 否 | 1500 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 提示的延迟时间，单位毫秒 |
+| position | string | 否 |  | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | position值说明。纯文本轻提示显示位置，填写有效值后只有 title 属性生效，且不支持通过 uni.hideToast 隐藏。 |
+@@| 合法值 | 兼容性 | 描述 |
+@@| :- |  :-: | :- |
+@@| "top" | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 居上显示 |
+@@| center | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 居中显示 |
+@@| bottom | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 居底显示 |
+| success | (res: ShowToastSuccess) => void | 否 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | uni.showToast成功回调函数定义 |
+| fail | (res: [ShowToastFail](#showtoastfail-values)) => void | 否 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | uni.showToast失败回调函数定义 |
+| complete | (res: any) => void | 否 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | uni.showToast完成回调函数定义 | 
+
+#### ShowToastFail 的属性值 @showtoastfail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 1 | 撤销 |
+| 1001 | 请求参数非法 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.toast.showToast)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=showToast&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=showToast&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=showToast&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=showToast&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=showToast&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=showToast)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=showToast&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.hideToast() @hidetoast
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-prompt
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-prompt
+
+隐藏消息提示框。
+
+### hideToast 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.toast.hideToast)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#hidetoast)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=hideToast&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=hideToast&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=hideToast&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=hideToast&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=hideToast&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=hideToast)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=hideToast&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/toast/toast.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/toast/toast.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/toast/toast
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/toast/toast
+
+>示例
+```vue
+<template>
+  
+  <scroll-view direction="vertical" style="flex:1">
+  
+    <page-head :title="data.title"></page-head>
+    <view class="uni-padding-wrap">
+      <enum-data :items="iconOptions" title="设置icon" item-class="radio-icon"
+        @change="radioChangeIcon"></enum-data>
+      <boolean-data :defaultValue="data.imageSelect" title="是否显示自定义图标"
+        @change="change_image_boolean"></boolean-data>
+      <boolean-data :defaultValue="data.maskSelect" title="是否显示透明蒙层-屏蔽点击事件"
+        @change="change_mask_boolean"></boolean-data>
+      <view class="uni-title uni-list-cell-padding">提示的延迟时间，默认：1500（单位毫秒）</view>
+      <view class="uni-list-cell-padding">
+        <slider @change="sliderChange" foreColor="#007AFF" :value="data.intervalSelect" :min="1500" :max="5000"
+          :show-value="true" />
+      </view>
+      <view class="uni-btn-v">
+        <button type="default" @tap="toast1Tap" id="btn-toast-default">点击弹出toast</button>
+        <button type="default" @tap="hideToast" id="btn-toast-hide">点击隐藏toast</button>
+      </view>
+      
+      <enum-data :items="positionOptions" title="设置position，仅App生效" item-class="radio-position"
+        @change="radioChangePosition"></enum-data>
+      <button class="uni-btn uni-common-mb" type="default" @tap="toast2Tap">点击弹出设置position的toast</button>
+      
+      <text>{{data.exeRet}}</text>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |
+
+## Bug & Tips@tips
+- 在 iOS、微信小程序、Web 平台，showToast 是和页面（包括 dialogPage）绑定的
+- 在 Android 平台
+	* position 设为 bottom 时，为系统toast，此时与 App 绑定，而不是与页面绑定。position 不为 bottom 时仍与页面绑定
+	* 系统toast 不支持 icon 图标，仅支持文字
+	* 部分 Android ROM，如 MIUI，调用系统 toast 时，会在 toast 行首自动加上 App 图标。此为 ROM 行为，目的是帮助用户区分该 toast 是哪个 App 弹出的
+- 在 HarmonyOS 平台
+  - 5.24 及以下
+    - 只有系统 toast ，和 App window 绑定
+  	- 不支持 icon 图标，仅支持文字
+  - 5.25 及以上：
+  	* position 设为 top、center、bottom 时，为系统 toast，和页面绑定
+  	* 当没有传递 position 参数时，支持 icon、mask、image 参数，和页面绑定
+- 当 Toast 和页面绑定时：
+  + 当showToast执行时，会寻找当前页面栈顶的窗体（包括 dialogPage），找到后进行绑定，然后弹出 Toast。
+	+ 在支持 dialogPage 的平台（Web和App），[uni.showModal](./modal.md)、[uni.showActionSheet](./action-sheet.md) 也是 dialogPage 实现的，此时 toast 会绑定到这些 dialogPage 上
+	+ 在弹出 Toast 后，再次打开新页面，新页面会覆盖原页面弹出的 Toast。
+		+ 如需在新页面（包括 dialogPage）弹出 Toast，需要再次调用 showToast
+  + 关闭页面（包括 dialogPage）时，Toast 会跟随页面（包括 dialogPage）一起消失
+		+ 如需在dialogPage关闭后，仍然弹出 Toast，需要在关闭dialogPage后再次调用 showToast
+- 当 Toast 和应用绑定时，也即系统 toast：
+	弹出和关闭页面，系统 toast 都不会跟随页面被遮挡或消失。
+- Android 11 及以上版本，应用进入后台后，调用系统 toast 不弹出。 [文档地址](https://developer.android.google.cn/about/versions/11/behavior-changes-11?hl=nb#toasts)
+- showToast 里的 Loading，和 showLoading 的区别是，showLoading 需要手动调用 HideLoading 才会关闭。而 showToast 里的 Loading 显示指定时间后会自动关闭。一般情况都需要精准控制关闭时机，所以大多使用 showLoading 和 hideLoading