xtf-list

组件说明

xtf-list 是业务列表，用于展示带操作、状态和侧滑能力的数据行。当前实现读取 items 数据、通过 click 等事件反馈交互、提供实例方法。

• 实际 Demo 路由：#/pages/components/xtf-list/index
• Demo 源码

---

基础用法

1. 最小可用

提供能够直接看到或操作组件的最少业务内容。

<template>
  <view class="doc-minimum">
    <XtfList :items="fixture" />
  </view>
</template>

<script setup lang="uts">
import XtfList from "@/uni_modules/xtf-linkuiunix/components/xtf-list/xtf-list.uvue"

const fixture = [{ id: 1, title: '本月账单', desc: '待核对' }, { id: 2, title: '上月账单', desc: '已完成' }] as Array<any>
</script>

<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>

2. 核心数据与主要事件

使用组件真实数据入口，并记录当前源码声明的主要事件。

<template>
  <view class="doc-core">
    <XtfList :items="fixture" @click="onPrimaryEvent" />
  </view>
</template>

<script setup lang="uts">
import XtfList from "@/uni_modules/xtf-linkuiunix/components/xtf-list/xtf-list.uvue"

const fixture = [{ id: 1, title: '本月账单', desc: '待核对' }, { id: 2, title: '上月账单', desc: '已完成' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-list:click", payload) }
</script>

<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>

3. 动态 grouped 状态

运行时切换 grouped，观察组件对应状态变化。

<template>
  <view class="doc-dynamic">
    <XtfList :items="fixture" :grouped="state" />
    <button class="doc-action-button" @click="toggleState">切换 grouped</button>
    <text class="doc-state-text">grouped: {{ state }}</text>
  </view>
</template>

<script setup lang="uts">
import XtfList from "@/uni_modules/xtf-linkuiunix/components/xtf-list/xtf-list.uvue"

import { ref } from "vue"
const fixture = [{ id: 1, title: '本月账单', desc: '待核对' }, { id: 2, title: '上月账单', desc: '已完成' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("grouped", 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. 定制 header 插槽

使用源码真实声明的 header slot 替换对应内容。

<template>
  <view class="doc-slot">
    <XtfList :items="fixture">
      <template #header><text class="doc-content-text">自定义 header 内容</text></template>
    </XtfList>
  </view>
</template>

<script setup lang="uts">
import XtfList from "@/uni_modules/xtf-linkuiunix/components/xtf-list/xtf-list.uvue"

const fixture = [{ id: 1, title: '本月账单', desc: '待核对' }, { id: 2, title: '上月账单', desc: '已完成' }] as Array<any>
</script>

<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>

5. 调用 openSwipeRow()

调用该公开实例能力；签名为 openSwipeRow(index: number, item: any = null, position: string = "right"): void。

<template>
  <view class="doc-method">
    <XtfList :items="fixture" ref="componentRef" />
    <button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
  </view>
</template>

<script setup lang="uts">
import XtfList from "@/uni_modules/xtf-linkuiunix/components/xtf-list/xtf-list.uvue"

import { ref } from "vue"
const fixture = [{ id: 1, title: '本月账单', desc: '待核对' }, { id: 2, title: '上月账单', desc: '已完成' }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.openSwipeRow(0); console.log("调用 openSwipeRow") }
</script>

<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>

---

全部属性

属性	源码类型	withDefaults 默认值	实际行为 / 范围	适用范围
items	Array<any>	() => [] as Array<any>	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 13、script 行 21	数据驱动或选项渲染场景。
groups	Array<any>	() => [] as Array<any>	参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 13、script 行 21	需要覆盖组件默认业务值时设置。
sectionTitle	string	""	参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 3、template 行 4	需要提供业务文案或图标内容时设置。
sectionDesc	string	""	参与组件运行逻辑；源码在 3 处读取该值；消费位置：template 行 3、template 行 4	需要覆盖组件默认业务值时设置。
theme	string	"primary"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 16	需要调整布局或视觉表现时设置。
itemVariant	string	"surface"	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 16	需要覆盖组件默认业务值时设置。
grouped	boolean	false	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 6	需要覆盖组件默认业务值时设置。
divider	boolean	true	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 16	需要覆盖组件默认业务值时设置。
dividerInset	string | number	88	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 16	需要覆盖组件默认业务值时设置。
actionWidth	string | number	112	设置对应区域宽度；消费位置：script 行 27、script 行 33	需要调整布局或视觉表现时设置。
swipeOpenThreshold	number	0.42	参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 37	需要覆盖组件默认业务值时设置。
loadMore	string	""	参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 70、script 行 71、template 行 27	需要覆盖组件默认业务值时设置。
loadMoreTexts	UTSJSONObject	() => ({} as UTSJSONObject)	参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 70	需要覆盖组件默认业务值时设置。
customClass	string	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。
customStyle	string | UTSJSONObject	""	参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2	需要调整布局或视觉表现时设置。

---

事件

事件名称	源码触发边界	回调参数	参数说明
click	handleItem 内触发（script 行 61）；参数表达式：payload；前置 guard：opened.value >= 0、!interactive(item)	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
item-click	handleItem 内触发（script 行 61）；参数表达式：payload；前置 guard：opened.value >= 0、!interactive(item)	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
swipe-action	handleAction 内触发（script 行 69）；参数表达式：{ action, item: original(item), index: item.rowIndex }；前置 guard：item.disabled === true || action.disabled === true	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
switch-change	handleSwitch 内触发（script 行 67）；参数表达式：{ checked, item: original(item), index: item.rowIndex }	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
long-press	handleLongPress 内触发（script 行 68）；参数表达式：{ item: original(item), index: item.rowIndex }	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
load-more	handleLoad 内触发（script 行 71）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。
retry-load-more	handleLoad 内触发（script 行 71）；参数表达式：无回调参数	(...args: any[])	表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。

---

插槽

插槽	Scope 参数	实际渲染位置
header	无 scope 参数	仅在模板对应 <slot> 渲染位置生效。
groupHeader	{ group, groupIndex }	仅在模板对应 <slot> 渲染位置生效。
item	{ item, index, group, groupIndex }	仅在模板对应 <slot> 渲染位置生效。
right	{ item, index, group, groupIndex }	仅在模板对应 <slot> 渲染位置生效。
load-more	无 scope 参数	仅在模板对应 <slot> 渲染位置生效。

---

方法

实例方法

方法	签名 / 返回值	调用边界
openSwipeRow	openSwipeRow(index: number, item: any = null, position: string = "right"): void	调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。
closeSwipeRow	closeSwipeRow(index: number): void	调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。

公开状态

状态	类型 / 包装	读取边界
normalizedGroups	normalizedGroups: inferred (computed)	通过组件 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。