Appearance
xtf-table
组件说明
xtf-table 是表格，用于按列定义展示结构化行数据。当前实现读取 data 数据、通过 update:selectedRowKeys 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-table/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfTable :data="fixture" :columns="columns" />
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfTable :data="fixture" :columns="columns" selectable @selection-change="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-table:selection-change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 loading 状态
运行时切换 loading，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfTable :data="fixture" :columns="columns" :loading="state" />
<button class="doc-action-button" @click="toggleState">切换 loading</button>
<text class="doc-state-text">loading: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
import { ref } from "vue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("loading", 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. 调用 clearSelection()
调用该公开实例能力；签名为 clearSelection(): void。
vue
<template>
<view class="doc-method">
<XtfTable :data="fixture" :columns="columns" selectable ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
import { ref } from "vue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.clearSelection(); console.log("调用 clearSelection") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>5. cell scope 与 formatter 回退
cell 接收原始行、列、原始值和当前显示行列索引。此例定制金额列，其余列由插槽自行输出；移除整个 cell 插槽即可恢复默认 formatter(value, row, column) 渲染。
vue
<template>
<view class="doc-table-cell">
<XtfTable :data="fixture" :columns="columns" @cell-click="onCell">
<template #cell="scope"><text class="doc-content-text">{{ scope.column.dataIndex == "amount" ? "￥" + scope.value.toString() : scope.value }}（{{ scope.row.id }} / {{ scope.rowIndex }}:{{ scope.columnIndex }}）</text></template>
</XtfTable>
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
function onCell(payload: any): void { console.log("cell-click", payload.row, payload.column, payload.rowIndex, payload.columnIndex) }
</script>
<style>
.doc-table-cell { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>6. 唯一 rowKey 与受控选择
默认 rowKey 为 id；缺失、重复或非有效基础值的键对应行不可选择。树表键必须在整棵数据树中唯一；表头全选仅作用于当前显示的可选行。
vue
<template>
<view class="doc-table-selection">
<XtfTable :data="fixture" :columns="columns" selectable row-key="id" :selected-row-keys="selectedKeys" @update:selectedRowKeys="updateKeys" @selection-change="onSelection" />
</view>
</template>
<script setup lang="uts">
import XtfTable from "@/uni_modules/xtf-linkuiunix/components/xtf-table/xtf-table.uvue"
import { ref } from "vue"
const fixture = [{ id: 'food', name: '餐饮', amount: 86 }, { id: 'traffic', name: '交通', amount: 24 }] as Array<any>
const columns = [{ key: "name", dataIndex: "name", title: "分类" }, { key: "amount", dataIndex: "amount", title: "金额", sortable: true, formatter: (value: any, _row: any, _column: any): string => "￥" + value.toString() }] as Array<any>
const selectedKeys = ref<Array<any>>([])
function updateKeys(keys: Array<any>): void { selectedKeys.value = keys }
function onSelection(payload: any): void { console.log("selection-change", payload.keys, payload.rows) }
</script>
<style>
.doc-table-selection { display: flex; flex-direction: column; padding: 24rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
columns | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 16 | 数据驱动或选项渲染场景。 |
data | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 13、script 行 34、script 行 45 | 数据驱动或选项渲染场景。 |
rowKey | string | "id" | 参与组件运行逻辑；源码在 7 处读取该值；消费位置：script 行 12、script 行 21、script 行 24、script 行 44 | 需要覆盖组件默认业务值时设置。 |
selectable | boolean | false | 开关对应显示或交互行为；消费位置：script 行 53、template 行 5、template 行 8 | 需要覆盖组件默认业务值时设置。 |
selectedRowKeys | Array<any> | () => [] as Array<any> | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 6、script 行 66 | 需要覆盖组件默认业务值时设置。 |
selectOnRowClick | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 53 | 需要覆盖组件默认业务值时设置。 |
selectionColumnWidth | string | number | 76 | 设置对应区域宽度；消费位置：script 行 41 | 需要调整布局或视觉表现时设置。 |
stripe | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
minWidth | string | number | "" | 设置对应区域宽度；消费位置：script 行 40 | 需要调整布局或视觉表现时设置。 |
loading | boolean | false | 参与组件运行逻辑；源码在 8 处读取该值；消费位置：script 行 46、script 行 47、script 行 55、script 行 57 | 需要控制显示、可用性或交互状态时设置。 |
defaultSortKey | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 6 | 需要覆盖组件默认业务值时设置。 |
defaultSortOrder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 6 | 需要覆盖组件默认业务值时设置。 |
treeData | boolean | false | 提供组件渲染或选择使用的数据集合；消费位置：script 行 12、script 行 32、script 行 45、template 行 10 | 数据驱动或选项渲染场景。 |
childrenKey | string | "children" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 29 | 需要覆盖组件默认业务值时设置。 |
treeIndent | string | number | 40 | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 50 | 需要覆盖组件默认业务值时设置。 |
defaultExpandAll | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 32 | 需要覆盖组件默认业务值时设置。 |
page | string | number | 1 | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 36、script 行 67 | 需要覆盖组件默认业务值时设置。 |
pageSize | string | number | 0 | 设置对应元素尺寸；消费位置：script 行 37 | 需要调整布局或视觉表现时设置。 |
total | string | number | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 38 | 需要覆盖组件默认业务值时设置。 |
showPagination | boolean | false | 开关对应显示或交互行为；消费位置：script 行 38、script 行 39、template 行 19 | 需要控制显示、可用性或交互状态时设置。 |
emptyText | string | "" | 设置对应区域的显示文案；消费位置：template 行 16 | 需要提供业务文案或图标内容时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:selectedRowKeys | commitSelection 内触发（script 行 45）；参数表达式：next | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
selection-change | commitSelection 内触发（script 行 45）；参数表达式：{ keys: next, rows } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
sort | sortBy 内触发（script 行 48）；参数表达式：{ column, key: sortKey.value, order: sortOrder.value }；前置 guard：column["sortable"] != true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
row-click | clickRow 内触发（script 行 53）；参数表达式：{ row: originalRow(row), rowIndex: index } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cell-click | clickCell 内触发（script 行 54）；参数表达式：{ row: originalRow(row), rowIndex, column, columnIndex } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:page | changePage 内触发（script 行 55）；参数表达式：next；前置 guard：props.loading、next == currentPage.valuechangePageSize 内触发（script 行 61）；参数表达式：1；前置 guard：props.loading || !Number.isFinite(size) || size < 1、next == resolvedPageSize.valuesetup 内触发（script 行 67）；参数表达式：currentPage.value；前置 guard：props.loading | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:pageSize | changePageSize 内触发（script 行 60）；参数表达式：next；前置 guard：props.loading || !Number.isFinite(size) || size < 1、next == resolvedPageSize.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
page-change | changePage 内触发（script 行 55）；参数表达式：next；前置 guard：props.loading、next == currentPage.valuechangePageSize 内触发（script 行 63）；参数表达式：1；前置 guard：props.loading || !Number.isFinite(size) || size < 1、next == resolvedPageSize.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
page-size-change | changePageSize 内触发（script 行 62）；参数表达式：{ page: 1, pageSize: next }；前置 guard：props.loading || !Number.isFinite(size) || size < 1、next == resolvedPageSize.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
cell | (props: { row: any; column: any; value: any; rowIndex: number; columnIndex: number }) | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
clearSelection | clearSelection(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
changePage | changePage(page: number): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
changePageSize | changePageSize(size: number): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-primary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - cell scope 为 { row, column, value, rowIndex, columnIndex }：row 为原始对象，value 为未经 formatter 的字段值；行索引对应当前排序/树展开/分页后的显示行，列索引对应过滤 hidden 后的可见列。未提供 cell 插槽时仍使用 formatter(value, row, column) 作为 fallback；提供插槽会替换整段单元格默认内容。selection 要求 rowKey（默认 id）在全量树数据中有效且唯一：允许字符串、布尔值及有限数值，缺失/重复/对象/NaN/Infinity 键不可选。
- 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。