tmui-cli 2.0.3 → 2.0.4

package/data/uniappx/api/get-current-pages.md

@@ -0,0 +1,215 @@
+## getCurrentPages() @getcurrentpages
+
+`getCurrentPages()` 函数用于获取当前页面栈的实例，以数组形式按栈的顺序给出，数组中的元素为页面实例，第一个元素为首页，最后一个元素为当前页面。
+
+HBuilderX 4.31+，强化了页面对象，新增了UniPage对象。getCurrentPages()返回值改为UniPage对象数组。
+
+UniPage对象强化了开发者对页面的管理功能，并且支持在uts插件中使用。
+
+`getCurrentPages()`获取的是主页面栈，不能直接获取[dialogPage](./dialog-page.md)页面。拿到主页面UniPage对象后，可以再通过getDialogPages()方法获取这个主页面的子弹窗页面栈。
+
+选项式的vue中通过`this.$page`，是另一种快速获取当前页面对象的方式。它得到的不是一个页面数组，而是一个具体的当前页面。并且这种方式支持主页面，也支持dialogPage。组合式写法[见下](#tips)
+
+### getCurrentPages 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.9 | 4.11 | 4.31 | 4.61 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| Array<UniPage> |
+
+`getCurrentPages()`返回了UniPage对象数组。
+
+每个页面是一个UniPage对象，这个对象上有较多方法，比如获取/修改pageStyle、获取高宽和安全区等。[详见](./unipage.md)
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-current-pages/get-current-pages.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-current-pages/get-current-pages.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-current-pages/get-current-pages
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-current-pages/get-current-pages
+
+>示例
+```vue
+<template>
+  
+  <scroll-view class="page-scroll-view uni-theme-root">
+  
+    <view id="container" class="current-pages-page uni-theme-root">
+      <page-head title="getCurrentPages"></page-head>
+      <view class="uni-padding-wrap">
+        <button @click="_getCurrentPages">getCurrentPages</button>
+        <view v-if="data.pages.length" style="padding: 15px 0px">
+          <text class="page-stack-text">当前页面栈中 {{ data.pages.length }} 个页面，列表如下：</text>
+          <template v-for="(page, index) in data.pages" :key="page">
+            <text class="page-stack-text" style="margin-top: 5px">index: {{ index }}, route: {{ page }}</text>
+          </template>
+        </view>
+        <button class="uni-common-mt" @click="check$page">page check $page</button>
+        
+        <button class="uni-common-mt" @click="checkGetParentPage">
+          check getParentPage
+        </button>
+        <button class="uni-common-mt" @click="checkGetDialogPages">
+          check getDialogPages
+        </button>
+        <button id="check-get-element-by-id-btn" class="uni-common-mt" @click="checkGetElementById">
+          check getElementById
+        </button>
+        <button class="uni-common-mt" @click="checkGetAndroidView">
+          check getAndroidView
+        </button>
+        <button class="uni-common-mt" @click="checkGetIOSView">
+          check getIOSView
+        </button>
+        <button class="uni-common-mt" @click="checkGetHTMLElement">
+          check getHTMLElement
+        </button>
+        <button class="uni-common-mt" @click="checkQuerySelector">
+          check querySelector
+        </button>
+        <button class="uni-common-mt" @click="checkQuerySelectorAll">
+          check querySelectorAll
+        </button>
+        
+        
+        <button class="uni-common-mt" @click="checkGetAndroidActivity">
+          check getAndroidActivity
+        </button>
+        
+        
+        <button class="uni-common-mt" @click="checkTakeSnapshot">
+          check takeSnapshot
+        </button>
+        
+      </view>
+      
+      <page-head title="currentPageStyle"></page-head>
+      <template v-for="(item, index) in data.PageStyleArray">
+        <view class="page-style-item" v-if="data.currentPageStyle[item.key] != null" :key="index">
+          <view class="item-text">
+            <text class="item-text-key">{{ item.key }}:</text>
+            <text class="item-text-value">{{
+              data.currentPageStyle[item.key]
+            }}</text>
+          </view>
+          <view class="set-value" v-if="item.type == 'boolean'">
+            <boolean-data :defaultValue="data.currentPageStyle.getBoolean(item.key)" :title="item.key"
+              @change="switchChange(item.key, $event)"></boolean-data>
+          </view>
+          <view class="set-value" v-else-if="item.type == 'number'">
+            <slider :value="data.currentPageStyle.getNumber(item.key)" :show-value="true"
+              @change="sliderChange(item.key, $event as UniSliderChangeEvent)" />
+          </view>
+          <view class="set-value" v-else-if="item.type == 'string'">
+            <radio-group class="radio-set-value" @change="radioChange(item.key, $event as RadioGroupChangeEvent)">
+              <view class="radio-value" v-for="(item2, index2) in item.value" :key="index2">
+                <radio :value="item2" />
+                <text>{{ item2 }}</text>
+              </view>
+            </radio-group>
+          </view>
+        </view>
+      </template>
+      
+      <button style="margin: 10px" @click="goSetDisablePullDownRefresh">
+        go set disable pullDownRefresh
+      </button>
+      
+      
+      <ComponentCheckPage ref="componentCheckPage" />
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+
+<style>
+  .page {
+    flex: 1;
+    padding: 10px;
+  }
+
+  .page-style {
+    margin-top: 15px;
+  }
+
+  .page-style-item {
+    padding: 10px;
+    margin-top: 10px;
+    background-color: var(--list-background-color, #ffffff);
+    border-radius: 5px;
+  }
+
+  .item-text {
+    flex-direction: row;
+  }
+
+  .item-text-key {
+    font-weight: bold;
+    color: var(--text-color, #333333);
+  }
+
+  .item-text-value {
+    margin-left: 5px;
+    color: var(--text-color, #333333);
+  }
+
+  .page-stack-text {
+    color: var(--text-color, #333333);
+  }
+
+  .set-value {
+    margin-top: 10px;
+  }
+
+  .radio-set-value {
+    flex-direction: row;
+  }
+
+  .radio-value {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    margin-left: 10px;
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.global.getCurrentPages)
+- [微信小程序文档](https://developers.weixin.qq.com/doc/search.html?source=enter&query=getCurrentPages&doc_type=miniprogram)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getCurrentPages&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getCurrentPages&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getCurrentPages&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getCurrentPages&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getCurrentPages)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=getCurrentPages&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 | 是 | 错误信息 |
+
+## 直接获取当前页面的UniPage@currentpage
+* `4.32` 新增选项式通过 `this.$page` 获取当前 `UniPage` 实例, 组合式通过`getCurrentInstance`，代码示例：
+```js
+// 选项式 API
+const curPage = this.$page
+// 组合式 API
+const currentInstance = getCurrentInstance()
+const curPage = currentInstance?.proxy?.$page
+```

package/data/uniappx/api/get-device-info.md

@@ -0,0 +1,188 @@
+::: sourceCode
+## uni.getDeviceInfo(options?) @getdeviceinfo
+
+> 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
+
+获取设备信息
+
+### getDeviceInfo 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.9 | 4.11 | 4.61 |
+
+### 参数 
+
+| 名称 | 类型 | 必填 | 默认值 | 描述 |
+| :- | :- | :- | :- | :- |
+| options | **GetDeviceInfoOptions** | 否 | 包含所有字段的过滤对象 | \[options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| filter | Array<string> | 是 | Android 3.9 / HarmonyOS x（部分支持，见上） | 过滤字段的字符串数组，假如要获取指定字段，传入此数组。 |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| **GetDeviceInfoResult** |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| deviceBrand | string | 否 | Web x / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 设备品牌<br/> |
+| deviceId | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变<br/> |
+| deviceModel | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 设备型号<br/> |
+| deviceType | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 设备类型phone、pad、pc<br/> |
+@@| 合法值 |
+@@| :- |
+@@| phone |
+@@| pad |
+@@| tv |
+@@| watch |
+@@| pc |
+@@| null |
+@@| car |
+@@| vr |
+@@| appliance |
+| deviceOrientation | string | 否 | Web 4.0 / 微信小程序 x / Android 3.9 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 设备方向 竖屏 portrait、横屏 landscape<br/> |
+| devicePixelRatio | number | 否 | Web 4.0 / 微信小程序 x / Android 3.9 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 设备像素比<br/> |
+| system | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 操作系统及版本<br/> |
+| platform | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS 4.61 | 客户端平台<br/> |
+@@| 合法值 | 兼容性 |
+@@| :- |  :-: |
+@@| ios |   |
+@@| android |   |
+@@| harmonyos |   |
+@@| mac |   |
+@@| windows |   |
+@@| linux |   |
+@@| ohos | 微信小程序 4.41（部分支持，见上） |
+@@| ohos_pc | 微信小程序 4.41（部分支持，见上） |
+@@| devtools | 微信小程序 4.41（部分支持，见上） |
+| isRoot | boolean | 否 | Web x / 微信小程序 x / Android 3.9 / iOS 4.11 / HarmonyOS x（部分支持，见上） | 是否root。iOS 为是否越狱<br/> |
+| isUSBDebugging | boolean | 否 | Web x / 微信小程序 x / Android √ / iOS x / HarmonyOS x（部分支持，见上） | adb是否开启<br/> |
+| osName | string | 否 | Web 4.18 / 微信小程序 4.41 / Android 4.18 / iOS 4.18 / HarmonyOS 4.61 | 系统名称<br/> |
+@@| 合法值 |
+@@| :- |
+@@| ios |
+@@| android |
+@@| harmonyos |
+@@| macos |
+@@| windows |
+@@| linux |
+| osVersion | string | 否 | Web 4.18 / 微信小程序 4.41 / Android 4.18 / iOS 4.18 / HarmonyOS 4.61 | 操作系统版本。如 ios 版本，android 版本<br/> |
+| osLanguage | string | 否 | Web x / 微信小程序 x / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | 操作系统语言<br/> |
+| osTheme | string | 否 | Web x / 微信小程序 x / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | 操作系统主题<br/> |
+@@| 合法值 |
+@@| :- |
+@@| light |
+@@| dark |
+| osAndroidAPILevel | number | 否 | Web x / 微信小程序 x / Android 4.18 / iOS x / HarmonyOS x（部分支持，见上） | Android 系统API库的版本。<br/> |
+| osHarmonySDKAPIVersion | number | 否 | Web x / 微信小程序 x / Android √ / iOS x / HarmonyOS 4.61（部分支持，见上） | 鸿蒙系统软件API版本<br/> |
+| osHarmonyDisplayVersion | string | 否 | Web x / 微信小程序 x / Android √ / iOS x / HarmonyOS 4.61（部分支持，见上） | 产品版本，关于本机信息内的软件版本<br/> |
+| romName | string | 否 | Web x / 微信小程序 x / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`<br/> |
+| romVersion | string | 否 | Web x / 微信小程序 x / Android 4.18 / iOS 4.18 / HarmonyOS 4.61（部分支持，见上） | rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号（同 `osVersion`）。<br/> |
+| abi | string | 否 | 微信小程序 4.41（部分支持，见上） | 应用（微信APP）二进制接口类型（仅 Android 支持）<br/> |
+| benchmarkLevel | number | 否 | 微信小程序 4.41（部分支持，见上） |  |
+| cpuType | string | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.29.0`<br/><br/>设备 CPU 型号（仅 Android 支持）（Tips: GPU 型号可通过 WebGLRenderingContext.getExtension('WEBGL_debug_renderer_info') 来获取）<br/> |
+| deviceAbi | string | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.25.1`<br/><br/>设备二进制接口类型（仅 Android 支持）<br/> |
+| memorySize | string | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.30.0`<br/><br/>设备内存大小，单位为 MB<br/> |
+| ~~brand~~ | string | 否 | Web x / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS x（部分支持，见上） | 设备品牌  **已废弃，仅为了向下兼容保留** |
+| ~~model~~ | string | 否 | Web 4.0 / 微信小程序 4.41 / Android 3.9 / iOS 4.11 / HarmonyOS x（部分支持，见上） | 设备型号  **已废弃，仅为了向下兼容保留** |
+| ~~isSimulator~~ | boolean | 否 | Web x / 微信小程序 x / Android 3.9 / iOS 4.11 / HarmonyOS x（部分支持，见上） | 是否是模拟器<br/>  **已废弃，由于合规问题在4.51版本后不会采集传感器信息，会影响准确度，建议使用`isSimulator()`代替。** |
+
+::: warning 注意事项
+- 获取OAID、AndroidID等其他设备信息，[见插件市场](https://ext.dcloud.net.cn/search?q=oaid&orderBy=Relevance&uni-appx=1)
+- romName值域候选 [详见](./get-system-info.md#romname)
+- app平台devicePixelRatio属性，HBuilderX4.22及以下版本类型为string，HBuilderX4.23版本调整为number
+- 在4.51以前，调用本api会获取传感器列表，原因是isSimulator属性判断模拟器时，需要根据传感器信息才能做出更准确的判断。但是，应用商店不允许在同意隐私协议前调用传感器。解决方案有2个：1、在同意隐私协议之后再调用，且隐私协议里声明调用传感器的用途；2、按需加载需要的信息，例如下面的代码，只获取品牌，不获取isSimulator：
+  ```
+  uni.getDeviceInfo({filter:["brand"]})
+  ```
+  从4.51+，本api的isSimulator调整为不再获取传感器信息，但判断模拟器的准确度会下降。如需更准确的判断模拟器，需要单独使用uni.isSimulator。注意也需要在同意隐私协议之后获取。
+- 自 5.11 起：
+  - web 平台在 macOS 上 platform 正确的返回 `mac` 值
+  - web 平台在 macOS 上获取到的 osVersion 固定为 `10.15.7`，这和系统版本不一致，这不是 bug，是浏览器 ua 的限制（从 macOS 11 开始，Apple 和 Google、Mozilla 等浏览器厂商达成共识，减少通过 UA 暴露精确的系统版本）
+  - web 平台运行在鸿蒙 PC 上时 osName 仅返回 `harmonyos`（不会返回 `ohos_pc`），可通过 deviceType 为 `pc` 区分
+  - 小程序平台统一标准：鸿蒙系统 osName、platform 为 `harmonyos`，手机、Tablet 和 PC 通过 deviceType 区分
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-device-info/get-device-info.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-device-info/get-device-info.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-device-info/get-device-info
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-device-info/get-device-info
+
+>示例
+```vue
+<template>
+  
+  <scroll-view class="page-scroll-view uni-theme-root">
+  
+    <view class="uni-theme-root">
+      <page-head :title="title"></page-head>
+      <view class="uni-common-mt">
+        <view class="uni-list">
+          <view class="uni-list">
+            <view class="uni-list-cell" v-for="(item, _) in data.items" style="align-items: center">
+              <view class="uni-pd">
+                <view class="uni-label" style="width: 180px">
+                  <text class="system-info-text">
+                    {{ item.label }}
+                  </text>
+                </view>
+              </view>
+              <view class="uni-list-cell-db">
+                <text class="uni-list-cell-db-text system-info-text">{{
+                  item.value == "" ? "未获取" : item.value
+                }}</text>
+              </view>
+            </view>
+          </view>
+        </view>
+        <view class="uni-padding-wrap">
+          <view class="uni-btn-v">
+            <button type="primary" @tap="getDeviceInfo">获取设备信息</button>
+          </view>
+        </view>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+<style>
+  .uni-pd {
+    padding-left: 15px;
+  }
+
+  .system-info-text {
+    color: var(--text-color, #333333);
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.device.getDeviceInfo)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getDeviceInfo.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=getDeviceInfo&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=getDeviceInfo&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=getDeviceInfo&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=getDeviceInfo&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=getDeviceInfo)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=getDeviceInfo&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/get-element-by-id.md

@@ -0,0 +1,103 @@
+::: sourceCode
+## uni.getElementById(id) @getelementbyid
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-getElementById
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-getElementById
+
+返回一个匹配特定 ID 的元素， 如果不存在，返回 null。\
+如果需要获取指定的节点类型，需要使用 as 进行类型转换。\
+ID 区分大小写，且应该是唯一的。如果存在多个匹配的元素，则返回第一个匹配的元素。
+
+### getElementById 兼容性  
+| Web | 微信小程序 | Android | iOS | iOS(VDOM) UTS 插件 | HarmonyOS |
+| :- | :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.25 | 4.61 |
+
+**注意：** \
+uni是全局api，本方法获取的元素，是页面栈栈顶（不包括 dialogPage）的页面的元素，而不是执行本方法代码所在的页面的元素。\
+如果A页面被栈顶的B页面盖住，在A页面执行`uni.getElementById`会访问到B页面的元素。[详见](./README.md#toppage)
+
+如需寻找特定页面上的Element，应使用[UniPage对象的getElementById方法](../api/get-current-pages.md#getelementbyid)
+
+组合式 API 中可通过`getCurrentInstance()?.proxy?.$page`获取当前页面对象，这个方式可以获取到dialogPage页面。那么通用的、在当前页面获取UniElement的方式是：`getCurrentInstance()?.proxy?.$page.getElementById`
+
+另一种与页面绑定的获取元素的方式是定义与模板 ref 属性同名的 `ref` 变量。[详见](../tutorial/idref.md#ref方式)
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| id | string.IDString \| string | 是 |
+
+`3.93+` 支持泛型，可通过 `uni.getElementById<ElementType>(id)` 获取指定类型的元素。对于组件有自带方法的情况，通过泛型指定具体的元素类型，就可以调用该类型组件的专用方法，比如unicloud-db组件。\
+具体的组件元素类型，可查阅`组件文档/组件类型`获取。
+
+```html
+<template>
+	<view>
+		<text id='text' ref='textRef'>test text</text>
+	</view>
+</template>
+
+```
+
+### 返回值 
+
+| 类型 | 必备 |
+| :- | :- |
+| UniElement | 否 |
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/get-element-by-id/get-element-by-id.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/get-element-by-id/get-element-by-id.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/get-element-by-id/get-element-by-id
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/get-element-by-id/get-element-by-id
+
+>示例
+```vue
+<template>
+  <page-head id="page-head" title="getElementById"></page-head>
+  <view style="margin: 0 15px;">
+    <text id="text">this is text</text>
+    <view id="view" class="uni-common-mt" style="border: 1px solid red">this is view</view>
+    <image id="image" class="uni-common-mt" src="/static/test-image/logo.png" style="width: 50px; height: 50px;"></image>
+    <scroll-view id="scroll-view" class="uni-common-mt" style="width: 100px; height: 50px; background-color: #f0f0f0; border: 1px solid #ccc;">
+      <text>this is scroll-view</text>
+    </scroll-view>
+    <button class="uni-btn" @click="changePageHeadBackgroundColor">
+      修改 page-head 背景色
+    </button>
+    <button class="uni-btn" @click="changeTextColor">
+      修改 text 字体颜色
+    </button>
+    <button class="uni-btn" @click="changeViewStyle">
+      修改 view 宽高及背景色
+    </button>
+    <button class="uni-btn" @click="changeImageStyle">
+      修改 image 宽高及边框
+    </button>
+    <button class="uni-btn" @click="changeScrollViewStyle">
+      修改 scroll-view 宽高及背景色
+    </button>
+    <button class="uni-btn" @click="goMultipleRootNode">
+      跳转多根节点示例
+    </button>
+  </view>
+</template>
+
+
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.dom.getElementById)
+
+## 通用类型
+
+### GeneralCallbackResult @generalcallbackresult-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errMsg | string | 是 | 错误信息 |

package/data/uniappx/api/get-element.md

@@ -0,0 +1,3 @@
+layout: SimpleLayout
+
+文档已迁移，请前往[getElementById](get-element-by-id.md)查看最新文档