tmui-cli 2.0.3 → 2.0.5

package/data/uniappx/api/is-simulator.md

@@ -0,0 +1,120 @@
+::: sourceCode
+## uni.isSimulator() @issimulator
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-getDeviceInfo
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-getDeviceInfo
+
+判断当前是否是模拟器，Android设备上会采集传感器信息。
+
+从4.51+，uni.getDeviceInfo里的isSimulator由于隐私政策原因，去掉了访问传感器列表。独立了一个单独的`uni.isSimulator`。
+
+本API可以根据传感器的信息更准确的识别是否为模拟器。但本API在Android平台上线应用商店时，务必注意需要在隐私协议中声明，并确保在隐私协议被用户同意后再调用。
+
+有些模拟器会故意伪装真机，此时可能识别不准确。
+
+iOS平台请暂时继续使用[uni.getDeviceInfo](./get-device-info.md)
+
+### isSimulator 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <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> | 4.51 | 4.51 | <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| boolean |
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/is-simulator/is-simulator.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/is-simulator/is-simulator.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/is-simulator/is-simulator
+```uvue
+<template>
+  
+  <scroll-view style="flex:1">
+  
+    <view>
+      <page-head :title="'isSimulator'"></page-head>
+      <view class="uni-common-mt" style="justify-content: center;align-items: center;">
+        <text>{{
+		        isSimulator ? "当前设备是模拟器" : "当前设备不是模拟器"
+		      }}</text>
+        <text>\n注：有些模拟器会故意伪装为真机，此时识别可能会不准确</text>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+
+<style>
+
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.isSimulator)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/tutorial/app-sec-api.html#issimulator)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=isSimulator&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=isSimulator&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=isSimulator&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=isSimulator&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=isSimulator&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=isSimulator)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=isSimulator&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/is-simulator/is-simulator.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/is-simulator/is-simulator.uvue) 
+>
+> 该 API 不支持 Web，请运行 hello uni-app x 到 App 平台体验 
+
+::: preview
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/is-simulator/is-simulator
+```uvue
+<template>
+  
+  <scroll-view style="flex:1">
+  
+    <view>
+      <page-head :title="'isSimulator'"></page-head>
+      <view class="uni-common-mt" style="justify-content: center;align-items: center;">
+        <text>{{
+		        isSimulator ? "当前设备是模拟器" : "当前设备不是模拟器"
+		      }}</text>
+        <text>\n注：有些模拟器会故意伪装为真机，此时识别可能会不准确</text>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+
+<style>
+
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/keyboard.md

@@ -0,0 +1,194 @@
+::: sourceCode
+## uni.hideKeyboard(options?) @hidekeyboard
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+隐藏键盘
+
+### hideKeyboard 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.71 | 4.71 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 描述 |
+| :- | :- | :- | :- |
+| options | **HideKeyboardOptions** | 否 | uni.hideKeyboard参数定义 |
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| success | (res: HideKeyboardSuccess) => void | 否 | uni.hideKeyboard成功回调函数定义 |
+| fail | (res: HideKeyboardFail) => void | 否 | uni.hideKeyboard失败回调函数定义 |
+| complete | (res: any) => void | 否 | uni.hideKeyboard完成回调函数定义 |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.keyboard.hideKeyboard)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/key.html#hidekeyboard)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=hideKeyboard&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=hideKeyboard&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=hideKeyboard&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=hideKeyboard&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=hideKeyboard)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=hideKeyboard&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.onKeyboardHeightChange(callback) @onkeyboardheightchange
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+监听键盘高度变化事件
+
+在input和textarea组件上也有事件用于监听键盘高度变化。本API为全局API，可以全局监听键盘弹出收起和高度变化，尤其是App内嵌web-view中的键盘变化，无法在组件上监听，只能使用本API全局监听。
+
+### onKeyboardHeightChange 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | 4.71 | 4.71 | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| callback | (res: [OnKeyboardHeightChangeCallbackResult](#onkeyboardheightchangecallbackresult-values)) => void | 是 | Web x（部分支持，见上） | uni.onKeyboardHeightChange参数定义 | 
+
+### OnKeyboardHeightChangeCallbackResult 的属性值 @onkeyboardheightchangecallbackresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| height | number | 是 | Web x（部分支持，见上） | 键盘高度 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| number |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.keyboard.onKeyboardHeightChange)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/key.html#onkeyboardheightchange)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=onKeyboardHeightChange&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=onKeyboardHeightChange&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=onKeyboardHeightChange&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=onKeyboardHeightChange&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=onKeyboardHeightChange)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=onKeyboardHeightChange&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.offKeyboardHeightChange(id?) @offkeyboardheightchange
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-keyboard
+
+移除键盘高度变化事件的监听函数
+
+### offKeyboardHeightChange 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| <a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a> | 4.41 | 4.71 | 4.71 | 5.08 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 兼容性 |
+| :- | :- | :- |  :-: |
+| id | number | 否 | Web x（部分支持，见上） |
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.keyboard.offKeyboardHeightChange)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/key.html#offkeyboardheightchange)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=offKeyboardHeightChange&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=offKeyboardHeightChange&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=offKeyboardHeightChange&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=offKeyboardHeightChange&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=offKeyboardHeightChange)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=offKeyboardHeightChange&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/keyboard/keyboard.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/keyboard/keyboard.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/keyboard/keyboard
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/keyboard/keyboard
+
+>示例
+```vue
+<template>
+	<view class="container uni-theme-root">
+		<view class="input-section">
+			<input id="uni-input-box" class="input-box" type="text" :value="data.inputValue" placeholder="点击输入框显示键盘" :focus="data.isFocus" hold-keyboard="true" />
+			<button class="btn" @click="hideKeyboard">隐藏键盘</button>
+		</view>
+		<view class="info-section">
+			<text class="info-text">键盘高度: {{data.keyboardHeight}}px</text>
+			<text class="info-text">键盘状态: {{data.keyboardStatus}}</text>
+		</view>
+	</view>
+</template>
+
+<style>
+.container {
+	--keyboard-border-color: #ccc;
+	--keyboard-text-color: #333;
+	padding: 20px;
+}
+.input-section {
+	margin-bottom: 20px;
+}
+.input-box {
+	width: 100%;
+	height: 40px;
+	border: 1px solid var(--keyboard-border-color, #ccc);
+	border-radius: 4px;
+	padding: 0 10px;
+	margin-bottom: 10px;
+}
+.btn {
+	background-color: #007AFF;
+	color: #fff;
+}
+.info-section {
+	margin-top: 20px;
+}
+.info-text {
+	width: 100%;
+	margin-bottom: 10px;
+	font-size: 16px;
+	color: var(--keyboard-text-color, #333);
+}
+
+@media (prefers-color-scheme: dark) {
+	.container {
+		--keyboard-border-color: rgba(255, 255, 255, 0.1);
+		--keyboard-text-color: #ffffff;
+	}
+}
+</style>
+
+```
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/launch.md

@@ -0,0 +1,200 @@
+::: sourceCode
+## uni.getLaunchOptionsSync() @getlaunchoptionssync
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-getLaunchOptionsSync
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-getLaunchOptionsSync
+
+获取首次启动时的参数。返回值与App.onLaunch的回调参数一致
+
+### getLaunchOptionsSync 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| **OnLaunchOptions** |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| path | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 首次启动时的页面路径。返回值与App.onLaunch的回调参数一致<br/> |
+| appScheme | string | 否 | Web x / 微信小程序 x / Android(VDOM) 4.25 / Android(Vapor) 5.25 / iOS(VDOM) 4.25 / iOS(Vapor) 5.25 / HarmonyOS(VDOM) 4.81 / HarmonyOS(Vapor) 5.25（部分支持，见上） | 首次启动时的Scheme。返回值与App.onLaunch的回调参数一致<br/> |
+| appLink | string | 否 | Web x / 微信小程序 x / Android x / iOS(VDOM) 4.25 / iOS(Vapor) 5.25 / HarmonyOS(VDOM) 4.81 / HarmonyOS(Vapor) 5.25（部分支持，见上） | 首次启动时的appLink。返回值与App.onLaunch的回调参数一致<br/> |
+| query | UTSJSONObject | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS √ / HarmonyOS 4.81 | 启动时的 query 参数<br/> |
+| apiCategory | string | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.20.0`<br/><br/>API 类别<br/><br/>可选值：<br/>- 'default': 默认类别;<br/>- 'nativeFunctionalized': 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序;<br/>- 'browseOnly': 仅浏览，朋友圈快照页等场景打开的小程序;<br/>- 'embedded': 内嵌，通过打开半屏小程序能力打开的小程序;<br/>- 'chatTool': 聊天工具，通过打开聊天工具能力打开的小程序;<br/> |
+@@| 合法值 |
+@@| :- |
+@@| default |
+@@| nativeFunctionalized |
+@@| browseOnly |
+@@| embedded |
+@@| chatTool |
+| forwardMaterials | any | 否 | 微信小程序 4.41（部分支持，见上） | 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数<br/> |
+| hostExtraData | **OnLaunchOptionsHostExtraData** | 否 | 微信小程序 4.41（部分支持，见上） | 宿主传递的数据，第三方 app 中运行小程序时返回<br/> |
+@@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+@@| :- | :- | :- |  :-: | :- |
+@@| host_scene | string | 否 | 微信小程序 4.41（部分支持，见上） | 宿主app对应的场景值<br/> |
+| referrerInfo | **OnLaunchOptionsReferrerInfo** | 否 | 微信小程序 4.41（部分支持，见上） | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意)<br/> |
+@@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+@@| :- | :- | :- |  :-: | :- |
+@@| appId | string | 否 | 微信小程序 4.41（部分支持，见上） | 来源小程序、公众号或 App 的 appId<br/> |
+@@| extraData | IAnyObject | 否 | 微信小程序 4.41（部分支持，见上） | 来源小程序传过来的数据，scene=1037或1038时支持<br/> |
+| scene | number | 否 | 微信小程序 4.41（部分支持，见上） |  |
+| chatType | number | 否 | 微信小程序 4.41（部分支持，见上） | 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型<br/><br/>可选值：<br/>- 1: 微信联系人单聊;<br/>- 2: 企业微信联系人单聊;<br/>- 3: 普通微信群聊;<br/>- 4: 企业微信互通群聊;<br/> |
+@@| 合法值 |
+@@| :- |
+@@| 1 |
+@@| 2 |
+@@| 3 |
+@@| 4 |
+| shareTicket | string | 否 | 微信小程序 4.41（部分支持，见上） |  |
+
+- 如果应用通过scheme或applink（通用链接）启动，可以通过本API获取相应参数。配置scheme或applink需manifest.json中配置，或者在原生的AndroidManifest.xml、iOS的info.plist、鸿蒙的json5中配置，打包后生效。如开发直达页面功能，一般在应用的onShow生命周期监听。[详见](../collocation/app.md#onshow)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-launch-options-sync/get-launch-options-sync.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-launch-options-sync/get-launch-options-sync.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-launch-options-sync/get-launch-options-sync
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-launch-options-sync/get-launch-options-sync
+
+>示例
+```vue
+<template>
+  <page-head title="getLaunchOptionsSync"></page-head>
+  <view class="uni-padding-wrap">
+    <button @click="getLaunchOptionsSync">getLaunchOptionsSync</button>
+    <view class="uni-common-mt">
+      <text>应用本次启动路径：</text>
+      <text style="margin-top: 5px">{{ data.launchOptionsPath }}</text>
+    </view>
+    <view class="uni-common-mt">
+      <text>应用本次启动：</text>
+      <text style="margin-top: 5px">{{ data.launchOptionsString }}</text>
+    </view>
+  </view>
+</template>
+
+
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.launch.getLaunchOptionsSync)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/getLaunchOptionsSync.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getLaunchOptionsSync&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getLaunchOptionsSync&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getLaunchOptionsSync&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getLaunchOptionsSync&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getLaunchOptionsSync)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=getLaunchOptionsSync&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.getEnterOptionsSync() @getenteroptionssync
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-getEnterOptionsSync
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-getEnterOptionsSync
+
+获取本次启动时的参数。返回值与App.onShow的回调参数一致
+
+uni.getEnterOptionsSync 和 uni.getLaunchOptionsSync 的区别，相当于应用的 onShow 和 onLaunch 的区别，详见[应用生命周期](../collocation/app.md#applifecycle)
+
+### getEnterOptionsSync 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 4.25 | 4.25 | 4.61 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| **OnShowOptions** |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| path | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 4.25 / iOS 4.25 / HarmonyOS 4.61 | 本次启动时页面的路径<br/> |
+| appScheme | string | 否 | Web x / 微信小程序 x / Android(VDOM) 4.25 / Android(Vapor) 5.25 / iOS(VDOM) 4.25 / iOS(Vapor) 5.25 / HarmonyOS(VDOM) 4.81 / HarmonyOS(Vapor) 5.25（部分支持，见上） | 本次启动时的Scheme。返回值与App.onShow的回调参数一致<br/> |
+| appLink | string | 否 | Web x / 微信小程序 x / Android x / iOS(VDOM) 4.25 / iOS(Vapor) 5.25 / HarmonyOS(VDOM) 4.81 / HarmonyOS(Vapor) 5.25（部分支持，见上） | 本次启动时的appLink。返回值与App.onShow的回调参数一致<br/> |
+| query | UTSJSONObject | 否 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS √ / HarmonyOS 4.81 | 启动时的 query 参数<br/> |
+| apiCategory | string | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.20.0`<br/><br/>API 类别<br/><br/>可选值：<br/>- 'default': 默认类别;<br/>- 'nativeFunctionalized': 原生功能化，视频号直播商品、商品橱窗等场景打开的小程序;<br/>- 'browseOnly': 仅浏览，朋友圈快照页等场景打开的小程序;<br/>- 'embedded': 内嵌，通过打开半屏小程序能力打开的小程序;<br/>- 'chatTool': 聊天工具，通过打开聊天工具能力打开的小程序;<br/> |
+@@| 合法值 |
+@@| :- |
+@@| default |
+@@| nativeFunctionalized |
+@@| browseOnly |
+@@| embedded |
+@@| chatTool |
+| forwardMaterials | any | 否 | 微信小程序 4.41（部分支持，见上） | 打开的文件信息数组，只有从聊天素材场景打开（scene为1173）才会携带该参数<br/> |
+| hostExtraData | **OnShowOptionsHostExtraData** | 否 | 微信小程序 4.41（部分支持，见上） | 宿主传递的数据，第三方 app 中运行小程序时返回<br/> |
+@@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+@@| :- | :- | :- |  :-: | :- |
+@@| host_scene | string | 否 | 微信小程序 4.41（部分支持，见上） | 宿主app对应的场景值<br/> |
+| referrerInfo | **OnShowOptionsReferrerInfo** | 否 | 微信小程序 4.41（部分支持，见上） | 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意)<br/> |
+@@| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+@@| :- | :- | :- |  :-: | :- |
+@@| appId | string | 否 | 微信小程序 4.41（部分支持，见上） | 来源小程序、公众号或 App 的 appId<br/> |
+@@| extraData | IAnyObject | 否 | 微信小程序 4.41（部分支持，见上） | 来源小程序传过来的数据，scene=1037或1038时支持<br/> |
+| scene | number | 否 | 微信小程序 4.41（部分支持，见上） |  |
+| chatType | number | 否 | 微信小程序 4.41（部分支持，见上） | 从微信群聊/单聊打开小程序时，chatType 表示具体微信群聊/单聊类型<br/><br/>可选值：<br/>- 1: 微信联系人单聊;<br/>- 2: 企业微信联系人单聊;<br/>- 3: 普通微信群聊;<br/>- 4: 企业微信互通群聊;<br/> |
+@@| 合法值 |
+@@| :- |
+@@| 1 |
+@@| 2 |
+@@| 3 |
+@@| 4 |
+| shareTicket | string | 否 | 微信小程序 4.41（部分支持，见上） |  |
+
+- 如果应用通过scheme或applink（通用链接）启动或从后台激活到前台，可以通过本API获取相应参数。配置scheme或applink需在AndroidManifest.xml或info.plist中配置，打包后生效。如开发直达页面功能，一般在应用的onShow生命周期监听。[详见](../collocation/app.md#onshow)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-enter-options-sync/get-enter-options-sync.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-enter-options-sync/get-enter-options-sync.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-enter-options-sync/get-enter-options-sync
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-enter-options-sync/get-enter-options-sync
+
+>示例
+```vue
+<template>
+  <page-head title="getEnterOptionsSync"></page-head>
+  <view class="uni-padding-wrap">
+    <view class="uni-common-mt">
+      <text>应用本次启动路径：</text>
+      <text style="margin-top: 5px">{{ data.enterOptionsString }}</text>
+    </view>
+  </view>
+</template>
+
+
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.base.launch.getEnterOptionsSync)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/getEnterOptionsSync.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/app/life-cycle/wx.getEnterOptionsSync.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getEnterOptionsSync&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getEnterOptionsSync&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getEnterOptionsSync&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getEnterOptionsSync&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getEnterOptionsSync)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=getEnterOptionsSync&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 | 是 | 错误信息 |