Appearance
xtf-input
组件说明
xtf-input 是输入框，用于处理单行、多行、格式化和校验输入。当前实现通过 input 等事件反馈交互。
- 实际 Demo 路由：
#/pages/components/xtf-input/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfInput label="保存" />
</view>
</template>
<script setup lang="uts">
import XtfInput from "@/uni_modules/xtf-linkuiunix/components/xtf-input/xtf-input.uvue"
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfInput label="保存" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfInput from "@/uni_modules/xtf-linkuiunix/components/xtf-input/xtf-input.uvue"
function onPrimaryEvent(payload: any): void { console.log("xtf-input:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfInput label="保存" :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 XtfInput from "@/uni_modules/xtf-linkuiunix/components/xtf-input/xtf-input.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. 定制 label 插槽
使用源码真实声明的 label slot 替换对应内容。
vue
<template>
<view class="doc-slot">
<XtfInput label="保存">
<template #label><text class="doc-content-text">自定义 label 内容</text></template>
</XtfInput>
</view>
</template>
<script setup lang="uts">
import XtfInput from "@/uni_modules/xtf-linkuiunix/components/xtf-input/xtf-input.uvue"
</script>
<style>
.doc-slot { display: flex; flex-direction: column; padding: 24rpx; }
.doc-content-text { color: #334155; font-size: 26rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
value | string | number | null | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 35、script 行 115 | 需要覆盖组件默认业务值时设置。 |
modelValue | string | number | null | null | 参与组件运行逻辑；源码在 4 处读取该值；消费位置：script 行 35、script 行 115 | 需要覆盖组件默认业务值时设置。 |
label | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 3、template 行 4 | 需要提供业务文案或图标内容时设置。 |
placeholder | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 53 | 需要提供业务文案或图标内容时设置。 |
placeholderClass | string | "" | 追加到对应内部区域的 class；消费位置：template 行 12、template 行 13 | 需要调整布局或视觉表现时设置。 |
type | "text" | "number" | "idcard" | "digit" | "tel" | "safe-password" | "password" | "textarea" | "text" | 参与组件运行逻辑；源码在 10 处读取该值；可选值：text / number / idcard / digit / tel / safe-password / password / textarea；消费位置：script 行 48、script 行 49、script 行 51、script 行 52 | 需要覆盖组件默认业务值时设置。 |
rows | number | string | 4 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 73 | 需要覆盖组件默认业务值时设置。 |
autoHeight | boolean | AutoSize | true | 设置对应区域高度；消费位置：script 行 61、script 行 73 | 需要调整布局或视觉表现时设置。 |
autosize | boolean | AutoSize | undefined | 开关对应显示或交互行为；消费位置：script 行 61、script 行 73 | 需要覆盖组件默认业务值时设置。 |
maxHeight | number | string | "" | 设置对应区域高度；消费位置：script 行 73 | 需要调整布局或视觉表现时设置。 |
inputmode | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 52 | 需要覆盖组件默认业务值时设置。 |
variant | InputVariant | "surface" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 69 | 需要调整布局或视觉表现时设置。 |
theme | InputTheme | "primary" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：template 行 9、template 行 17、template 行 19 | 需要调整布局或视觉表现时设置。 |
color | string | "" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 71 | 需要覆盖组件默认业务值时设置。 |
size | InputSize | "md" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 68、script 行 69、script 行 70 | 需要覆盖组件默认业务值时设置。 |
status | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 57、script 行 99 | 需要覆盖组件默认业务值时设置。 |
message | string | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 58、script 行 99 | 需要提供业务文案或图标内容时设置。 |
labelWidth | number | string | "" | 设置对应区域宽度；消费位置：script 行 72 | 需要调整布局或视觉表现时设置。 |
required | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 101、template 行 4 | 需要控制显示、可用性或交互状态时设置。 |
rules | InputRule[] | () => [] as InputRule[] | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 102 | 需要覆盖组件默认业务值时设置。 |
showCount | boolean | false | 开关对应显示或交互行为；消费位置：script 行 60 | 需要控制显示、可用性或交互状态时设置。 |
showWordLimit | boolean | false | 开关对应显示或交互行为；消费位置：script 行 60、script 行 75 | 需要控制显示、可用性或交互状态时设置。 |
formatter | (value: string, context: InputFormatterContext) => string | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 79 | 需要覆盖组件默认业务值时设置。 |
parser | (value: string) => string | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 79 | 需要覆盖组件默认业务值时设置。 |
showStatusIcon | boolean | false | 设置对应区域的图标名称；消费位置：script 行 64 | 需要控制显示、可用性或交互状态时设置。 |
prefixIcon | string | "" | 设置对应区域的图标名称；消费位置：template 行 8、template 行 9 | 需要提供业务文案或图标内容时设置。 |
suffixIcon | string | "" | 设置对应区域的图标名称；消费位置：script 行 67、template 行 19 | 需要提供业务文案或图标内容时设置。 |
clearable | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 62 | 需要覆盖组件默认业务值时设置。 |
clearTrigger | "always" | "focus" | "always" | 参与组件运行逻辑；源码在 1 处读取该值；可选值：always / focus；消费位置：script 行 62 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | undefined | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 50 | 需要控制显示、可用性或交互状态时设置。 |
readonly | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 50 | 需要控制显示、可用性或交互状态时设置。 |
maxlength | number | string | 140 | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 55 | 需要覆盖组件默认业务值时设置。 |
confirmType | string | "done" | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
confirmHold | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
focus | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 54 | 需要覆盖组件默认业务值时设置。 |
autoFocus | boolean | false | 开关对应显示或交互行为；消费位置：script 行 54 | 需要覆盖组件默认业务值时设置。 |
adjustPosition | boolean | true | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
cursorSpacing | number | string | 24 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
cursor | number | string | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
selectionStart | number | string | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
selectionEnd | number | string | -1 | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
holdKeyboard | boolean | false | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：template 行 12、template 行 13 | 需要覆盖组件默认业务值时设置。 |
autoBlur | boolean | false | 开关对应显示或交互行为；消费位置：template 行 13 | 需要覆盖组件默认业务值时设置。 |
ignoreCompositionEvent | boolean | true | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 13 | 需要覆盖组件默认业务值时设置。 |
showConfirmBar | boolean | true | 开关对应显示或交互行为；消费位置：template 行 12 | 需要控制显示、可用性或交互状态时设置。 |
fixed | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 12 | 需要覆盖组件默认业务值时设置。 |
disableDefaultPadding | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 12 | 需要覆盖组件默认业务值时设置。 |
searchActionText | string | "" | 设置对应区域的显示文案；消费位置：script 行 63、template 行 20 | 需要提供业务文案或图标内容时设置。 |
showPasswordToggle | boolean | false | 开关对应显示或交互行为；消费位置：script 行 67、template 行 17 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 68 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
AutoSize 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
minRows | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
maxRows | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
InputRule 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
required | boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
minLength | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
maxLength | number | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
pattern | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
validator | (value: string, rule: InputRule) => boolean | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
message | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
trigger | string | 源码声明的业务扩展字段；当前实现未提供更具体语义。 |
InputFormatterContext 数据结构
| 字段 | 源码类型 | 字段语义 |
|---|---|---|
type | string | 类型标识 |
value | string | 业务值 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | updateInput 内触发（script 行 79）；参数表达式：value；前置 guard：finalValue && value == innerValue.valueclearValue 内触发（script 行 95）；参数表达式：""；前置 guard：!showClear.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | updateInput 内触发（script 行 79）；参数表达式：value；前置 guard：finalValue && value == innerValue.valueclearValue 内触发（script 行 95）；参数表达式：""；前置 guard：!showClear.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | updateInput 内触发（script 行 79）；参数表达式：value；前置 guard：finalValue && value == innerValue.valueclearValue 内触发（script 行 95）；参数表达式：""；前置 guard：!showClear.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | updateInput 内触发（script 行 79）；参数表达式：value；前置 guard：finalValue && value == innerValue.valueclearValue 内触发（script 行 95）；参数表达式：""；前置 guard：!showClear.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
focus | handleFocus 内触发（script 行 89）；参数表达式：event；前置 guard：isDisabled.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
blur | handleBlur 内触发（script 行 91）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
confirm | handleConfirm 内触发（script 行 92）；参数表达式：event.detail.value；前置 guard：isDisabled.value || inputEnded | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
clear | clearValue 内触发（script 行 95）；参数表达式：无回调参数；前置 guard：!showClear.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
search | triggerSearch 内触发（script 行 97）；参数表达式：innerValue.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
linechange | handleLineChange 内触发（script 行 93）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
keyboardheightchange | handleKeyboardHeightChange 内触发（script 行 94）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
label | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
prefix | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
suffix | 无 scope 参数 | 仅在模板对应 <slot> 渲染位置生效。 |
message | 无 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-success)：组件样式实际读取的主题变量，可在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-input-color)：组件样式实际读取的主题变量，可在xtf-config-provider作用域或主题 class 下覆盖。var(--xtf-shadow-card)：组件样式实际读取的主题变量，可在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。