Appearance
xtf-form-array
组件说明
xtf-form-array 是数组表单，用于增删、复制和排序重复表单行。当前实现读取 modelValue 数据、通过 update:modelValue 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-form-array/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfFormArray title="账单详情" :model-value="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfFormArray from "@/uni_modules/xtf-linkuiunix/components/xtf-form-array/xtf-form-array.uvue"
const fixture = [{ name: '餐饮', amount: 86 }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfFormArray title="账单详情" :model-value="fixture" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfFormArray from "@/uni_modules/xtf-linkuiunix/components/xtf-form-array/xtf-form-array.uvue"
const fixture = [{ name: '餐饮', amount: 86 }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-form-array:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfFormArray title="账单详情" :model-value="fixture" :disabled="state" />
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfFormArray from "@/uni_modules/xtf-linkuiunix/components/xtf-form-array/xtf-form-array.uvue"
import { ref } from "vue"
const fixture = [{ name: '餐饮', amount: 86 }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", 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. 定制 title 插槽
使用源码真实声明的 title slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfFormArray title="账单详情" :model-value="fixture">
<template #title><text class="doc-content-text">自定义 title 内容</text></template>
</XtfFormArray>
</view>
</template>
<script setup lang="uts">
import XtfFormArray from "@/uni_modules/xtf-linkuiunix/components/xtf-form-array/xtf-form-array.uvue"
const fixture = [{ name: '餐饮', amount: 86 }] as Array<any>
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 handleAdd()
调用该公开实例能力；签名为 handleAdd(): void。
vue
<template>
<view class="doc-method">
<XtfFormArray title="账单详情" :model-value="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfFormArray from "@/uni_modules/xtf-linkuiunix/components/xtf-form-array/xtf-form-array.uvue"
import { ref } from "vue"
const fixture = [{ name: '餐饮', amount: 86 }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.handleAdd(); console.log("调用 handleAdd") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | Array<any> | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 21 | 需要覆盖组件默认业务值时设置。 |
value | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 21 | 需要覆盖组件默认业务值时设置。 |
name | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 69、script 行 70 | 需要覆盖组件默认业务值时设置。 |
title | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 3 | 需要提供业务文案或图标内容时设置。 |
minItems | string | number | 0 | 提供组件渲染或选择使用的数据集合；消费位置：script 行 13 | 数据驱动或选项渲染场景。 |
maxItems | string | number | 0 | 提供组件渲染或选择使用的数据集合；消费位置：script 行 14 | 数据驱动或选项渲染场景。 |
removable | boolean | true | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 59、template 行 6 | 需要覆盖组件默认业务值时设置。 |
addable | boolean | true | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 45、template 行 8 | 需要覆盖组件默认业务值时设置。 |
copyable | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 52、template 行 6 | 需要覆盖组件默认业务值时设置。 |
addButtonText | string | "" | 设置对应区域的显示文案；消费位置：template 行 8 | 需要提供业务文案或图标内容时设置。 |
template | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 46 | 需要覆盖组件默认业务值时设置。 |
showIndexes | boolean | false | 开关对应显示或交互行为；消费位置：template 行 9 | 需要控制显示、可用性或交互状态时设置。 |
itemKey | string | "_faKey" | 参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 23、script 行 29、script 行 33、script 行 38 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 18 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | string | UTSJSONObject | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | emitChange 内触发（script 行 39）；参数表达式：clone(localItems.value) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
input | emitChange 内触发（script 行 39）；参数表达式：clone(localItems.value) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | emitChange 内触发（script 行 39）；参数表达式：clone(localItems.value) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
add | handleAdd 内触发（script 行 49）；参数表达式：{ item: clone(item), index: activeIndex.value, items: clone(localItems.value) }；前置 guard：blocked.value || !props.addable || !canGrow.valuehandleCopy 内触发（script 行 56）；参数表达式：{ item: clone(item), index: index + 1, items: clone(localItems.value) }；前置 guard：blocked.value || !props.copyable || !validIndex(index) || !canGrow.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
remove | handleRemove 内触发（script 行 62）；参数表达式：{ item, index, items: clone(localItems.value) }；前置 guard：blocked.value || !props.removable || !validIndex(index) || localItems.value.length <= minItems.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
title | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
default | { item, index, total, add, remove } | 仅在模板对应 <slot> 渲染位置生效。 |
actions | { item, index, disabled, readonly, loading, remove } | 仅在模板对应 <slot> 渲染位置生效。 |
add-btn | { add, disabled, readonly, loading } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
handleAdd | handleAdd(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
handleRemove | handleRemove(index: number): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
handleCopy | handleCopy(index: number): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
move | move(index: number, delta: number): void | 调用该公开实例能力；通过组件 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。