Appearance
xtf-select
组件说明
xtf-select 是选择器，用于从可搜索选项中选择单值或多值。当前实现读取 options 数据、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-select/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfSelect label="保存" :options="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-select/xtf-select.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'traffic' }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfSelect label="保存" :options="fixture" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-select/xtf-select.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'traffic' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-select:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfSelect label="保存" :options="fixture" :disabled="state" />
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-select/xtf-select.uvue"
import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'traffic' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", 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. 定制 tag 插槽
使用源码真实声明的 tag slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfSelect label="保存" :options="fixture">
<template #tag="scope"><text class="doc-content-text">自定义 tag 内容：{{ scope.option }}</text></template>
</XtfSelect>
</view>
</template>
<script setup lang="uts">
import XtfSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-select/xtf-select.uvue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'traffic' }] as Array<any>
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 open()
打开组件；签名为 open(): void。
vue
<template>
<view class="doc-method">
<XtfSelect label="保存" :options="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">打开组件</button>
</view>
</template>
<script setup lang="uts">
import XtfSelect from "@/uni_modules/xtf-linkuiunix/components/xtf-select/xtf-select.uvue"
import { ref } from "vue"
const fixture = [{ label: '餐饮', value: 'food' }, { label: '交通', value: 'traffic' }] 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 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
locale | XtfLocale | "" | "" | 参与组件运行逻辑；源码在 2 处读取该值；可选值：""；消费位置：script 行 32 | 需要覆盖组件默认业务值时设置。 |
value | any | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 66、script 行 128 | 需要覆盖组件默认业务值时设置。 |
modelValue | any | null | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 66、script 行 128 | 需要覆盖组件默认业务值时设置。 |
label | string | "" | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 51、template 行 3、template 行 5 | 需要提供业务文案或图标内容时设置。 |
placeholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 50 | 需要提供业务文案或图标内容时设置。 |
title | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 51 | 需要提供业务文案或图标内容时设置。 |
options | any[] | () => [] as any[] | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 40 | 数据驱动或选项渲染场景。 |
localdata | any[] | null | 提供组件渲染或选择使用的数据集合；消费位置：script 行 40 | 数据驱动或选项渲染场景。 |
valueKey | string | "value" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 69、script 行 70、script 行 92 | 需要覆盖组件默认业务值时设置。 |
labelKey | string | "label" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 70 | 需要提供业务文案或图标内容时设置。 |
descKey | string | "desc" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 71 | 需要覆盖组件默认业务值时设置。 |
size | string | "md" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 61、script 行 62 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 47 | 需要控制显示、可用性或交互状态时设置。 |
readonly | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 47 | 需要控制显示、可用性或交互状态时设置。 |
clearable | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 48 | 需要覆盖组件默认业务值时设置。 |
clear | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 48 | 需要覆盖组件默认业务值时设置。 |
required | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 4 | 需要控制显示、可用性或交互状态时设置。 |
multiple | boolean | false | 参与组件运行逻辑；源码在 23 处读取该值；消费位置：script 行 36、script 行 41、script 行 43、script 行 62 | 需要控制显示、可用性或交互状态时设置。 |
searchable | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 32 | 需要覆盖组件默认业务值时设置。 |
max | number | string | 0 | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 59、script 行 103、script 行 109 | 需要覆盖组件默认业务值时设置。 |
showToolbar | boolean | true | 开关对应显示或交互行为；消费位置：template 行 33 | 需要控制显示、可用性或交互状态时设置。 |
separator | string | " / " | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 49 | 需要覆盖组件默认业务值时设置。 |
format | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 70 | 需要覆盖组件默认业务值时设置。 |
defItem | any | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 97 | 需要覆盖组件默认业务值时设置。 |
maxVisibleTags | number | string | 2 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 45 | 需要覆盖组件默认业务值时设置。 |
message | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 23 | 需要提供业务文案或图标内容时设置。 |
searchDebounce | number | string | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 125 | 需要覆盖组件默认业务值时设置。 |
mode | string | "popup" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 58 | 需要覆盖组件默认业务值时设置。 |
placement | string | "bottom" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
closeOnClickOverlay | boolean | true | 开关对应显示或交互行为；消费位置：template 行 25 | 需要覆盖组件默认业务值时设置。 |
closeOnClickBlank | boolean | false | 开关对应显示或交互行为；消费位置：template 行 25 | 需要覆盖组件默认业务值时设置。 |
searchPlaceholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 52 | 需要提供业务文案或图标内容时设置。 |
confirmText | string | "" | 设置对应区域的显示文案；消费位置：script 行 53 | 需要提供业务文案或图标内容时设置。 |
cancelText | string | "" | 设置对应区域的显示文案；消费位置：script 行 54 | 需要提供业务文案或图标内容时设置。 |
emptyText | string | "" | 设置对应区域的显示文案；消费位置：script 行 55 | 需要提供业务文案或图标内容时设置。 |
filterMethod | ((option: any, keyword: string) => boolean) | null | null | 提供源码调用的业务回调，参数和返回值以类型列为准；消费位置：script 行 85 | 需要接入业务守卫、转换或过滤逻辑时设置。 |
maxDropdownHeight | number | string | 560 | 设置对应区域高度；消费位置：script 行 63 | 需要调整布局或视觉表现时设置。 |
maxVisibleOptions | number | string | 6 | 提供组件渲染或选择使用的数据集合；消费位置：script 行 63 | 数据驱动或选项渲染场景。 |
optionHeight | number | string | 88 | 设置对应区域高度；消费位置：script 行 63、script 行 95 | 需要调整布局或视觉表现时设置。 |
showHandle | boolean | true | 开关对应显示或交互行为；消费位置：template 行 25 | 需要控制显示、可用性或交互状态时设置。 |
showCancel | boolean | true | 开关对应显示或交互行为；消费位置：template 行 28 | 需要控制显示、可用性或交互状态时设置。 |
showIndicatorIcon | boolean | true | 设置对应区域的图标名称；消费位置：template 行 20 | 需要控制显示、可用性或交互状态时设置。 |
arrowIcon | string | "expand_more" | 设置对应区域的图标名称；消费位置：template 行 20 | 需要提供业务文案或图标内容时设置。 |
clearIcon | string | "close" | 设置对应区域的图标名称；消费位置：template 行 19 | 需要提供业务文案或图标内容时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 61 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
triggerCustomClass | string | "" | 追加到对应内部区域的 class；消费位置：script 行 62 | 需要调整布局或视觉表现时设置。 |
triggerCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象；消费位置：template 行 7 | 需要调整布局或视觉表现时设置。 |
panelCustomClass | string | "" | 追加到对应内部区域的 class；消费位置：template 行 26 | 需要调整布局或视觉表现时设置。 |
panelCustomStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象；消费位置：template 行 26 | 需要调整布局或视觉表现时设置。 |
tree | boolean | false | 参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 72、script 行 82、script 行 87、script 行 103 | 需要覆盖组件默认业务值时设置。 |
childrenKey | string | "children" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 75 | 需要覆盖组件默认业务值时设置。 |
showPath | boolean | false | 开关对应显示或交互行为；消费位置：script 行 72 | 需要控制显示、可用性或交互状态时设置。 |
pathSeparator | string | " / " | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 72 | 需要覆盖组件默认业务值时设置。 |
disabledValues | any[] | () => [] as any[] | 提供当前受控状态；是否回写以事件表为准；消费位置：script 行 77 | 需要控制显示、可用性或交互状态时设置。 |
returnObject | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 96 | 需要覆盖组件默认业务值时设置。 |
service | boolean | false | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
remote | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 127 | 需要覆盖组件默认业务值时设置。 |
datacom | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 127 | 需要覆盖组件默认业务值时设置。 |
virtual | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 127 | 需要覆盖组件默认业务值时设置。 |
virtualScroll | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 127 | 需要覆盖组件默认业务值时设置。 |
loadChildren | any | null | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 127 | 需要覆盖组件默认业务值时设置。 |
collection | string | "" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
field | string | "" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
where | any | null | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
orderby | string | "" | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
defaultExpandAll | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 130、script 行 132 | 需要覆盖组件默认业务值时设置。 |
treeCheckStrictly | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 103 | 需要覆盖组件默认业务值时设置。 |
disableBranchSelect | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 103、script 行 114 | 需要覆盖组件默认业务值时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | commit 内触发（script 行 104）；参数表达式：committedValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | commit 内触发（script 行 104）；参数表达式：committedValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | commit 内触发（script 行 104）；参数表达式：committedValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | commit 内触发（script 行 104）；参数表达式：committedValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | selectOption 内触发（script 行 103）；参数表达式：payload(value)；前置 guard：locked.value || isDisabled(option) || (props.tree && props.disableBranchSelect && hasChildren(option))、!props.multipleconfirm 内触发（script 行 117）；参数表达式：payload(value)；前置 guard：locked.value、props.multiple && Number(props.max) > 0 && values.length > Number(props.max)、reason.length > 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | cancel 内触发（script 行 119）；参数表达式：committedValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
clear | clearValue 内触发（script 行 120）；参数表达式：无回调参数；前置 guard：locked.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
search | setup 内触发（script 行 125）；参数表达式：keyword.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
open | open 内触发（script 行 97）；参数表达式：无回调参数；前置 guard：locked.value || visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
close | close 内触发（script 行 98）；参数表达式：无回调参数；前置 guard：!visible.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
reach-max | selectOption 内触发（script 行 103）；参数表达式：next.slice()；前置 guard：locked.value || isDisabled(option) || (props.tree && props.disableBranchSelect && hasChildren(option))、!props.multiple、limit > 0 && next.length >= limitconfirm 内触发（script 行 109）；参数表达式：values.slice()；前置 guard：locked.value、props.multiple && Number(props.max) > 0 && values.length > Number(props.max) | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
load-more | 仅声明，当前未找到触发路径。 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
remote-page-change | 仅声明，当前未找到触发路径。 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
error | confirm 内触发（script 行 115）；参数表达式：{ type: "invalid-draft", value: item, reason }；前置 guard：locked.value、props.multiple && Number(props.max) > 0 && values.length > Number(props.max)、reason.length > 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
tag | { option, index, label, close } | 仅在模板对应 <slot> 渲染位置生效。 |
toolbar | { keyword, selected-options, draft-value } | 仅在模板对应 <slot> 渲染位置生效。 |
option | { option, index, selected, keyword, label, desc } | 仅在模板对应 <slot> 渲染位置生效。 |
footer | { keyword, selected-options, draft-value } | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
open | open(): void | 打开组件；通过组件 ref 调用，参数和返回值按签名处理。 |
close | close(): void | 请求关闭组件；通过组件 ref 调用，参数和返回值按签名处理。 |
confirm | confirm(): void | 提交当前草稿；通过组件 ref 调用，参数和返回值按签名处理。 |
cancel | cancel(): void | 撤销当前草稿；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
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-primary-light)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft)：组件样式实际读取的主题变量，可在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-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 或方法。 - 当前仅兼容接收、未发现运行消费的 props：
placement、service、collection、field、where、orderby。 - 仅声明但当前未找到触发路径的事件：
load-more、remote-page-change。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。