Appearance
xtf-tree-select
组件说明
xtf-tree-select 是树形选择,用于通过左右层级导航选择叶子项。当前实现读取 options 数据、通过 update:modelValue 等事件反馈交互。
- 实际 Demo 路由:
#/pages/components/xtf-tree-select/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfTreeSelect title="账单详情" :options="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfTreeSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-tree-select/xtf-tree-select.uvue"
const fixture = [{ text: '餐饮', value: 'food', children: [{ text: '午餐', value: 'lunch' }] }, { text: '交通', value: 'traffic', children: [{ text: '地铁', value: 'metro' }] }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口,并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfTreeSelect title="账单详情" :options="fixture" @change="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfTreeSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-tree-select/xtf-tree-select.uvue"
const fixture = [{ text: '餐饮', value: 'food', children: [{ text: '午餐', value: 'lunch' }] }, { text: '交通', value: 'traffic', children: [{ text: '地铁', value: 'metro' }] }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-tree-select:change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 multiple 状态
运行时切换 multiple,观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfTreeSelect title="账单详情" :options="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 XtfTreeSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-tree-select/xtf-tree-select.uvue"
import { ref } from "vue"
const fixture = [{ text: '餐饮', value: 'food', children: [{ text: '午餐', value: 'lunch' }] }, { text: '交通', value: 'traffic', children: [{ text: '地铁', value: 'metro' }] }] 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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | any | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:script 行 39 | 需要覆盖组件默认业务值时设置。 |
options | any[] | () => [] as any[] | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 34、script 行 67、script 行 75、script 行 161 | 数据驱动或选项渲染场景。 |
multiple | boolean | false | 参与组件运行逻辑;源码在 4 处读取该值;消费位置:script 行 40、script 行 135、script 行 142、script 行 159 | 需要控制显示、可用性或交互状态时设置。 |
title | string | '' | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:template 行 3、template 行 4 | 需要提供业务文案或图标内容时设置。 |
selectedText | string | '已选' | 设置对应区域的显示文案;消费位置:template 行 6 | 需要提供业务文案或图标内容时设置。 |
showSelected | boolean | true | 开关对应显示或交互行为;消费位置:template 行 3、template 行 5 | 需要控制显示、可用性或交互状态时设置。 |
emptyText | string | '暂无可选项' | 设置对应区域的显示文案;消费位置:template 行 38 | 需要提供业务文案或图标内容时设置。 |
fieldNames | UTSJSONObject | () => ({ text: 'text', value: 'value', children: 'children', disabled: 'disabled' } as UTSJSONObject) | 参与组件运行逻辑;源码在 2 处读取该值;消费位置:script 行 46、script 行 162 | 需要覆盖组件默认业务值时设置。 |
height | string | number | 420 | 参与组件运行逻辑;源码在 3 处读取该值;消费位置:script 行 37 | 需要覆盖组件默认业务值时设置。 |
navItemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 99 | 需要调整布局或视觉表现时设置。 |
navActiveItemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 99 | 需要调整布局或视觉表现时设置。 |
itemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 102 | 需要调整布局或视觉表现时设置。 |
selectedItemStyle | any | '' | 覆盖或追加对应内部区域的样式对象;消费位置:script 行 102 | 需要调整布局或视觉表现时设置。 |
customClass | string | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | any | '' | 参与组件运行逻辑;源码在 1 处读取该值;消费位置:template 行 2 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | selectItem 内触发(script 行 143);参数表达式:result;前置 guard:activeNode.value == null || isDisabled(item) || (item !== activeNode.value && activeChildren.value.indexOf(item) < 0) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
change | selectItem 内触发(script 行 144);参数表达式:{ value: result, selected: item, path: trail.value.concat(activeNode.value == null ? [] : [activeNode.value]) };前置 guard:activeNode.value == null || isDisabled(item) || (item !== activeNode.value && activeChildren.value.indexOf(item) < 0) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
click-nav | selectNav 内触发(script 行 117);参数表达式:{ item, index, path: trail.value.slice() };前置 guard:!branchAllowed() || currentOptions.value[index] !== item || isDisabled(item) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
click-selected | handleSelectedTap 内触发(script 行 159);参数表达式:{ value: props.multiple ? selectedValues.value.slice() : (selectedValues.value[0] ?? '') } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点;禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
| - | - | 当前组件没有公开实例方法。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface-muted):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-disabled):组件样式实际读取的主题变量,可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text-secondary):组件样式实际读取的主题变量,可在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。