tmui-cli 2.0.2 → 2.0.4

package/data/uniappx/api/unipage.md

@@ -0,0 +1,263 @@
+## UniPage
+
+uni-app x中，每个页面都对应一个UniPage对象。
+
+如果是dialogPage，也可以通过UniPage的getDialogPage方法获取。
+
+通过UniPage对象，可以获取/修改页面的pageStyle，让pages.json中的页面设置可以动态修改；可以继续获取原生页面对象，如原生view；可以继续获取页面的vue实例，通过vm属性。
+
+UniPage在App和Web平台较完善，在小程序端受小程序未开放，很多功能无法实现。具体见兼容性表格。
+
+### UniPage 的属性值 @unipage-values
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| route | string | 是 | Web 4.31 / 微信小程序 x / Android 4.31 / iOS 4.31 / HarmonyOS 4.61（部分支持，见上） | 页面的路由地址 |
+| options | UTSJSONObject | 是 | Web 4.31 / 微信小程序 x / Android 4.31 / iOS 4.31 / HarmonyOS x（部分支持，见上） | 页面的路由参数信息 |
+| vm | **VueComponent** | 否 | Web 4.31 / 微信小程序 x / Android 4.31 / iOS 4.31 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） | UniPage vue 实例对象 |
+| 名称 | 类型 | 必备 | 兼容性 |
+| :- | :- | :- |  :-: |
+| $data | Map\<string, any> | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $props | Map\<string, any> | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $attrs | Map\<string, any> | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $slots | Map\<string, any> | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $refs | Map\<string, any> | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $parent | VueComponent | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $root | VueComponent | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $options | VueComponentOptions | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $el | UniElement | 是 | Web 4.0 / 微信小程序 4.41 / Android √ / iOS 4.11 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| $page | UniPage | 是 | Web 4.31 / 微信小程序 √ / Android 4.31 / iOS 4.31 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） |
+| pageBody | **UniPageBody** | 是 | Web 4.51 / 微信小程序 x / Android 4.51 / iOS 4.51 / HarmonyOS 4.61（部分支持，见上） | UniPage 页面可使用区域信息，单位为px |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| left | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域左上角横坐标 |
+| right | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域右下角横坐标 |
+| top | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域左上角纵坐标 |
+| bottom | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域右下角纵坐标 |
+| width | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域宽度 |
+| height | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 页面内容区域高度 |
+| safeAreaInsets | **UniSafeAreaInsets** | 是 | Web 4.51 / 微信小程序 x / Android 4.51 / iOS 4.51 / HarmonyOS 4.61（部分支持，见上） | UniPage 安全区域插入位置（与屏幕边界的距离）信息 |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| left | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 安全区域左侧插入位置（距离左边边界距离） |
+| right | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 安全区域右侧插入位置（距离右边边界距离） |
+| top | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 安全区顶部插入位置（距离顶部边界距离） |
+| bottom | number | 是 | Android 4.51 / iOS 4.51（部分支持，见上） | 安全区域底部插入位置（距离底部边界距离） |
+| fullscreenElement | UniElement | 否 | Web x / 微信小程序 x / Android 4.61 / iOS 4.61 / HarmonyOS 4.61（部分支持，见上） | 已经进入全屏状态的元素 |
+| width | number | 是 | Web 4.63 / 微信小程序 4.63 / Android 4.61 / iOS 4.61 / HarmonyOS 4.63 | 页面窗口宽度 |
+| height | number | 是 | Web 4.63 / 微信小程序 4.63 / Android 4.61 / iOS 4.61 / HarmonyOS 4.63 | 页面窗口高度 |
+| statusBarHeight | number | 是 | Web 4.63 / 微信小程序 4.63 / Android 4.61 / iOS 4.61 / HarmonyOS 4.63 | 页面状态栏高度 |
+| ~~$vm~~ | [VueComponent](#vuecomponent-values) | 否 | Web 4.31 / 微信小程序 x / Android 4.31 / iOS 4.31 / iOS(VDOM) UTS 插件 x / HarmonyOS 4.61（部分支持，见上） | UniPage vue 实例对象 |
+
+### UniPage 的方法 @unipage-methods
+
+pages.json里的页面配置，即page下的style节点的内容，可以通过本API获取。但注意这里获取的是UniPage上的最终生效值，不是pages.json里的原始配置。
+
+pages.json里的内容是静态的，通过本API可以动态设置UniPage的Style，但并非所有页面样式都支持动态配置，具体见下PageStyle。
+
+::: warning 注意
+- HBuilderX 4.31+，$getPageStyle和$setPageStyle不再需要加前缀$。
+- 使用`选项式 API` 时，不可创建 `route`、`options` 同名响应式变量，否则会覆盖当前 `page 实例` 的同名属性。
+- 4.31 前仅 `Web` 与 `iOS(非 uts 插件)` 端支持通过 `page.$vm` 获取 vue 实例。\
+	4.31+ 仅 `iOS uts 插件` 环境不支持通过 `page.vm` 获取 vue 实例。
+
+**PageStyle**
+
+支持当前页面 `style` 节点属性（注意并非所有 pages.json 的 pageStyle 都可以动态修改）
+
+|属性                          |类型    |Android|Android(Vapor)|iOS   |iOS(Vapor)|HarmonyOS|HarmonyOS(Vapor)|web  |默认值  |
+|:-:                           |:-:    |:-:    |:-:           |:-:   |:-:       |:-:      |:-:             |:-:  |:-:    |
+|enablePullDownRefresh         |Boolean|4.13   |x             |4.13  |x         |4.61     |5.0             |4.13  |false  |
+|backgroundColorContent        |String  |4.15  |x             |4.15  |x         |4.61     |5.0             |4.18  |#ffffff|
+|navigationBarBackgroundColor  |String  |4.18  |x             |4.18  |x         |4.61     |5.0             |4.18  |#007AFF|
+|navigationBarTextStyle        |String  |4.18  |x             |4.18  |x         |4.61     |5.0             |4.18  |white  |
+|navigationBarTitleText        |String  |4.18  |x             |4.18  |x         |4.61     |5.0             |4.18  |""     |
+|navigationStyle               |String  |x     |x             |x     |x         |4.61     |5.0             |4.18  |default|
+|backgroundColor               |String  |4.18  |5.25          |4.18  |5.25      |4.61     |5.0             |x     |#ffffff|
+|backgroundTextStyle           |String  |4.31  |x             |4.31  |x         |x        |x               |x     |dark   |
+|onReachBottomDistance         |Number  |x     |5.21          |x     |5.21      |4.61     |5.08            |4.18  |50     |
+|pageOrientation               |String  |4.18  |x             |4.25  |x         |x        |5.0             |x     |auto   |
+|disableSwipeBack              |Boolean|x      |x             |4.18  |x         |x        |x               |x     |false  |
+|hideStatusBar                 |Boolean|4.31   |x             |x     |x         |x        |5.0             |x     |false  |
+|hideBottomNavigationIndicator |Boolean|4.31   |x             |x     |x         |x        |x               |x     |false  |
+|enableBackToTop               |Boolean|x      |x             |x     |5.25      |x        |5.25            |x     |false  |
+|bounces                       |Boolean|x      |5.25          |x     |5.25      |x        |5.25            |x     |false  |
+|androidOverscroll             |Boolean|x      |5.25          |x     |x         |x        |x               |x     |false  |
+|androidRefresherColor         |String |x      |5.25          |x     |x         |x        |x               |x     |""     |
+|backgroundColor               |String |x      |5.25          |x     |5.25      |x        |5.0             |x     |transparent|
+
+**注意事项**
+- web端由于会自动摇树优化未使用的特性，如果整个项目中都没有使用到下拉刷新`enablePullDownRefresh`，那么下拉刷新功能会被摇掉，此时设置打开下拉刷新将无效。
+- app-android平台的页面是activity，不支持`backgroundColorContent`设为透明。
+- 4.15版本前，app-ios平台在page.json 中设置页面 `enablePullDownRefresh` 为 `false` 时，无法通过 `$setPageStyle` 方法动态开启页面下拉刷新。新版已修复该问题。
+
+用于逆转先前调用 UniElement.requestFullscreen 的效果。
+
+该截图 API 只针对页面内容进行截图，不包含状态栏、软键盘等系统 UI 元素，也不包含pages.json中定义的导航栏、tabBar。\
+截图行为会根据页面内容大小、根节点类型和平台不同而有所差异，具体如下表所示：
+
+| 页面内容 | 根节点类型 | app-android | app-ios | app-harmonyOS | app-harmonyOS(Vapor) |
+|---------|-----------|-------------|---------|---------------|---------------------|
+| 超过一屏 | scroll-view 滚动容器 | 长图（完整内容） | 长图（完整内容） | 长图（完整内容） | 长图（完整内容） |
+| 超过一屏 | 非 scroll-view 容器 | 长图（完整内容）  |屏幕高度<sup>②</sup> | 长图（完整内容） | 长图（完整内容） |
+| 不超过一屏 | scroll-view 滚动容器 | 内容高度<sup>①</sup> | 内容高度<sup>①</sup> | 内容高度<sup>①</sup> | 内容高度<sup>①</sup> |
+| 不超过一屏 | 非 scroll-view 容器 | 屏幕高度<sup>②</sup> | 屏幕高度<sup>②</sup> | 屏幕高度<sup>②</sup> | 屏幕高度<sup>②</sup> |
+
+> ① 截图高度等于内容实际高度（内容多高截图就多高）  
+> ② 截图高度固定为屏幕高度（不管内容多少都是一屏高）
+
+### 示例
+
+示例为[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>
+
+```

package/data/uniappx/api/upload-file.md

@@ -0,0 +1,233 @@
+::: sourceCode
+## uni.uploadFile(options) @uploadfile
+
+> GitCode: https://gitcode.com/dcloud/uni-api/tree/alpha/uni_modules/uni-network
+
+> GitHub: https://github.com/dcloudio/uni-api/tree/alpha/uni_modules/uni-network
+
+将本地资源上传到开发者服务器。
+
+### uploadFile 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+推荐上传到uniCloud，uniCloud提供了更便宜CDN和更好的易用性，[详见](https://doc.dcloud.net.cn/uniCloud/ext-storage/intro.html)
+
+### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| options | **UploadFileOptions** | 是 |
+| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+| :- | :- | :- | :- |  :-: | :- |
+| url | string | 是 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器 url |
+| filePath | string | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 要上传文件资源的路径, 支持uni.env |
+| name | string | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |
+| files | Array<**UploadFileOptionFiles**> | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 需要上传的文件列表。 |
+@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
+@@| :- | :- | :- | :- |  :-: | :- |
+@@| name | string | 否 | "file" | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。 |
+@@| uri | string | 是 |  | Web x / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61（部分支持，见上） | 要上传文件资源的路径 |
+@@| file | any | 否 |  | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS x（部分支持，见上） | 要上传的文件对象 |
+| header | UTSJSONObject | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | HTTP 请求 Header, header 中不能设置 Referer |
+| formData | UTSJSONObject | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | HTTP 请求中其他额外的 form data |
+| timeout | number | 否 | 120000 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 超时时间，单位 ms |
+| success | (result: [UploadFileSuccess](#uploadfilesuccess-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 成功返回的回调函数 |
+| fail | (result: [UploadFileFail](#uploadfilefail-values)) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 失败的回调函数 |
+| complete | (result: any) => void | 否 | null | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 结束的回调函数（调用成功、失败都会执行） |
+| enableHttp2 | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>是否开启 http2<br/> |
+| enableProfile | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.5.0`<br/><br/>是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。<br/> |
+| enableQuic | boolean | 否 |  | 微信小程序 4.41（部分支持，见上） | 需要基础库： `2.10.4`<br/><br/>是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议）<br/> | 
+
+#### UploadFileSuccess 的属性值 @uploadfilesuccess-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| data | string | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的数据 |
+| statusCode | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 开发者服务器返回的 HTTP 状态码 |
+| profile | **UploadFileSuccessProfile** | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.5.0`<br/><br/>网络请求过程中一些调试信息，[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html)。目前 iOS 和 Android 端支持。<br/> |
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| SSLconnectionEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | SSL建立完成的时间,如果不是安全连接,则值为 0<br/> |
+| SSLconnectionStart | number | 否 | 微信小程序 4.41（部分支持，见上） | SSL建立连接的时间,如果不是安全连接,则值为 0<br/> |
+| connectEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP（TCP） 完成建立连接的时间（完成握手），如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接完成的时间。注意这里握手结束，包括安全连接建立完成、SOCKS 授权通过<br/> |
+| connectStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP（TCP） 开始建立连接的时间，如果是持久连接，则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接，则这里显示的是新建立的连接开始的时间<br/> |
+| domainLookUpEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | Local DNS 域名查询完成的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等<br/> |
+| domainLookUpStart | number | 否 | 微信小程序 4.41（部分支持，见上） | Local DNS 域名查询开始的时间，如果使用了本地缓存（即无 DNS 查询）或持久连接，则与 fetchStart 值相等<br/> |
+| downstreamThroughputKbpsEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 评估当前网络下载的kbps<br/> |
+| estimate_nettype | number | 否 | 微信小程序 4.41（部分支持，见上） | 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6<br/> |
+| fetchStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 组件准备好使用 HTTP 请求抓取资源的时间，这发生在检查本地缓存之前<br/> |
+| httpDNSDomainLookUpEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.9`<br/><br/>httpDNS 完成查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持<br/> |
+| httpDNSDomainLookUpStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.9`<br/><br/>httpDNS 开始查询的时间。仅当开启 httpDNS 功能时返回该字段。目前仅wx.request接口支持<br/> |
+| httpRttEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 协议层根据多个请求评估当前网络的 rtt（仅供参考）<br/> |
+| invokeStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>调用接口的时间。<br/> |
+| peerIP | string | 否 | 微信小程序 4.41（部分支持，见上） | 当前请求的IP<br/> |
+| port | number | 否 | 微信小程序 4.41（部分支持，见上） | 当前请求的端口<br/> |
+| protocol | string | 否 | 微信小程序 4.41（部分支持，见上） | 使用协议类型，有效值：http1.1, h2, quic, unknown<br/> |
+| queueEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>结束排队的时间。达到并行上限时才需要排队。如果未发生排队，则该字段和 queueStart 字段值相同<br/> |
+| queueStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 需要基础库： `3.8.10`<br/><br/>开始排队的时间。达到并行上限时才需要排队。<br/> |
+| receivedBytedCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 收到字节数<br/> |
+| redirectEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算，否则值为 0<br/> |
+| redirectStart | number | 否 | 微信小程序 4.41（部分支持，见上） | 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算，否则值为 0<br/> |
+| requestEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP请求读取真实文档结束的时间<br/> |
+| requestStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP请求读取真实文档开始的时间（完成建立连接），包括从本地读取缓存。连接错误重连时，这里显示的也是新建立连接的时间<br/> |
+| responseEnd | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP 响应全部接收完成的时间（获取到最后一个字节），包括从本地读取缓存<br/> |
+| responseStart | number | 否 | 微信小程序 4.41（部分支持，见上） | HTTP 开始接收响应的时间（获取到第一个字节），包括从本地读取缓存<br/> |
+| rtt | number | 否 | 微信小程序 4.41（部分支持，见上） | 当次请求连接过程中实时 rtt<br/> |
+| sendBytesCount | number | 否 | 微信小程序 4.41（部分支持，见上） | 发送的字节数<br/> |
+| socketReused | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 是否复用连接<br/> |
+| throughputKbps | number | 否 | 微信小程序 4.41（部分支持，见上） | 当前网络的实际下载kbps<br/> |
+| transportRttEstimate | number | 否 | 微信小程序 4.41（部分支持，见上） | 传输层根据多个请求评估的当前网络的 rtt（仅供参考）<br/> |
+| usingHighPerformanceMode | boolean | 否 | 微信小程序 4.41（部分支持，见上） | 是否走到了高性能模式。基础库 v3.3.4 起支持。<br/> |
+
+#### UploadFileFail 的属性值 @uploadfilefail-values 
+
+| 名称 | 类型 | 必备 | 描述 |
+| :- | :- | :- | :- |
+| errCode | number | 是 | 错误码 |
+| 合法值 | 描述 |
+| :- | :- |
+| 5 | 接口超时 |
+| 1000 | 服务端系统错误 |
+| 100001 | json数据解析错误 |
+| 100002 | 错误信息json解析失败 |
+| 100003 | json解析类型转换失败 |
+| 600003 | 网络中断 |
+| 600008 | data参数类型不合法 |
+| 600009 | URL格式不合法 |
+| 600010 | Cronet模块加载失败 |
+| 602001 | request系统错误 |
+| errSubject | string | 是 | 统一错误主题（模块）名称 |
+| data | any | 否 | 错误信息中包含的数据 |
+| cause | Error | 否 | 源错误信息，可以包含多个错误，详见SourceError |
+| errMsg | string | 是 |  |
+
+### 返回值 
+
+| 类型 |
+| :- |
+| [UploadTask](#uploadtask-values) |
+
+#### UploadTask 的方法 @uploadtask-values 
+
+#### abort(): void, @abort
+abort
+中断上传任务。
+##### abort 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+#### onProgressUpdate(callback: UploadFileProgressUpdateCallback): void, @onprogressupdate
+onProgressUpdate
+监听上传进度变化。
+##### onProgressUpdate 兼容性  
+| Web | 微信小程序 | Android | iOS | HarmonyOS |
+| :- | :- | :- | :- | :- |
+| 4.0 | 4.41 | 3.91 | 4.11 | 4.61 |
+
+##### 参数 
+
+| 名称 | 类型 | 必填 |
+| :- | :- | :- |
+| callback | (result: [OnProgressUpdateResult](#onprogressupdateresult-values)) => void | 是 | 
+
+##### OnProgressUpdateResult 的属性值 @onprogressupdateresult-values 
+
+| 名称 | 类型 | 必备 | 兼容性 | 描述 |
+| :- | :- | :- |  :-: | :- |
+| progress | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 上传进度百分比 |
+| totalBytesSent | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 已经上传的数据长度，单位 Bytes |
+| totalBytesExpectedToSend | number | 是 | Web 4.0 / 微信小程序 4.41 / Android 3.91 / iOS 4.11 / HarmonyOS 4.61 | 预期需要上传的数据总长度，单位 Bytes |
+
+::: danger 注意事项
+- 在4.25版本iOS平台增加了Task原生对象自动销毁的逻辑，即上传完成后自动释放原生的Task对象，建议开发者在`complete`回调中置空Task对象，例
+
+```typescript
+complete: () => {
+            this.task = null
+          },
+```
+
+如不释放，在调用Task对象的方法将导致控制台报错：
+`error: instance object does not exist: id:15`
+
+### 示例
+
+示例为[hello uni-app x alpha分支](https://gitcode.com/dcloud/hello-uni-app-x/blob/prod_alpha/pages/API/upload-file/upload-file.uvue)，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例[另见](https://gitcode.com/dcloud/hello-uni-app-x/blob/master//pages/API/upload-file/upload-file.uvue) 
+::: preview https://hellouniappx.dcloud.net.cn/web/#/pages/API/upload-file/upload-file
+
+> appRedirect https://hellouniappx.dcloud.net.cn/appredirect.html?path=pages/API/upload-file/upload-file
+
+>示例
+```vue
+<template>
+  
+  <scroll-view class="page-scroll-view uni-theme-root">
+  
+    <view class="upload-page uni-theme-root">
+      <page-head :title="data.title"></page-head>
+      <view class="uni-padding-wrap uni-common-mt">
+        <view class="demo">
+          <image v-if="data.imageSrc" :src="data.imageSrc" class="image" mode="widthFix"></image>
+          <text v-else class="uni-hello-addfile" @click="chooseImage">+ 选择图片</text>
+        </view>
+      </view>
+    </view>
+  
+  </scroll-view>
+  
+</template>
+
+
+<style>
+  .image {
+    width: 100%;
+  }
+
+  .demo {
+    background-color: var(--list-background-color, #ffffff);
+    padding: 25px;
+    justify-content: center;
+    align-items: center;
+  }
+
+  .uni-hello-addfile {
+    text-align: center;
+    background-color: var(--list-background-color, #ffffff);
+    padding: 25px;
+    margin-top: 10px;
+    font-size: 19px;
+    color: var(--active-color, #808080);
+  }
+</style>
+
+```
+
+### 参见
+- [相关 Bug](https://issues.dcloud.net.cn/?mid=api.network.uploadFile)
+- [参见uni-app相关文档](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)
+- [微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/upload/UploadTask.html)
+- [支付宝小程序文档](https://open.alipay.com/portal/zhichi/search?keyword=uploadFile&pageIndex=1&pageSize=10&source=doc_top&type=all)
+- [百度小程序文档](https://smartprogram.baidu.com/forum/search?query=uploadFile&scope=devdocs&source=docs)
+- [抖音小程序文档](https://developer.open-douyin.com/search-page?keyword=uploadFile&secondType=all&type=1)
+- [飞书小程序文档](https://open.feishu.cn/search?from=header&page=1&pageSize=10&q=uploadFile&topicFilter=)
+- [钉钉小程序文档](https://open.dingtalk.com/search?keyword=uploadFile)
+- [QQ小程序文档](https://q.qq.com/wiki/develop/miniprogram/frame/)
+- [快手小程序文档](https://developers.kuaishou.com/page?keyword=uploadFile&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 | 是 | 错误信息 |
+
+**注意**
+
+- web端上传文件时仅能使用downloadFile、chooseImage等返回文件对象的接口的返回值作为要上传的文件