Appearance
xtf-tree
组件说明
xtf-tree 是树，用于展开、搜索并选择层级节点。当前实现读取 data 数据、通过 update:modelValue 等事件反馈交互。
- 实际 Demo 路由：
#/pages/components/xtf-tree/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfTree :data="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfTree from "@/uni_modules/xtf-linkuiunix/components/xtf-tree/xtf-tree.uvue"
const fixture = [{ id: 'finance', label: '财务', children: [{ id: 'bill', label: '账单' }] }, { id: 'disabled', label: '停用项', disabled: true }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfTree :data="fixture" @node-click="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfTree from "@/uni_modules/xtf-linkuiunix/components/xtf-tree/xtf-tree.uvue"
const fixture = [{ id: 'finance', label: '财务', children: [{ id: 'bill', label: '账单' }] }, { id: 'disabled', label: '停用项', disabled: true }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-tree:node-click", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 multiple 状态
运行时切换 multiple，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfTree :data="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 XtfTree from "@/uni_modules/xtf-linkuiunix/components/xtf-tree/xtf-tree.uvue"
import { ref } from "vue"
const fixture = [{ id: 'finance', label: '财务', children: [{ id: 'bill', label: '账单' }] }, { id: 'disabled', label: '停用项', disabled: true }] 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>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
data | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 43、script 行 58、script 行 75、script 行 81 | 数据驱动或选项渲染场景。 |
modelValue | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 9、script 行 82 | 需要覆盖组件默认业务值时设置。 |
selectedKeys | Array<any> | () => [] as Array<any> | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 9、script 行 82 | 需要覆盖组件默认业务值时设置。 |
expandedKeys | Array<any> | undefined | 参与组件运行逻辑；源码在 8 处读取该值；消费位置：script 行 10、script 行 12、script 行 32、script 行 63 | 需要覆盖组件默认业务值时设置。 |
defaultExpandedKeys | Array<any> | () => [] as Array<any> | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 10 | 需要覆盖组件默认业务值时设置。 |
childrenKey | string | "children" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 17 | 需要覆盖组件默认业务值时设置。 |
labelKey | string | "label" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 15、script 行 18 | 需要提供业务文案或图标内容时设置。 |
valueKey | string | "id" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 15 | 需要覆盖组件默认业务值时设置。 |
disabledKey | string | "disabled" | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 23、script 行 38、script 行 68、script 行 74 | 需要控制显示、可用性或交互状态时设置。 |
selectable | boolean | true | 开关对应显示或交互行为；消费位置：script 行 66、script 行 70 | 需要覆盖组件默认业务值时设置。 |
onlyLeafSelectable | boolean | false | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 24、script 行 66、script 行 68、script 行 70 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
maxSelectable | string | number | 0 | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 67、script 行 69 | 需要覆盖组件默认业务值时设置。 |
multiple | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 67、script 行 72 | 需要控制显示、可用性或交互状态时设置。 |
checkbox | boolean | false | 开关对应显示或交互行为；消费位置：script 行 22、script 行 66、script 行 72、script 行 73 | 需要覆盖组件默认业务值时设置。 |
checkStrictly | boolean | false | 开关对应显示或交互行为；消费位置：script 行 22、script 行 70、script 行 73 | 需要覆盖组件默认业务值时设置。 |
defaultExpandAll | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 81 | 需要覆盖组件默认业务值时设置。 |
expandAll | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 32 | 需要覆盖组件默认业务值时设置。 |
accordion | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 54 | 需要覆盖组件默认业务值时设置。 |
filterable | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3 | 需要覆盖组件默认业务值时设置。 |
filterMethod | any | null | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 28 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
searchPlaceholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 3 | 需要提供业务文案或图标内容时设置。 |
emptyText | string | "" | 设置对应区域的显示文案；消费位置：template 行 5 | 需要提供业务文案或图标内容时设置。 |
maxHeight | string | number | "" | 设置对应区域高度；消费位置：script 行 14 | 需要调整布局或视觉表现时设置。 |
indent | string | number | 44 | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 44 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | updateSelection 内触发（script 行 78）；参数表达式：internalSelected.value；前置 guard：current[props.disabledKey] === true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:selectedKeys | updateSelection 内触发（script 行 78）；参数表达式：internalSelected.value；前置 guard：current[props.disabledKey] === true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:expandedKeys | toggleNode 内触发（script 行 64）；参数表达式：next；前置 guard：!node.hasChildren、items.some((item: any): boolean => item === node.raw) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
node-click | clickNode 内触发（script 行 66）；参数表达式：node.raw；前置 guard：node.disabled || !props.selectable || (props.onlyLeafSelectable && node.hasChildren) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
node-expand | toggleNode 内触发（script 行 61）；参数表达式：node.raw；前置 guard：!node.hasChildren、items.some((item: any): boolean => item === node.raw) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
node-collapse | toggleNode 内触发（script 行 52）；参数表达式：node.raw；前置 guard：!node.hasChildren | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
check-change | updateSelection 内触发（script 行 78）；参数表达式：{ node, checked, selectedKeys: internalSelected.value }；前置 guard：current[props.disabledKey] === true | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
search | setup 内触发（script 行 82）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
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 或方法。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。