Appearance
xtf-upload
组件说明
xtf-upload 是上传，用于选择、预览并管理图片或视频上传队列。当前实现读取 value 数据、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-upload/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfUpload :value="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfUpload from "@/uni_modules/xtf-linkuiunix/components/xtf-upload/xtf-upload.uvue"
const fixture = [{ id: 'receipt-1', url: '/static/logo.png', name: '凭证.png', type: 'image', size: 1024, status: 'success', progress: 100, errorText: '' }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfUpload :value="fixture" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfUpload from "@/uni_modules/xtf-linkuiunix/components/xtf-upload/xtf-upload.uvue"
const fixture = [{ id: 'receipt-1', url: '/static/logo.png', name: '凭证.png', type: 'image', size: 1024, status: 'success', progress: 100, errorText: '' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-upload:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 multiple 状态
运行时切换 multiple，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfUpload :value="fixture" :multiple="state" />
<button class="doc-action-button" @click="toggleState">切换 multiple</button>
<text class="doc-state-text">multiple: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfUpload from "@/uni_modules/xtf-linkuiunix/components/xtf-upload/xtf-upload.uvue"
import { ref } from "vue"
const fixture = [{ id: 'receipt-1', url: '/static/logo.png', name: '凭证.png', type: 'image', size: 1024, status: 'success', progress: 100, errorText: '' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("multiple", state.value) }
</script>
<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>4. 调用 chooseFiles()
打开文件选择；签名为 chooseFiles(): void。
vue
<template>
<view class="doc-method">
<XtfUpload :value="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开文件选择</button>
</view>
</template>
<script setup lang="uts">
import XtfUpload from "@/uni_modules/xtf-linkuiunix/components/xtf-upload/xtf-upload.uvue"
import { ref } from "vue"
const fixture = [{ id: 'receipt-1', url: '/static/logo.png', name: '凭证.png', type: 'image', size: 1024, status: 'success', progress: 100, errorText: '' }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.chooseFiles(); console.log("调用 chooseFiles") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | any | null | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 8、script 行 148 | 需要覆盖组件默认业务值时设置。 |
value | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 8、script 行 148 | 需要覆盖组件默认业务值时设置。 |
max | number | 9 | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 13、script 行 23、script 行 24、script 行 26 | 需要覆盖组件默认业务值时设置。 |
multiple | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 47 | 需要控制显示、可用性或交互状态时设置。 |
deletable | boolean | true | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 122、template 行 2 | 需要覆盖组件默认业务值时设置。 |
fileType | string | "image" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 16、script 行 49、template 行 2 | 需要覆盖组件默认业务值时设置。 |
maxSize | number | 0 | 设置对应元素尺寸；消费位置：script 行 29 | 需要调整布局或视觉表现时设置。 |
sourceType | Array<string> | () => [] as Array<string> | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 50、script 行 57 | 需要覆盖组件默认业务值时设置。 |
readonly | boolean | false | 参与组件运行逻辑；源码在 12 处读取该值；消费位置：script 行 13、script 行 21、script 行 31、script 行 33 | 需要控制显示、可用性或交互状态时设置。 |
preview | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 123 | 需要覆盖组件默认业务值时设置。 |
autoUpload | boolean | true | 开关对应显示或交互行为；消费位置：script 行 38、script 行 39 | 需要覆盖组件默认业务值时设置。 |
mockUpload | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 110 | 需要覆盖组件默认业务值时设置。 |
action | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 15、script 行 94、script 行 99 | 需要覆盖组件默认业务值时设置。 |
name | string | "file" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 94、script 行 99 | 需要覆盖组件默认业务值时设置。 |
headers | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 94、script 行 99 | 需要覆盖组件默认业务值时设置。 |
formData | UTSJSONObject | () => ({} as UTSJSONObject) | 提供组件渲染或选择使用的数据集合；消费位置：script 行 94、script 行 99 | 数据驱动或选项渲染场景。 |
method | string | "POST" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 99 | 需要覆盖组件默认业务值时设置。 |
withCredentials | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 99 | 需要覆盖组件默认业务值时设置。 |
concurrent | number | 2 | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 14、script 行 149 | 需要覆盖组件默认业务值时设置。 |
cancelable | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要覆盖组件默认业务值时设置。 |
customRequest | any | null | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 15、script 行 93、script 行 94 | 需要覆盖组件默认业务值时设置。 |
beforeRead | any | null | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 30 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
beforeUpload | any | null | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 32 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | changed 内触发（script 行 18）；参数表达式：result；前置 guard：disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | changed 内触发（script 行 18）；参数表达式：result；前置 guard：disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | changed 内触发（script 行 18）；参数表达式：result；前置 guard：disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | changed 内触发（script 行 18）；参数表达式：result；前置 guard：disposed | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
choose | setup 内触发（script 行 53）；参数表达式：result；前置 guard：!active()setup 内触发（script 行 61）；参数表达式：result；前置 guard：!active() | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
before-add | add 内触发（script 行 29）；参数表达式：{ file, accepted: false, reason: "oversize" }；前置 guard：disposed || props.readonly、available <= 0add 内触发（script 行 34）；参数表达式：{ file, accepted: false, reason: "rejected" }；前置 guard：available <= 0、disposed || props.readonly || version != addVersion、disposed || props.readonly || version != addVersionadd 内触发（script 行 37）；参数表达式：{ file, accepted: true }；前置 guard：available <= 0、disposed || props.readonly || version != addVersion、disposed || props.readonly || version != addVersion | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
exceed | add 内触发（script 行 24）；参数表达式：{ max: props.max }；前置 guard：disposed || props.readonly、available <= 0add 内触发（script 行 26）；参数表达式：{ max: props.max, files: candidates }；前置 guard：disposed || props.readonly、available <= 0add 内触发（script 行 35）；参数表达式：{ max: props.max, files: [file] }；前置 guard：available <= 0、disposed || props.readonly || version != addVersion、disposed || props.readonly || version != addVersion | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
oversize | add 内触发（script 行 29）；参数表达式：{ file }；前置 guard：disposed || props.readonly、available <= 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
progress | progressFile 内触发（script 行 119）；参数表达式：{ file, progress: file.progress } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
success | successFile 内触发（script 行 120）；参数表达式：{ file, response } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
error | errorFile 内触发（script 行 121）；参数表达式：{ file, error } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
remove | removeFile 内触发（script 行 122）；参数表达式：{ index, file }；前置 guard：props.readonly || !props.deletable、file == nullclearFiles 内触发（script 行 131）；参数表达式：{ cleared: true, files: old }；前置 guard：props.readonly | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
preview | previewFile 内触发（script 行 123）；参数表达式：{ index, file }；前置 guard：file == null | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | fail 内触发（script 行 48）；参数表达式：无回调参数cancelUpload 内触发（script 行 130）；参数表达式：{ file } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
chooseFiles | chooseFiles(): void | 打开文件选择；通过组件 ref 调用，参数和返回值按签名处理。 |
submit | submit(): void | 提交当前数据；通过组件 ref 调用，参数和返回值按签名处理。 |
cancelUpload | cancelUpload(id: string): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
cancelAllUpload | cancelAllUpload(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
clearFiles | clearFiles(): void | 清空文件列表；通过组件 ref 调用，参数和返回值按签名处理。 |
retryFile | retryFile(file: UploadFile): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
retryFailed | retryFailed(): number | 重试全部失败项；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
- 当前组件 CSS 未读取
var(--xtf-*)主题变量；颜色或尺寸可能来自 props、固定样式或父级上下文。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。