Skip to content

Input 输入框

xy-input 用于单行文本录入和轻量多行文本录入,适合搜索、名称输入、密码、备注和短摘要字段。

基础用法

最常见的用法是 v-model 绑定输入值,必要时配合 clearable 做筛选栏清空。

基础用法双向绑定

支持清空、前缀图标、多行输入等常用场景。

前后缀内容

prefixsuffix 插槽适合搭配图标、状态标签或单位说明使用。

只读

组合输入区

prepend / append 适合域名、金额、检索前缀这类有固定上下文的输入场景。

https://
.xiaoye.dev
筛选中

密码显隐与字数统计

show-passwordshow-word-limit 是表单录入里最常见的两类增强能力。

18 / 60

多行表单场景

textarea + autosize + show-word-limit 很适合项目摘要、备注说明和审批意见这类字段。

19 / 120

失焦后会触发 blur 校验;内容变长时高度会自动扩展。

当前摘要长度:19 / 120

格式化与解析

formatter / parser 适合金额、比例、编号等“展示格式”和“真实值”不同的录入场景。

当前值:10000

方法控制

通过组件暴露的 focus / blur / select / clear,可以把输入框接进更复杂的流程,例如搜索条聚焦、快捷清空和批量编辑。

与表单联动

xy-input 位于 xy-form-item 内部时,会自动接入 blur / change 校验链路。

失焦后会触发 blur 校验

行为约定

  • change 时触发 change 类规则。
  • blur 时触发 blur 类规则。
  • 点击清空按钮时会同步清除当前字段的校验状态。
  • textarea 支持 autosize 自动高度和 resize 控制。
  • 未显式传 title 时,truncatedline-clampxy-text 承担,xy-input 不负责文本省略提示。

API

Input Attributes

属性说明类型默认值
model-value当前值InputProps["modelValue"]''
model-modifiersv-model 修饰符InputModelModifiers{}
id原生 idstring
placeholder占位文本string''
disabled是否禁用booleanfalse
readonly是否只读booleanfalse
clearable是否显示清空按钮booleanfalse
clear-icon自定义清空图标string'mdi:close-circle'
show-password是否显示密码切换按钮booleanfalse
show-word-limit是否显示字数统计booleanfalse
word-limit-position字数统计位置InputProps["wordLimitPosition"]'inside'
type输入类型InputType'text'
size组件尺寸InputProps["size"]跟随全局配置
maxlength最大长度string | number
minlength最小长度string | number
rowstextarea 行数number2
resizetextarea resize 方向InputProps["resize"]'vertical'
autosizetextarea 自动高度InputAutoSizefalse
prefix-icon前置图标string''
suffix-icon后置图标string''
formatter显示格式化函数InputProps["formatter"]
parser输入解析函数InputProps["parser"]
autocomplete原生 autocompletestring'off'
form原生 formstring
tabindex原生 tabindexstring | number
validate-event是否触发表单校验booleantrue
input-style原生输入框样式StyleValue''
container-role输入框容器角色string
autofocus原生 autofocusbooleanfalse
aria-label原生 aria-labelstring
inputmode原生 inputmodeHTMLAttributes['inputmode']
name原生 namestring

Input Events

事件说明参数
update:model-value输入值变化时触发InputValueChangeHandler
input原生输入联动时触发InputValueChangeHandler
change原生 change 触发时返回当前值InputValueChangeHandler
clear点击清空按钮时触发
focus获得焦点时触发InputFocusHandler
blur失去焦点时触发InputFocusHandler

Input Slots

插槽说明
prepend输入框前置区域
append输入框后置区域
prefix输入框前缀内容
suffix输入框后缀内容
password-icon自定义密码切换图标,接收 InputPasswordIconSlotProps

Input Exposes

暴露项说明类型
ref当前原生输入元素引用InputInstance["ref"]
input单行输入框引用InputInstance["input"]
textarea多行输入框引用InputInstance["textarea"]
focus聚焦输入框InputInstance["focus"]
blur让输入框失焦InputInstance["blur"]
select选中当前文本InputInstance["select"]
clear清空当前值InputInstance["clear"]