mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-06-09 22:59:16 +08:00
390 lines
13 KiB
Markdown
390 lines
13 KiB
Markdown
# Field 输入框
|
||
|
||
### 介绍
|
||
|
||
用户可以在文本框内输入或编辑文字。
|
||
|
||
### 引入
|
||
|
||
通过以下方式来全局注册组件，更多注册方式请参考[组件注册](#/zh-CN/advanced-usage#zu-jian-zhu-ce)。
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
import { Field, CellGroup } from 'vant';
|
||
|
||
const app = createApp();
|
||
app.use(Field);
|
||
app.use(CellGroup);
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
### 基础用法
|
||
|
||
可以通过 `v-model` 双向绑定输入框的值，通过 `placeholder` 设置占位提示文字。
|
||
|
||
```html
|
||
<!-- 可以使用 CellGroup 作为容器 -->
|
||
<van-cell-group inset>
|
||
<van-field v-model="value" label="文本" placeholder="请输入用户名" />
|
||
</van-cell-group>
|
||
```
|
||
|
||
```js
|
||
import { ref } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const value = ref('');
|
||
return { value };
|
||
},
|
||
};
|
||
```
|
||
|
||
### 自定义类型
|
||
|
||
根据 `type` 属性定义不同类型的输入框，默认值为 `text`。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<!-- 输入任意文本 -->
|
||
<van-field v-model="state.text" label="文本" />
|
||
<!-- 输入手机号，调起手机号键盘 -->
|
||
<van-field v-model="state.tel" type="tel" label="手机号" />
|
||
<!-- 允许输入正整数，调起纯数字键盘 -->
|
||
<van-field v-model="state.digit" type="digit" label="整数" />
|
||
<!-- 允许输入数字，调起带符号的纯数字键盘 -->
|
||
<van-field v-model="state.number" type="number" label="数字" />
|
||
<!-- 输入密码 -->
|
||
<van-field v-model="state.password" type="password" label="密码" />
|
||
</van-cell-group>
|
||
```
|
||
|
||
```js
|
||
import { reactive } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const state = reactive({
|
||
tel: '',
|
||
text: '',
|
||
digit: '',
|
||
number: '',
|
||
password: '',
|
||
});
|
||
|
||
return { state };
|
||
},
|
||
};
|
||
```
|
||
|
||
### 禁用输入框
|
||
|
||
通过 `readonly` 将输入框设置为只读状态，通过 `disabled` 将输入框设置为禁用状态。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field label="文本" model-value="输入框只读" readonly />
|
||
<van-field label="文本" model-value="输入框已禁用" disabled />
|
||
</van-cell-group>
|
||
```
|
||
|
||
### 显示图标
|
||
|
||
通过 `left-icon` 和 `right-icon` 配置输入框两侧的图标，通过设置 `clearable` 在输入过程中展示清除图标。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="state.value1"
|
||
label="文本"
|
||
left-icon="smile-o"
|
||
right-icon="warning-o"
|
||
placeholder="显示图标"
|
||
/>
|
||
<van-field
|
||
v-model="state.value2"
|
||
clearable
|
||
label="文本"
|
||
left-icon="music-o"
|
||
placeholder="显示清除图标"
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
```js
|
||
import { reactive } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const state = reactive({
|
||
value1: '',
|
||
value2: '123',
|
||
});
|
||
|
||
return { state };
|
||
},
|
||
};
|
||
```
|
||
|
||
### 错误提示
|
||
|
||
设置 `required` 属性表示这是一个必填项，可以配合 `error` 或 `error-message` 属性显示对应的错误提示。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="username"
|
||
error
|
||
required
|
||
label="用户名"
|
||
placeholder="请输入用户名"
|
||
/>
|
||
<van-field
|
||
v-model="phone"
|
||
required
|
||
label="手机号"
|
||
placeholder="请输入手机号"
|
||
error-message="手机号格式错误"
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
### 插入按钮
|
||
|
||
通过 button 插槽可以在输入框尾部插入按钮。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="sms"
|
||
center
|
||
clearable
|
||
label="短信验证码"
|
||
placeholder="请输入短信验证码"
|
||
>
|
||
<template #button>
|
||
<van-button size="small" type="primary">发送验证码</van-button>
|
||
</template>
|
||
</van-field>
|
||
</van-cell-group>
|
||
```
|
||
|
||
### 格式化输入内容
|
||
|
||
通过 `formatter` 属性可以对输入的内容进行格式化，通过 `format-trigger` 属性可以指定执行格式化的时机，默认在输入时进行格式化。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="state.value1"
|
||
label="文本"
|
||
:formatter="formatter"
|
||
placeholder="在输入时执行格式化"
|
||
/>
|
||
<van-field
|
||
v-model="state.value2"
|
||
label="文本"
|
||
:formatter="formatter"
|
||
format-trigger="onBlur"
|
||
placeholder="在失焦时执行格式化"
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
```js
|
||
import { reactive } from 'vue';
|
||
|
||
export default {
|
||
setup() {
|
||
const state = reactive({
|
||
value1: '',
|
||
value2: '',
|
||
});
|
||
// 过滤输入的数字
|
||
const formatter = (value) => value.replace(/\d/g, '');
|
||
|
||
return {
|
||
state,
|
||
formatter,
|
||
};
|
||
},
|
||
};
|
||
```
|
||
|
||
### 高度自适应
|
||
|
||
对于 textarea，可以通过 `autosize` 属性设置高度自适应。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="message"
|
||
rows="1"
|
||
autosize
|
||
label="留言"
|
||
type="textarea"
|
||
placeholder="请输入留言"
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
### 显示字数统计
|
||
|
||
设置 `maxlength` 和 `show-word-limit` 属性后会在底部显示字数统计。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="message"
|
||
rows="2"
|
||
autosize
|
||
label="留言"
|
||
type="textarea"
|
||
maxlength="50"
|
||
placeholder="请输入留言"
|
||
show-word-limit
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
### 输入框内容对齐
|
||
|
||
通过 `input-align` 属性可以设置输入框内容的对齐方式，可选值为 `center`、`right`。
|
||
|
||
```html
|
||
<van-cell-group inset>
|
||
<van-field
|
||
v-model="value"
|
||
label="文本"
|
||
placeholder="输入框内容右对齐"
|
||
input-align="right"
|
||
/>
|
||
</van-cell-group>
|
||
```
|
||
|
||
## API
|
||
|
||
### Props
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| --- | --- | --- | --- |
|
||
| v-model | 当前输入的值 | _number \| string_ | - |
|
||
| label | 输入框左侧文本 | _string_ | - |
|
||
| name | 名称，提交表单的标识符 | _string_ | - |
|
||
| type | 输入框类型, 可选值为 `tel` `digit`<br>`number` `textarea` `password` 等 | _string_ | `text` |
|
||
| size | 大小，可选值为 `large` | _string_ | - |
|
||
| maxlength | 输入的最大字符数 | _number \| string_ | - |
|
||
| placeholder | 输入框占位提示文字 | _string_ | - |
|
||
| border | 是否显示内边框 | _boolean_ | `true` |
|
||
| disabled | 是否禁用输入框 | _boolean_ | `false` |
|
||
| readonly | 是否为只读状态，只读状态下无法输入内容 | _boolean_ | `false` |
|
||
| colon | 是否在 label 后面添加冒号 | _boolean_ | `false` |
|
||
| required | 是否显示表单必填星号 | _boolean_ | `false` |
|
||
| center | 是否使内容垂直居中 | _boolean_ | `false` |
|
||
| clearable | 是否启用清除图标，点击清除图标后会清空输入框 | _boolean_ | `false` |
|
||
| clear-icon `v3.0.12` | 清除[图标名称](#/zh-CN/icon)或图片链接 | _string_ | `clear` |
|
||
| clear-trigger | 显示清除图标的时机，`always` 表示输入框不为空时展示，<br>`focus` 表示输入框聚焦且不为空时展示 | _string_ | `focus` |
|
||
| clickable | 是否开启点击反馈 | _boolean_ | `false` |
|
||
| is-link | 是否展示右侧箭头并开启点击反馈 | _boolean_ | `false` |
|
||
| autofocus | 是否自动聚焦，iOS 系统不支持该属性 | _boolean_ | `false` |
|
||
| show-word-limit | 是否显示字数统计，需要设置 `maxlength` 属性 | _boolean_ | `false` |
|
||
| error | 是否将输入内容标红 | _boolean_ | `false` |
|
||
| error-message | 底部错误提示文案，为空时不展示 | _string_ | - |
|
||
| error-message-align | 错误提示文案对齐方式，可选值为 `center` `right` | _string_ | `left` |
|
||
| formatter | 输入内容格式化函数 | _(val: string) => string_ | - |
|
||
| format-trigger | 格式化函数触发的时机，可选值为 `onBlur` | _string_ | `onChange` |
|
||
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | _string_ | `right` |
|
||
| label-class | 左侧文本额外类名 | _string \| Array \| object_ | - |
|
||
| label-width | 左侧文本宽度，默认单位为 `px` | _number \| string_ | `6.2em` |
|
||
| label-align | 左侧文本对齐方式，可选值为 `center` `right` | _string_ | `left` |
|
||
| input-align | 输入框对齐方式，可选值为 `center` `right` | _string_ | `left` |
|
||
| autosize | 是否自适应内容高度，只对 textarea 有效，<br>可传入对象,如 { maxHeight: 100, minHeight: 50 }，<br>单位为`px` | _boolean \| object_ | `false` |
|
||
| left-icon | 左侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - |
|
||
| right-icon | 右侧[图标名称](#/zh-CN/icon)或图片链接 | _string_ | - |
|
||
| icon-prefix | 图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props) | _string_ | `van-icon` |
|
||
| rules | 表单校验规则，详见 [Form 组件](#/zh-CN/form#rule-shu-ju-jie-gou) | _Rule[]_ | - |
|
||
| autocomplete `v3.0.3` | input 标签原生的[自动完成属性](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) | _string_ | - |
|
||
|
||
### Events
|
||
|
||
| 事件 | 说明 | 回调参数 |
|
||
| ------------------ | -------------------- | ------------------------------ |
|
||
| update:model-value | 输入框内容变化时触发 | _value: string (当前输入的值)_ |
|
||
| focus | 输入框获得焦点时触发 | _event: Event_ |
|
||
| blur | 输入框失去焦点时触发 | _event: Event_ |
|
||
| clear | 点击清除按钮时触发 | _event: MouseEvent_ |
|
||
| click | 点击组件时触发 | _event: MouseEvent_ |
|
||
| click-input | 点击输入区域时触发 | _event: MouseEvent_ |
|
||
| click-left-icon | 点击左侧图标时触发 | _event: MouseEvent_ |
|
||
| click-right-icon | 点击右侧图标时触发 | _event: MouseEvent_ |
|
||
|
||
### 方法
|
||
|
||
通过 ref 可以获取到 Field 实例并调用实例方法，详见[组件实例方法](#/zh-CN/advanced-usage#zu-jian-shi-li-fang-fa)。
|
||
|
||
| 方法名 | 说明 | 参数 | 返回值 |
|
||
| ------ | -------------- | ---- | ------ |
|
||
| focus | 获取输入框焦点 | - | - |
|
||
| blur | 取消输入框焦点 | - | - |
|
||
|
||
### 类型定义
|
||
|
||
通过 `FieldInstance` 获取 Field 实例的类型定义。
|
||
|
||
```ts
|
||
import { ref } from 'vue';
|
||
import type { FieldInstance } from 'vant';
|
||
|
||
const fieldRef = ref<FieldInstance>();
|
||
|
||
fieldRef.value?.focus();
|
||
```
|
||
|
||
### Slots
|
||
|
||
| 名称 | 说明 |
|
||
| --- | --- |
|
||
| label | 自定义输入框左侧文本 |
|
||
| input | 自定义输入框，使用此插槽后，与输入框相关的属性和事件将失效。<br>在 Form 组件进行表单校验时，会使用 input 插槽中子组件的 `value`，而不是 Field 组件的 `value`。 |
|
||
| left-icon | 自定义输入框头部图标 |
|
||
| right-icon | 自定义输入框尾部图标 |
|
||
| button | 自定义输入框尾部按钮 |
|
||
| extra | 自定义输入框最右侧的额外内容 |
|
||
|
||
### 样式变量
|
||
|
||
组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
|
||
|
||
| 名称 | 默认值 | 描述 |
|
||
| ------------------------------------- | ------------------------- | ---- |
|
||
| --van-field-label-width | _6.2em_ | - |
|
||
| --van-field-label-color | _var(--van-gray-7)_ | - |
|
||
| --van-field-label-margin-right | _var(--van-padding-sm)_ | - |
|
||
| --van-field-input-text-color | _var(--van-text-color)_ | - |
|
||
| --van-field-input-error-text-color | _var(--van-danger-color)_ | - |
|
||
| --van-field-input-disabled-text-color | _var(--van-gray-5)_ | - |
|
||
| --van-field-placeholder-text-color | _var(--van-gray-5)_ | - |
|
||
| --van-field-icon-size | _16px_ | - |
|
||
| --van-field-clear-icon-size | _16px_ | - |
|
||
| --van-field-clear-icon-color | _var(--van-gray-5)_ | - |
|
||
| --van-field-right-icon-color | _var(--van-gray-6)_ | - |
|
||
| --van-field-error-message-color | _var(--van-danger-color)_ | - |
|
||
| --van-field-error-message-text-color | _12px_ | - |
|
||
| --van-field-text-area-min-height | _60px_ | - |
|
||
| --van-field-word-limit-color | _var(--van-gray-7)_ | - |
|
||
| --van-field-word-limit-font-size | _var(--van-font-size-sm)_ | - |
|
||
| --van-field-word-limit-line-height | _16px_ | - |
|
||
| --van-field-disabled-text-color | _var(--van-gray-5)_ | - |
|
||
| --van-field-required-mark-color | _var(--van-red)_ | - |
|
||
|
||
## 常见问题
|
||
|
||
### 设置 type 为 number 后，为什么 input 标签的类型仍为 text?
|
||
|
||
HTML 原生的 `type="number"` 属性在 iOS 和 Android 系统上都存在一定问题，比如 maxlength 属性不生效、无法获取到完整的输入内容等。因此设置 type 为 `number` 时，Field 不会使用原生的 `type="number"` 属性，而是用现代浏览器支持的 [inputmode 属性](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Global_attributes/inputmode)来控制输入键盘的类型。
|
||
|
||
### 在桌面端点击清除按钮无效？
|
||
|
||
清除按钮监听是的移动端 Touch 事件，参见[桌面端适配](#/zh-CN/advanced-usage#zhuo-mian-duan-gua-pei)。
|