Skip to content

Input 输入框

用于在表单中输入文本信息。

引入

通过 easycom 自动引入,无需手动注册。

代码演示

基础用法

通过 v-model 绑定输入框的值,通过 placeholder 设置占位提示文字。

html
<zq-input v-model="value" placeholder="请输入" />
js
const value = ref('')

带标签

通过 label 属性设置左侧标签文字。

html
<zq-input v-model="value" label="用户名" placeholder="请输入用户名" />

可清除

通过 clearable 属性启用清除按钮,输入框有内容时显示清除图标。

html
<zq-input v-model="value" label="标题" placeholder="可清除" clearable />

密码输入

通过 password 属性设置为密码输入框。

html
<zq-input v-model="value" label="密码" placeholder="请输入密码" password />

禁用状态

通过 disabled 属性禁用输入框。

html
<zq-input v-model="value" label="标题" placeholder="禁用状态" disabled />

只读状态

通过 readonly 属性设置为只读。

html
<zq-input v-model="value" label="标题" readonly />

前缀/后缀图标

通过 prefix-iconsuffix-icon 属性设置输入框前后的图标。

html
<zq-input v-model="value" prefix-icon="search" placeholder="搜索" clearable />
<zq-input v-model="value" suffix-icon="eye" placeholder="后缀图标" />

前缀/后缀插槽

通过 prefixsuffix 插槽自定义输入框前后内容。

html
<zq-input v-model="value" placeholder="请输入">
  <template #prefix>
    <text>https://</text>
  </template>
  <template #suffix>
    <text>.com</text>
  </template>
</zq-input>

必填标记

通过 required 属性在标签前显示必填星号。

html
<zq-input v-model="value" label="姓名" placeholder="必填" required />

错误状态

通过 error 属性标记错误状态,通过 error-message 显示错误提示。

html
<zq-input v-model="value" label="手机号" error error-message="请输入正确的手机号" />

输入对齐

通过 input-align 属性设置输入内容的对齐方式。

html
<zq-input v-model="value" label="标题" input-align="center" placeholder="居中" />
<zq-input v-model="value" label="标题" input-align="right" placeholder="右对齐" />

标签宽度

通过 label-width 属性设置标签宽度。

html
<zq-input v-model="value" label="长标签文字" label-width="240rpx" placeholder="请输入" />

自定义标签

通过 label 插槽自定义标签内容。

html
<zq-input v-model="value" placeholder="请输入">
  <template #label>
    <zq-icon name="user" :size="16" />
    <text style="margin-left: 8rpx;">用户</text>
  </template>
</zq-input>

API

Props

参数说明类型默认值
v-model输入框的值string | number''
type输入框类型string'text'
label左侧标签文字string''
placeholder占位提示文字string''
disabled是否禁用booleanfalse
readonly是否只读booleanfalse
clearable是否启用清除按钮booleanfalse
maxlength最大输入长度,-1 为不限制number-1
prefix-icon前缀图标名称string''
suffix-icon后缀图标名称string''
border是否显示下边框booleantrue
required是否显示必填星号booleanfalse
error是否标记为错误状态booleanfalse
error-message错误提示文字string''
input-align输入内容对齐方式'left' | 'center' | 'right''left'
label-width标签宽度string'180rpx'
focus是否自动聚焦booleanfalse
password是否为密码类型booleanfalse
confirm-type键盘右下角按钮类型string'done'

Events

事件名说明回调参数
update:modelValue输入框内容变化时触发value: string
input输入时触发value: string
focus聚焦时触发event: Event
blur失焦时触发event: Event
clear点击清除按钮时触发-
confirm点击键盘确认按钮时触发event: Event

Slots

名称说明
label自定义左侧标签
prefix自定义输入框前缀
suffix自定义输入框后缀

主题定制

变量名说明
--color-bg-card输入框背景色
--color-divider下边框颜色
--color-text-primary输入文字颜色
--color-text-secondary图标颜色
--color-text-placeholder占位文字颜色
--color-error错误状态颜色

Released under the MIT License.