tmui-cli 2.0.3 → 2.0.4

package/data/uniappx/api/load-font-face.md

@@ -0,0 +1,206 @@
+::: sourceCode
+## uni.loadFontFace(options) @loadfontface
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-loadFontFace
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-loadFontFace
+
+动态加载网络字体
+
+### loadFontFace 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | √ | 4.10 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **LoadFontFaceOptions** | 是 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| global | boolean | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS x / HarmonyOS x（部分支持，见上） | 是否全局生效微信小程序 '2.10.0'起支持全局生效。需在 app.uvue 中调用。 |
+| family | string | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.10 / HarmonyOS 4.61 | 定义的字体名称 |
+| source | string.FontURIString | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.10 / HarmonyOS 4.61 | 字体资源的地址, App-Android 平台不支持 woff、woff2 格式字体文件 |
+| desc | **LoadFontFaceOptionDesc** | 否 | Web 4.0 / 微信小程序 4.41 / Android x / iOS 4.10 / HarmonyOS x（部分支持，见上） | 可选的字体描述符 |
+@@| 名称 | 类型 | 必备 |
+@@| :- | :- | :- |
+@@| style | string | 否 |
+@@| weight | string | 否 |
+@@| variant | string | 否 |
+| success | (result: [LoadFontFaceSuccess](#loadfontfacesuccess-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.10（部分支持，见上） | 接口调用成功的回调函数 |
+| fail | (error: [LoadFontFaceFail](#loadfontfacefail-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.10（部分支持，见上） | 接口调用失败的回调函数 |
+| complete | (res: [LoadFontFaceComplete](#loadfontfacecomplete-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.10（部分支持，见上） | 接口调用结束的回调函数（调用成功、失败都会执行） |
+| scopes | Array&lt;any&gt; | 否 | 微信小程序 4.41（部分支持，见上） | 字体作用范围，可选值为 webview / native / skyline，默认全选，设置 native 可在 Canvas 2D 下使用<br/> | 
+
+#### LoadFontFaceSuccess 的属性值 @loadfontfacesuccess-values 
+
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| errMsg | string | 是 |
+
+#### LoadFontFaceFail 的属性值 @loadfontfacefail-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errCode | number | 是 |   | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 4 | 框架内部异常 |
+| 99 | page is not ready |
+| 101 | 参数错误 |
+| 100001 | family is null |
+| 100002 | source is null |
+| 200001 | local font not found |
+| 300001 | same source task is loading |
+| 300002 | download fail |
+| status | string | 否 | 微信小程序 4.41（部分支持，见上） | 加载字体结果<br/> |
+| errSubject | string | 是 |   | 统一错误主题（模块）名称 |
+| data | any | 否 |   | 错误信息中包含的数据 |
+| cause | Error | 否 |   | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |   |  |
+
+#### LoadFontFaceComplete 的属性值 @loadfontfacecomplete-values 
+
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| errMsg | string | 是 |
+
+### 返回值 
+
+| 类型 | 必备 |
+| :- | :- |
+| Promise\<**LoadFontFaceSuccess**> | 否 |
+| 名称 | 类型 | 必备 |
+| :- | :- | :- |
+| errMsg | string | 是 |
+
+### 注意事项
+- `app-ios 平台` 加载字体一定是全局生效，不支持通过global属性设置为非全局生效
+- source 属性指定自定义字体路径，支持本地文件路径、远程地址，app 平台 4.33 版本开始支持 base64 格式数据；必须使用`url()`包裹。可能某些平台不包裹也可以生效，但标准规范是包裹，按标准写法才能全端生效。如下：
+  ```uts
+  uni.loadFontFace({
+    global: true,
+    family: 'UniFontFamily',
+    source: "url('/static/font/uni.ttf')", //需使用url方法包裹。本地字体请放在/static目录下，否则打包时不会把字体文件打进去。也支持网络字体
+    success() {
+      console.log('global loadFontFace uni.ttf success')
+    },
+    fail(error) {
+      console.warn('global loadFontFace uni.ttf fail', error.errMsg)
+    },
+  })
+  ```
+- `HarmonyOS 注意事项`
+  1. 使用 [@ohos.font](https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V13/js-apis-font-V13?ha_source=Dcloud&ha_sourceId=89000448) 实现
+    - [x] ttf
+    - [x] otf
+  2. base64 格式字体是通过转换成 buffer 保存在磁盘上并引入实现的，因此页面上过多的使用 base64 可能会有性能问题
+  3. HarmonyOS 字体都是全局生效的
+
+- 不同平台支持的字体格式不同，另见[css字体](../css/font-family.md)
+
+- app平台由于不支持伪元素，字体图标加载需使用unicode直显。[详见](./common/at-rules.md)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/load-font-face/load-font-face.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/load-font-face/load-font-face.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/load-font-face/load-font-face
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/load-font-face/load-font-face
+
+>示例
+```vue
+<template>
+  <page-head title="loadFontFace"></page-head>
+  <page-intro content="本页演示 uni.loadFontFace：全局与非全局加载字体（本地、base64、网络），展示各字体效果；可跳转子页测试字体生效范围。"></page-intro>
+  <view class="uni-padding-wrap">
+    <text class="font-size-20">全局加载字体：</text>
+    <text class="font-size-20 line-height-40" style="font-family: UniFontFamily">font-family: uni.ttf</text>
+    <view style="flex-direction: row;">
+      
+      
+      <text class="font-size-20" style="font-family: UniFontFamily2;">{{data.uniIcon3}}</text>
+      <text class="icon-text">\ue102</text>
+      
+      
+      <text class="font-size-20" style="font-family: UniFontFamily;">{{data.uniIcon1}}</text>
+      <text class="icon-text">\ue100</text>
+      <text class="font-size-20" style="font-family: UniFontFamily;">{{data.uniIcon2}}</text>
+      <text style="margin-left:5px;line-height:22px;">\ue101</text>
+      
+    </view>
+    
+    <text class="font-size-20 line-height-40" style="font-family: UniFontFamily">实体字符</text>
+    <view style="flex-direction: row;">
+      
+      <text class="font-size-20" style="font-family: UniFontFamily2;">&#xe102; &amp;#xe102;</text>
+      
+      
+      <text class="font-size-20" style="font-family: UniFontFamily;">&#xe100; &amp;#xe100;</text>
+      <text class="font-size-20" style="font-family: UniFontFamily; margin-left: 5px;">&#xe101; &amp;#xe101;</text>
+      
+    </view>
+    
+    
+    <text class="uni-common-mt font-size-20">非全局加载字体：</text>
+    
+    <text class="font-size-20 line-height-40">font-family: uni.ttf(base64格式)</text>
+    <view style="flex-direction: row;">
+      <text class="font-size-20" style="font-family: UniFontFamily2;">{{data.uniIcon3}}</text>
+      <text class="icon-text">\ue102</text>
+    </view>
+    <text class="font-size-20 line-height-40" style="font-family: AlimamaDaoLiTiTTF">font-family: 阿里妈妈刀隶体-ttf
+      (网络字体下载后生效)</text>
+    <text class="font-size-20 line-height-40" style="font-family: AlimamaDaoLiTiOTF">font-family:
+      阿里妈妈刀隶体-otf</text>
+
+    
+    <text class="item" style="font-family: AlimamaDaoLiTiWOFF">font-family: 阿里妈妈刀隶体-woff</text>
+    <text class="item" style="font-family: AlimamaDaoLiTiWOFF2">font-family: 阿里妈妈刀隶体-woff2</text>
+    
+    <button class="uni-btn" @click="navigateToChild">跳转子页面测试字体生效范围</button>
+  </view>
+</template>
+
+
+<style>
+  .font-size-20 {
+    font-size: 20px;
+  }
+
+  .line-height-40 {
+    line-height: 40px;
+  }
+
+  .icon-text{
+    margin-left:5px;
+    margin-right: 20px;
+    line-height:22px;
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.loadFontFace)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/font.html#loadfontface)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=loadFontFace&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=loadFontFace&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=loadFontFace&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=loadFontFace&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=loadFontFace)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=loadFontFace&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)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/loading.md

@@ -0,0 +1,186 @@
+::: sourceCode
+## uni.showLoading(options?) @showloading
+
+> 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
+
+显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。
+
+它是一个悬浮弹出的、非组件内嵌的加载中提示。
+
+### showLoading 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.61 | 4.61 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **ShowLoadingOptions** | 否 | uni.showLoading参数定义 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| title | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | 提示的内容，长度与 icon 取值有关。 |
+| mask | boolean | 否 | Web 4.0 / 微信小程序 4.41 / Android x / iOS x / HarmonyOS x（部分支持，见上） | 是否显示透明蒙层，防止触摸穿透，默认：false |
+| success | (res: [ShowLoadingSuccess](#showloadingsuccess-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.showLoading成功回调函数定义 |
+| fail | (res: [ShowLoadingFail](#showloadingfail-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.showLoading失败回调函数定义 |
+| complete | (res: any) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.showLoading完成回调函数定义 | 
+
+#### ShowLoadingSuccess 的属性值 @showloadingsuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errMsg | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | 错误信息 |
+
+#### ShowLoadingFail 的属性值 @showloadingfail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | uni.showLoading失败回调参数 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 返回值 
+
+| 类型 | 必备 |
+| :- | :- |
+| UniPage | 否 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.loading.showLoading)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=showLoading&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=showLoading&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=showLoading&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=showLoading&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=showLoading)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=showLoading&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.hideLoading(options?) @hideloading
+
+> 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
+
+隐藏 loading 提示框。
+
+### hideLoading 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.61 | 4.61 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **HideLoadingOptions** | 否 | uni.hideLoading参数定义 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| loadingPage | UniPage | 否 | Web 4.0 / 微信小程序 x / Android 4.61 / iOS 4.61 / HarmonyOS 4.61（部分支持，见上） | 期望隐藏的目标LoadingPage 如果为null 会关闭当前栈顶全部LoadingPage |
+| success | (res: [HideLoadingSuccess](#hideloadingsuccess-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.hideLoading成功回调函数定义 |
+| fail | (res: [HideLoadingFail](#hideloadingfail-values)) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.hideLoading失败回调函数定义 |
+| complete | (res: any) => void | 否 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | uni.hideLoading完成回调函数定义 |
+| noConflict | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.22.1`<br/><br/>目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性<br/> | 
+
+#### HideLoadingSuccess 的属性值 @hideloadingsuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| errMsg | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 4.61 / iOS 4.61 / HarmonyOS 4.61 | 错误信息 |
+
+#### HideLoadingFail 的属性值 @hideloadingfail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | uni.hideLoading失败回调参数 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.loading.hideLoading)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/ui/prompt.html#hideloading)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideLoading.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=hideLoading&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=hideLoading&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=hideLoading&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=hideLoading&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=hideLoading)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=hideLoading&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/loading/loading.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/loading/loading.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/loading/loading
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/loading/loading
+
+>示例
+```vue
+<template>
+	<view>
+		<page-head :title="data.title"></page-head>
+		<enum-data :items="titleOptions" title="设置标题" @change="radioChange"></enum-data>
+
+		<view class="uni-padding-wrap">
+			<view class="uni-btn-v">
+				<button type="primary" @click="showLoading">显示 loading 提示框</button>
+				<button @click="hideLoading">隐藏 loading 提示框</button>
+				<text>为方便演示，loading弹出3秒后自动关闭</text>
+			</view>
+		</view>
+		<view class="uni-padding-wrap">
+			<text>{{data.callbackText}}</text>
+			<view class="uni-btn-v">
+				<button type="primary" @click="closeSomeLoading">关闭指定loading</button>
+				<button type="primary" @click="noParamLoading">无参数测试</button>
+			</view>
+		</view>
+	</view>
+</template>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |
+
+## Tips@tips
+
+* 关于uni.showLoading和[loading组件](../component/loading.md)的区别：
+	+ showLoading是一个简易的API，使用简单。因为它悬浮在页面上方、让页面整体失去响应。主流的App较少使用这种方式。
+	+ loading组件是内置组件，无需在页面显式引入，可以嵌入页面中、按钮中。
+* 从HBuilderX 5.0+，在App和Web平台，showLoading统一成一套代码，使用dialogPage的页面中显示一个loading组件来实现。dialogPage是模态的，不支持点击空白消失，但支持back关闭。需要非模态的使用场景时，请在页面中直接使用[loading组件](../component/loading.md)。
+* showLoading 是和页面（包括 dialogPage）绑定的。
+	+ 当showLoading执行时，会寻找当前页面栈顶的窗体（包括 dialogPage），找到后进行绑定，然后弹出loading。
+	+ 在弹出loading后，再次打开新页面，新页面会覆盖原页面弹出的 loading。
+		+ 如需在新页面（包括 dialogPage）弹出 loading，需要再次调用 showLoading
+* 在HBuilderX 5.0以前，HarmonyOS 平台，showLoading 是和 App window 绑定的，目前未与页面关联，当打开新页面时，原页面弹出的 loading 不会被遮挡。HBuilderX 5.0拉齐了实现，与上条策略一致。
+* 当前页面（包括 dialogPage）关闭时，弹出的 loading 都会被自动取消
+	+ 如需在dialogPage关闭后，仍然弹出 Loading，需要在关闭dialogPage后再次调用 showLoading
++ 注意在支持 dialogPage 的平台（Web和App），[uni.showModal](./modal.md)、[uni.showActionSheet](./action-sheet.md) 也是 dialogPage 实现的，此时 showLoading 会绑定到这些 dialogPage 上
+* 在 Web 平台，如果希望通过 `const loadingPage = uni.showLoading(...)` 获取 `loadingPage` 对象，需要至少传入一个回调函数，例如：
+```ts
+uni.showLoading({
+	success: function (showRet : ShowLoadingSuccess) {
+	}
+})
+```

package/data/uniappx/api/locale.md

@@ -0,0 +1,74 @@
+本文档仅为部分API介绍，完整的国际化指南，另见[文档](../i18n.md)
+
+## uni.getLocale() @getlocale
+
+获取当前设置的语言
+
+### getLocale 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 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> |
+
+App端可以在[uni.getDeviceInfo](./get-device-info.md)中获取os的language。
+
+### 返回值 
+
+| 类型 |
+| :- |
+| string |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.locale.getLocale)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/api/ui/locale.html#getlocale)
+
+## uni.setLocale(locale) @setlocale
+
+设置当前语言
+
+### setLocale 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 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> |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| locale | string | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.locale.setLocale)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/api/ui/locale.html#setlocale)
+
+## uni.onLocaleChange(callback) @onlocalechange
+
+设置当前语言
+
+### onLocaleChange 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 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> |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| callback | (result: [OnLocaleChangeCallbackResult](#onlocalechangecallbackresult-values)) => void | 是 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 
+
+### OnLocaleChangeCallbackResult 的属性值 @onlocalechangecallbackresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| locale | string | 否 | Android x / iOS x / HarmonyOS x（部分支持，见上） | 当前语言 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.ui.locale.onLocaleChange)
+- [参见uni-app相关文档](https://uniapp.dcloud.io/api/ui/locale.html#onlocalechange)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |