Appearance
xtf-cascader
组件说明
xtf-cascader 是级联选择，用于沿层级数据逐级选择目标节点。当前实现读取 options 数据、由 show 控制显示、通过 update:modelValue 等事件反馈交互。
- 实际 Demo 路由：
#/pages/components/xtf-cascader/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfCascader title="账单详情" :show="true" :options="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfCascader from "@/uni_modules/xtf-linkuiunix/components/xtf-cascader/xtf-cascader.uvue"
const fixture = [{ value: 'zhejiang', text: '浙江', children: [{ value: 'hangzhou', text: '杭州' }] }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfCascader title="账单详情" :show="true" :options="fixture" @change="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfCascader from "@/uni_modules/xtf-linkuiunix/components/xtf-cascader/xtf-cascader.uvue"
const fixture = [{ value: 'zhejiang', text: '浙江', children: [{ value: 'hangzhou', text: '杭州' }] }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-cascader:change", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 show 状态
运行时切换 show，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfCascader title="账单详情" :options="fixture" :show="state" />
<button class="doc-action-button" @click="toggleState">切换 show</button>
<text class="doc-state-text">show: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfCascader from "@/uni_modules/xtf-linkuiunix/components/xtf-cascader/xtf-cascader.uvue"
import { ref } from "vue"
const fixture = [{ value: 'zhejiang', text: '浙江', children: [{ value: 'hangzhou', text: '杭州' }] }] as Array<any>
const state = ref(true)
function toggleState(): void { state.value = !state.value; console.log("show", 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. 调用 open()
打开组件；签名为 open(): void。
vue
<template>
<view class="doc-method">
<XtfCascader title="账单详情" :show="true" :options="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfCascader from "@/uni_modules/xtf-linkuiunix/components/xtf-cascader/xtf-cascader.uvue"
import { ref } from "vue"
const fixture = [{ value: 'zhejiang', text: '浙江', children: [{ value: 'hangzhou', text: '杭州' }] }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.open(); console.log("调用 open") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | CascaderValue[] | () => [] as CascaderValue[] | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 59、script 行 60、script 行 177、script 行 265 | 需要覆盖组件默认业务值时设置。 |
options | CascaderOption[] | () => [] as CascaderOption[] | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 90、script 行 128、script 行 149、script 行 277 | 数据驱动或选项渲染场景。 |
show | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 58、script 行 264 | 需要控制显示、可用性或交互状态时设置。 |
title | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 10、template 行 12 | 需要提供业务文案或图标内容时设置。 |
placeholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 69 | 需要提供业务文案或图标内容时设置。 |
activeColor | string | "" | 设置对应区域的颜色；消费位置：script 行 96、script 行 172、script 行 173 | 需要调整布局或视觉表现时设置。 |
closeable | boolean | false | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：template 行 8、template 行 10、template 行 14 | 需要覆盖组件默认业务值时设置。 |
ellipsis | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 33 | 需要覆盖组件默认业务值时设置。 |
fieldNames | CascaderFieldNames | () => ({ text: "text", value: "value", children: "children" } as CascaderFieldNames) | 参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 66、script 行 67、script 行 68 | 需要覆盖组件默认业务值时设置。 |
popupHeight | string | number | 560 | 设置对应区域高度；消费位置：script 行 98 | 需要调整布局或视觉表现时设置。 |
zIndex | number | 100 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 8 | 需要覆盖组件默认业务值时设置。 |
multiple | boolean | false | 参与组件运行逻辑；源码在 9 处读取该值；消费位置：script 行 87、script 行 95、script 行 169、script 行 179 | 需要控制显示、可用性或交互状态时设置。 |
checkStrictly | boolean | false | 开关对应显示或交互行为；消费位置：script 行 169 | 需要覆盖组件默认业务值时设置。 |
showActions | boolean | false | 开关对应显示或交互行为；消费位置：script 行 215、script 行 233、template 行 43 | 数据驱动或选项渲染场景。 |
useField | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3 | 需要覆盖组件默认业务值时设置。 |
filterable | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 74、template 行 27 | 需要覆盖组件默认业务值时设置。 |
filterPlaceholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 70 | 需要提供业务文案或图标内容时设置。 |
disabledValues | CascaderValue[] | () => [] as CascaderValue[] | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 167 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 3 | 需要调整布局或视觉表现时设置。 |
customStyle | any | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 99 | 需要调整布局或视觉表现时设置。 |
CascaderFieldNames 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
text | string | 显示文本 |
value | string | 业务值 |
children | string | 子节点数组 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
update:modelValue | commitSingle 内触发（script 行 240）；参数表达式：values.slice()；前置 guard：!isCompletePath(selectedPath.value)commitMultiple 内触发（script 行 248）；参数表达式：values.slice() | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:show | open 内触发（script 行 189）；参数表达式：true；前置 guard：visible.valueclose 内触发（script 行 196）；参数表达式：false；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | toggleDraft 内触发（script 行 214）；参数表达式：{ value: next.slice(), selected: item, multiple: true }selectOption 内触发（script 行 227）；参数表达式：{ value: valuesForPath(selectedPath.value), selected: item }；前置 guard：isDisabled(item)、children.length > 0selectOption 内触发（script 行 232）；参数表达式：{ value: values.slice(), selected: item }；前置 guard：isDisabled(item)、children.length > 0、props.multiple | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
finish | commitSingle 内触发（script 行 241）；参数表达式：{ value: values.slice(), selected: item, path: selectedPath.value.slice() }；前置 guard：!isCompletePath(selectedPath.value)commitMultiple 内触发（script 行 250）；参数表达式：{ value: values.slice(), selected: lastSelected.value, path: selectedPath.value.slice(), multiple: true } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
close | close 内触发（script 行 197）；参数表达式：无回调参数；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
tab-change | selectTab 内触发（script 行 204）；参数表达式：{ index, tab: tabs.value[index] }；前置 guard：index < 0 || index >= levelCount() | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件；通过组件 ref 调用，参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-surface)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-text)：组件样式实际读取的主题变量，可在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。