Appearance
xtf-search
组件说明
xtf-search 是搜索框，用于处理关键词输入、清空、确认和防抖搜索。当前实现通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-search/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfSearch placeholder="请输入内容" />
</view>
</template>
<script setup lang="uts">
import XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfSearch placeholder="请输入内容" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-search:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfSearch placeholder="请输入内容" :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 XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
import { ref } from "vue"
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. 定制 prefix 插槽
使用源码真实声明的 prefix slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfSearch placeholder="请输入内容">
<template #prefix><text class="doc-content-text">自定义 prefix 内容</text></template>
</XtfSearch>
</view>
</template>
<script setup lang="uts">
import XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>5. 调用 focus()
调用该公开实例能力；签名为 focus(): void。
vue
<template>
<view class="doc-method">
<XtfSearch placeholder="请输入内容" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
import { ref } from "vue"
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.focus(); console.log("调用 focus") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>6. 区分 auto、search 与 cancel 动作
默认 auto 按原始字符串长度决定搜索或取消；显式 search 允许空值搜索，显式 cancel 无论关键词是否为空都关闭面板、失焦并发出 cancel。actionText 只修改文案。
vue
<template>
<view class="doc-search-actions">
<XtfSearch :value="keyword" action-mode="auto" @input="updateKeyword" @search="onSearch" @cancel="onCancel" /><XtfSearch :value="keyword" action-mode="search" @input="updateKeyword" @search="onSearch" /><XtfSearch :value="keyword" action-mode="cancel" action-text="收起" show-panel :hot-keywords="['餐饮', '交通']" @input="updateKeyword" @cancel="onCancel" /><text class="doc-state-text">关键词：{{ keyword }}</text>
</view>
</template>
<script setup lang="uts">
import XtfSearch from "@/uni_modules/xtf-linkuiunix/components/xtf-search/xtf-search.uvue"
import { ref } from "vue"
const keyword = ref("")
function updateKeyword(value: string): void { keyword.value = value }
function onSearch(value: string): void { console.log("search", value) }
function onCancel(): void { console.log("cancel", keyword.value) }
</script>
<style>
.doc-search-actions { display: flex; flex-direction: column; padding: 24rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | string | number | undefined | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 58、script 行 93 | 需要覆盖组件默认业务值时设置。 |
value | string | number | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 58、script 行 93 | 需要覆盖组件默认业务值时设置。 |
placeholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 75 | 需要提供业务文案或图标内容时设置。 |
actionText | string | "" | 设置对应区域的显示文案；消费位置：script 行 76 | 需要提供业务文案或图标内容时设置。 |
actionMode | "auto" | "search" | "cancel" | "auto" | 参与组件运行逻辑；源码在 3 处读取该值；可选值：auto / search / cancel；消费位置：script 行 76、script 行 114、script 行 115 | 需要覆盖组件默认业务值时设置。 |
showAction | boolean | true | 开关对应显示或交互行为；消费位置：template 行 21 | 需要控制显示、可用性或交互状态时设置。 |
actionVariant | "text" | "soft" | "filled" | "text" | 参与组件运行逻辑；源码在 3 处读取该值；可选值：text / soft / filled；消费位置：script 行 72、script 行 73 | 需要覆盖组件默认业务值时设置。 |
actionTheme | SearchTheme | "primary" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 72 | 需要覆盖组件默认业务值时设置。 |
clearable | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 82 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 66 | 需要控制显示、可用性或交互状态时设置。 |
readonly | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 66 | 需要控制显示、可用性或交互状态时设置。 |
loading | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 66、template 行 11 | 需要控制显示、可用性或交互状态时设置。 |
variant | "soft" | "outline" | "filled" | "glass" | "minimal" | "soft" | 参与组件运行逻辑；源码在 1 处读取该值；可选值：soft / outline / filled / glass / minimal；消费位置：script 行 68 | 需要调整布局或视觉表现时设置。 |
shape | "round" | "square" | "round" | 参与组件运行逻辑；源码在 1 处读取该值；可选值：round / square；消费位置：script 行 69 | 需要覆盖组件默认业务值时设置。 |
preset | "" | "compact" | "card" | "" | 参与组件运行逻辑；源码在 6 处读取该值；可选值："" / compact / card；消费位置：script 行 67、script 行 68、script 行 69、script 行 70 | 需要覆盖组件默认业务值时设置。 |
size | "sm" | "md" | "lg" | "md" | 参与组件运行逻辑；源码在 1 处读取该值；可选值：sm / md / lg；消费位置：script 行 67 | 需要覆盖组件默认业务值时设置。 |
height | string | number | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 74 | 需要覆盖组件默认业务值时设置。 |
barHeight | string | number | "" | 设置对应区域高度；消费位置：script 行 74 | 需要调整布局或视觉表现时设置。 |
iconPosition | "start" | "end" | "none" | "start" | 参与组件运行逻辑；源码在 2 处读取该值；可选值：start / end / none；消费位置：script 行 83、script 行 84 | 需要覆盖组件默认业务值时设置。 |
autoFocus | boolean | false | 开关对应显示或交互行为；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
theme | SearchTheme | "primary" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 6、template 行 8 | 需要调整布局或视觉表现时设置。 |
type | string | "text" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
confirmType | string | "search" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
maxlength | number | -1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
searchOnInput | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 105 | 需要覆盖组件默认业务值时设置。 |
searchDebounce | number | 0 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 106 | 需要覆盖组件默认业务值时设置。 |
showPanel | boolean | false | 开关对应显示或交互行为；消费位置：script 行 86 | 需要控制显示、可用性或交互状态时设置。 |
suggestions | string[] | () => [] as string[] | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 85 | 需要覆盖组件默认业务值时设置。 |
hotKeywords | string[] | () => [] as string[] | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 88、template 行 15 | 需要覆盖组件默认业务值时设置。 |
historyKeywords | string[] | () => [] as string[] | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 89、template 行 16 | 需要覆盖组件默认业务值时设置。 |
recentKeywords | string[] | () => [] as string[] | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 90、template 行 17 | 需要覆盖组件默认业务值时设置。 |
panelEmptyText | string | "" | 设置对应区域的显示文案；消费位置：script 行 77 | 需要提供业务文案或图标内容时设置。 |
suggestionTitle | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 78 | 需要提供业务文案或图标内容时设置。 |
hotTitle | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 79 | 需要提供业务文案或图标内容时设置。 |
historyTitle | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 80 | 需要提供业务文案或图标内容时设置。 |
recentTitle | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 81 | 需要提供业务文案或图标内容时设置。 |
closePanelOnSelect | boolean | true | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 119 | 需要覆盖组件默认业务值时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 70 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
service | boolean | false | 兼容接收，当前实现未消费/不产生行为 | 仅用于兼容现有调用；当前版本不应依赖其效果。 |
cursorSpacing | number | 0 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
selectionStart | number | -1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
selectionEnd | number | -1 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 7 | 需要覆盖组件默认业务值时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | emitValue 内触发（script 行 104）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | emitValue 内触发（script 行 104）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | emitValue 内触发（script 行 104）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | emitValue 内触发（script 行 104）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
search | emitSearchInput 内触发（script 行 105）；参数表达式：valuehandleConfirm 内触发（script 行 110）；参数表达式：value；前置 guard：isDisabled.valuehandleAction 内触发（script 行 115）；参数表达式：innerValue.value；前置 guard：isDisabled.value、props.actionMode == "cancel"、props.actionMode == "search" || innerValue.value.length > 0selectPanelItem 内触发（script 行 119）；参数表达式：value；前置 guard：isDisabled.valuesearch 内触发（script 行 122）；参数表达式：innerValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
search-input | emitSearchInput 内触发（script 行 105）；参数表达式：value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
clear | clear 内触发（script 行 118）；参数表达式：无回调参数；前置 guard：isDisabled.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
cancel | handleAction 内触发（script 行 114）；参数表达式：无回调参数；前置 guard：isDisabled.value、props.actionMode == "cancel"handleAction 内触发（script 行 116）；参数表达式：无回调参数；前置 guard：isDisabled.value、props.actionMode == "cancel"、props.actionMode == "search" || innerValue.value.length > 0 | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
focus | handleFocus 内触发（script 行 108）；参数表达式：event；前置 guard：isDisabled.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
blur | setup 内触发（script 行 109）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
select-suggestion | selectPanelItem 内触发（script 行 119）；参数表达式：{ value, source }；前置 guard：isDisabled.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
prefix | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
suffix | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
action | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
focus | focus(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
blur | blur(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
clear | clear(): void | 清空内容；通过组件 ref 调用，参数和返回值按签名处理。 |
search | search(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
closePanel | closePanel(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
var(--xtf-color-border)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-danger-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-info)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-info-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-primary-soft)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-success)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-success-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 下覆盖。var(--xtf-color-warning)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-color-warning-soft)：组件样式实际读取的主题变量，可在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：
service。 - actionMode 默认 auto：动作点击先取消待触发的防抖；auto 在原始值 length > 0 时 search，否则 cancel（空白串也算非空），不执行显式 cancel 的面板关闭/失焦。search 总是发 search（允许空值），cancel 总是关闭面板、失焦并发 cancel。未指定 actionText 时 search 文案为“搜索”，auto/cancel 文案为“取消”；文案不会决定行为。disabled/readonly/loading 会阻止动作。
- 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。