Skip to content
On this page

Input 输入框

通过鼠标或键盘输入字符

基础文本框

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('')
</script>
<template>
  <Input v-model="test" placeholder="基础文本框,请输入" />
  <span>{{test}}</span>
</template>

禁用文本框

通过 disabled 属性指定是否禁用 input 组件

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('some text')
</script>
<template>
  <Input v-model="test" disabled />
</template>

尺寸

使用 size 属性改变输入框大小。 除了默认大小外,还有另外两个选项: large, small

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('')
</script>
<template>
  <div class="size-holder">
    <Input v-model="test" placeholder="大的 Input" size="large">
    </Input>
    <Input v-model="test" placeholder="普通的 Input">
    </Input>
    <Input v-model="test" placeholder="小的 Input" size="small">
    </Input>
  </div>
</template>
<style scoped>
.size-holder {
  display: flex;
  align-items: center;
}
</style>

复合型输入框

可以在输入框前置或后置一个元素,通常是标签或按钮。可以使用 prependappend 插槽。 要在输入框中添加前后元素,可以使用 prefixsuffix 插槽。

Https://
.com
<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
import Icon from '@/components/Icon/Icon.vue'
const test = ref('')
</script>
<template>
  <Input v-model="test" placeholder="prepend append">
    <template #prepend>Https://</template>
    <template #append>.com</template>
  </Input>

  <Input v-model="test" placeholder="prefix suffix">
    <template #prefix>
      <Icon icon="fa-user" />
    </template>
    <template #suffix>
      <Icon icon="fa-user" />
    </template>
  </Input>
</template>

Textarea

用于输入多行文本信息可缩放的输入框。 添加 type="textarea" 属性来将 input 元素转换为原生的 textarea 元素。

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('')
</script>
<template>
  <Input v-model="test" placeholder="可以是一个 Textarea" type="textarea">
  </Input>
</template>

密码文本框

使用 show-password 属性即可得到一个可切换显示隐藏的密码框

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('')
</script>
<template>
  <Input v-model="test" placeholder="密码文本框,可以切换" showPassword/>
</template>

清空文本框

使用 clearable 属性即可得到一个可一键清空的输入框

<script setup>
import { ref } from 'vue'
import Input from '@/components/Input/Input.vue'
const test = ref('')
</script>
<template>
  <Input v-model="test" clearable placeholder="输入字符以后可以点击清空"/>
</template>

API

属性

NameDescriptionTypeDefault
typeinput 原生类型'string'text
model-value / v-model绑定值'string'
disabled是否禁用booleanfalse
placeholder输入框占位文本string
size输入框尺寸,只在 type 不为 'textarea' 时有效'large' | 'small'
placeholder输入框占位文本string
show-password是否显示切换密码图标booleanfalse
clearable是否显示清除按钮booleanfalse
readonly原生 readonly 属性,是否只读booleanfalse
autofocus原生属性,自动获取焦点booleanfalse
autocomplete原生 autocomplete 属性stringoff

事件

NameDescriptionType
blur当选择器的输入框失去焦点时触发(e: FocusEvent) => void
focus当选择器的输入框获得焦点时触发(e: FocusEvent) => void
change当选择器的输入框失去焦点时触发(e: string) => void
input当选择器的输入框获得焦点时触发(e: string) => void
clear在点击由 clearable 属性生成的清空按钮时触发()=>void

Slots

NameDescription
prefix输入框头部内容
suffix输入框尾部内容
prepend输入框前置内容
append输入框后置内容

Exposes

NameDescriptionType
refHTML元素 input 或 textareaRef<HTMLInputElement | HTMLTextAreaElement>