# FxInput 输入框
移动端与PC端交互方式不同,故参数变动较多,移动端请直接参考底部移动端使用方式
通过鼠标或键盘输入字符
WARNING
Input 为受控组件,它总会显示 Vue 绑定值。
通常情况下,应当处理 input
事件,并更新组件的绑定值(或使用v-model
)。否则,输入框内显示的值将不会改变。
不支持 v-model
修饰符。
# 基础用法
小数位数decimalPlaces默认是2。
复制代码
# 输入值以tag方式显示
复制代码
# 禁用状态
复制代码
# 可清空
复制代码
# 密码框
复制代码
# 带 icon 的输入框
带有图标标记输入类型
属性方式:
slot 方式:
复制代码
# 文本域
用于输入多行文本信息,通过将 type
属性的值指定为 textarea。
复制代码
# 可自适应文本高度的文本域
通过设置 autosize
属性可以使得文本域的高度能够根据文本内容自动进行调整,并且 autosize
还可以设定为一个对象,指定最小行数和最大行数。
复制代码
# 复合型输入框
可前置或后置元素,一般为标签或按钮
复制代码
# 尺寸
复制代码
# 带输入建议
根据输入内容提供对应的输入建议
激活即列出输入建议
输入后匹配输入建议
复制代码
# 自定义模板
可自定义输入建议的显示
复制代码
# 远程搜索
从服务端搜索数据
复制代码
# 输入长度限制
复制代码
# Input Attributes
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
type | 类型 | string | text,textarea 和其他 原生 input 的 type 值 (opens new window) | text |
value / v-model | 绑定值。 当collapse-tags为true时,值为数组 | string / number/array | — | — |
maxlength | 原生属性,最大输入长度 | number | — | — |
minlength | 原生属性,最小输入长度 | number | — | — |
show-word-limit | 是否显示输入字数统计,只在 type = "text" 或 type = "textarea" 时有效 | boolean | — | false |
placeholder | 输入框占位文本 | string | — | — |
clearable | 是否可清空 | boolean | — | false |
show-password | 是否显示切换密码图标 | boolean | — | false |
disabled | 禁用 | boolean | — | false |
size | 输入框尺寸,只在 type!="textarea" 时有效 | string | medium / small / mini | — |
prefix-icon | 输入框头部图标 | string | — | — |
suffix-icon | 输入框尾部图标 | string | — | — |
rows | 输入框行数,只对 type="textarea" 有效 | number | — | 2 |
autosize | 自适应内容高度,只对 type="textarea" 有效,可传入对象,如,{ minRows: 2, maxRows: 6 } | boolean / object | — | false |
autocomplete | 原生属性,自动补全 | string | on, off | off |
auto-complete | 下个主版本弃用 | string | on, off | off |
name | 原生属性 | string | — | — |
readonly | 原生属性,是否只读 | boolean | — | false |
max | 原生属性,设置最大值 | — | — | — |
min | 原生属性,设置最小值 | — | — | — |
step | 原生属性,设置输入字段的合法数字间隔 | — | — | — |
resize | 控制是否能被用户缩放 | string | none, both, horizontal, vertical | — |
autofocus | 原生属性,自动获取焦点 | boolean | true, false | false |
form | 原生属性 | string | — | — |
label | 输入框关联的label文字 | string | — | — |
tabindex | 输入框的tabindex | string | - | - |
validate-event | 输入时是否触发表单的校验 | boolean | - | true |
collapse-tags | 设置为true后,输入值以tag方式显示,值为数组 | boolean | - | false |
is-blur-fold | 设置collapse-tags为true后,设置此值为true,则输入框失去焦点后折叠起来,false为不折叠 | boolean | - | true |
validate-when-input | 输入时触发表单的校验 | boolean | - | true |
validate-when-blur | 失去焦点时触发表单的校验 | boolean | - | false |
# Input Slots
name | 说明 |
---|---|
prefix | 输入框头部内容,只对 type="text" 有效 |
suffix | 输入框尾部内容,只对 type="text" 有效 |
prepend | 输入框前置内容,只对 type="text" 有效 |
append | 输入框后置内容,只对 type="text" 有效 |
# Input Events
事件名称 | 说明 | 回调参数 |
---|---|---|
blur | 在 Input 失去焦点时触发 | (event: Event) |
focus | 在 Input 获得焦点时触发 | (event: Event) |
change | 在 Input 值改变时触发 | (value: string | number) |
clear | 在点击由 clearable 属性生成的清空按钮时触发 | — |
# Input Methods
方法名 | 说明 | 参数 |
---|---|---|
focus | 使 input 获取焦点 | — |
blur | 使 input 失去焦点 | — |
select | 选中 input 中的文字 | — |
# Autocomplete Attributes
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
placeholder | 输入框占位文本 | string | — | — |
disabled | 禁用 | boolean | — | false |
value-key | 输入建议对象中用于显示的键名 | string | — | value |
value | 必填值,输入绑定值 | string | — | — |
debounce | 获取输入建议的去抖延时 | number | — | 300 |
placement | 菜单弹出位置 | string | top / top-start / top-end / bottom / bottom-start / bottom-end | bottom-start |
fetch-suggestions | 返回输入建议的方法,仅当您的输入建议数据 resolve 时,通过调用 callback(data:[]) 来返回它 | Function(queryString, callback) | — | — |
popper-class | Autocomplete 下拉列表的类名 | string | — | — |
trigger-on-focus | 是否在输入框 focus 时显示建议列表 | boolean | — | true |
name | 原生属性 | string | — | — |
select-when-unmatched | 在输入没有任何匹配建议的情况下,按下回车是否触发 select 事件 | boolean | — | false |
label | 输入框关联的label文字 | string | — | — |
prefix-icon | 输入框头部图标 | string | — | — |
suffix-icon | 输入框尾部图标 | string | — | — |
hide-loading | 是否隐藏远程加载时的加载图标 | boolean | — | false |
popper-append-to-body | 是否将下拉列表插入至 body 元素。在下拉列表的定位出现问题时,可将该属性设置为 false | boolean | - | true |
highlight-first-item | 是否默认突出显示远程搜索建议中的第一项 | boolean | — | false |
# Autocomplete Slots
name | 说明 |
---|---|
prefix | 输入框头部内容 |
suffix | 输入框尾部内容 |
prepend | 输入框前置内容 |
append | 输入框后置内容 |
# Autocomplete Scoped Slot
name | 说明 |
---|---|
— | 自定义输入建议,参数为 { item } |
# Autocomplete Events
事件名称 | 说明 | 回调参数 |
---|---|---|
select | 点击选中建议项时触发 | 选中建议项 |
# Autocomplete Methods
方法名 | 说明 | 参数 |
---|---|---|
focus | 使 input 获取焦点 | - |
# 移动端 输入框
# 使用指南
# 基础用法
<template>
<fx-input
v-model="value"
label="label"
></fx-input>
</template>
# input类型自定义
支持所有input原生类型,包括textarea
textarea
类型下支持显示字数:
<template>
<fx-input
v-model="value"
label="label"
type="textarea"
:maxlength="1000"
></fx-input>
</template>
支持监听input的原生事件:
<template>
<fx-input
v-model="value"
label="label"
type="number"
@input="onInput"
@focus="onFocus"
@blur="onBlur"
@keypress="onKeypress"
></fx-input>
</template>
# action模式
action模式就是带点击反馈且不可输入的field,该模式下支持监听click
事件。
<template>
<fx-input
v-model="value"
mode="action"
label="label"
@click="onClick"
></fx-input>
</template>
# 禁用和只读
<template>
<fx-input
v-model="value"
label="只读/禁用"
readonly
disabled
></fx-input>
</template>
# 错误提示
传入的errMsg
不为空时,就会显示错误提示。
<template>
<fx-input
v-model="value"
label="密码"
type="password"
errMsg="密码错误"
></fx-input>
</template>
# 自定义扩展
<template>
<fx-input v-model="value">
<div slot="label">
<span class="dta-icon-font__waiting"></span>
自定义
</div>
<div slot="floot">
<span class="dta-icon-font__question"></span>
</div>
</fx-input>
</template>
# API
option | description | type | acceptable values | default |
---|---|---|---|---|
v-model | 值 | String | -- | |
label | 左侧标签 | String|Number | -- | |
placeholder | 占位符内容 | String | input 模式下默认为请输入 ,action 模式下默认为请选择 | |
mode | field模式 | String | action , input | input |
type | 输入框类型,支持所有input原生类型 | String | text , textarea , number 等 | text |
clearable | 是否展示清除按钮 | Boolean | true | |
readonly | 是否只读 | Boolean | false | |
disabled | 是否禁用 | Boolean | false | |
required | 是否必填 | Boolean | false | |
errMsg | 错误信息 | String | -- | |
maxlength | 允许输入的最大长度 | Number | -- | |
showCount | textarea 类型下是否展示字数 | Boolean | true |
# Events
Event | description | params |
---|---|---|
click | 点击cell时 | event |
input
模式下,支持input标签的所有原生事件,如focus
、blur
等等
# Slots
name | description |
---|---|
label | 左侧标签 |
floot | 尾部自定义block |