跳转到内容

输入框 Input

输入框的基本用法。

通过 input-group 可以组合使用输入框。

用于输入密码。

通过指定 prefixsuffix 插槽来在输入框内添加前缀和后缀。

通过指定 prependappend 插槽在输入框前后添加元素。

自定义搜索按钮的内容

通过 loading 属性可以让搜索框展示加载中状态。

带有搜索按钮的输入框,用于内容检索。

输入框定义了四种默认尺寸 mini, small, medium, large ,分别为 24px, 28px, 32px, 36px

输入框可以设置禁用和错误状态。

设置 max-length 可以限制最大字数,配合 show-word-limit 可以显示字数统计。

设置 fit-width 后,组件按照“当前显示内容 → placeholder → 组件默认宽度”的顺序决定文字宽度,再加上组件自身的 padding、border、前后缀、图标等设计宽度。实际文字和 placeholder 使用当前控件的真实字体测量;默认宽度使用 CSS ch 单位。

max-w-full 默认是 true,会给组件设置 max-width: 100%,因此内容很长时不会撑破父容器。需要允许组件超过父容器时可以显式设置 :max-w-full="false"

在 JsonForm 中无需设置表单级配置,直接在单个 schema 的 componentProps 中传入这两个属性即可。

组件 没有内容且没有 placeholder 时
Input、InputPassword、InputSearch、AutoComplete、InputTag、Select、Cascader、TreeSelect、Mention(input) 4ch
InputNumber 2ch
Textarea、Mention(textarea) 12ch
DatePicker 当前日期格式的字符数;默认 YYYY-MM-DD10ch,开启时间后按完整格式计算
RangePicker 每一端分别按当前日期格式计算,分隔符仍按组件设计宽度参与布局
TimePicker 当前时间格式的字符数;默认 HH:mm:ss8ch,范围模式分别计算两端

Checkbox、CheckboxGroup、Radio、RadioGroup、Rate、Switch、Slider、Transfer、VerificationCode,以及 JsonForm 的 rownoFormItem 不提供这两个属性:它们的宽度由离散选项、轨道、布局容器或自身业务结构决定,不属于文本输入宽度。

参数名 描述 类型 默认值 版本
model-value (v-model) 绑定值 string -
default-value 默认值(非受控状态) string ''
size 输入框大小 'mini' | 'small' | 'medium' | 'large' 'medium'
allow-clear 是否允许清空输入框 boolean false
disabled 是否禁用 boolean false
readonly 是否为只读状态 boolean false
error 是否为错误状态 boolean false
placeholder 提示文字 string -
fit-width 宽度是否适应文字内容 boolean false
max-w-full 最大宽度是否限制为父容器宽度 boolean true
max-length 输入值的最大长度,errorOnly 属性在 2.12.0 版本添加 number | { length: number; errorOnly?: boolean } 0
show-word-limit 是否显示字数统计 boolean false
word-length 字符长度的计算方法 (value: string) => number -
word-slice 字符截取方法,同 wordLength 一起使用 (value: string, maxLength: number) => string - 2.12.0
input-attrs 内部 input 元素的属性 object - 2.27.0
prepend 前置标签 string - 2.57.0
append 后置标签 string - 2.57.0
事件名 描述 参数
input 用户输入时触发 value: string
ev: Event
change 仅在输入框失焦或按下回车时触发 value: string
ev: Event
press-enter 用户按下回车时触发 ev: KeyboardEvent
clear 用户点击清除按钮时触发 ev: MouseEvent
focus 输入框获取焦点时触发 ev: FocusEvent
blur 输入框失去焦点时触发 ev: FocusEvent
方法名 描述 参数 返回值
focus 使输入框获取焦点 - -
blur 使输入框失去焦点 - -
插槽名 描述 参数
append 后置标签 -
prepend 前置标签 -
suffix 后缀元素 -
prefix 前缀元素 -
参数名 描述 类型 默认值
visibility (v-model) 是否可见,受控属性 boolean -
default-visibility 默认是否可见,非受控 boolean true
invisible-button 是否显示可见按钮 boolean true
fit-width 宽度是否适应文字内容 boolean false
max-w-full 最大宽度是否限制为父容器宽度 boolean true
事件名 描述 参数
visibility-change visibility 改变时触发 visible: boolean
参数名 描述 类型 默认值 版本
search-button 是否为后置按钮模式 boolean false
loading 是否为加载中状态 boolean false
disabled 是否禁用 boolean false
size 输入框大小 'mini' | 'small' | 'medium' | 'large' 'medium'
button-text 搜索按钮的文字,使用后会替换原本的图标 string - 2.16.0
button-props 搜索按钮的属性 ButtonProps -
fit-width 宽度是否适应文字内容 boolean false
max-w-full 最大宽度是否限制为父容器宽度 boolean true
事件名 描述 参数
search 单击搜索按钮时触发 value: string
ev: MouseEvent