vant/docs/examples-docs/en-US/field.md

Field

Install

import { Field } from 'vant';

Vue.component(Field.name, Field);

Usage

Basic Usage

The value of filed is bound with v-model.

:::demo Basic Usage

<van-cell-group>
  <van-field v-model="value" placeholder="Username"></van-field>
</van-cell-group>

:::

Custom Type

Use type prop to custom diffrent type fileds.

:::demo Custom Type

<van-cell-group>
  <van-field
    v-model="username"
    label="Username"
    icon="clear"
    placeholder="Username"
    required
    @click-icon="username = ''"
  >
  </van-field>

  <van-field
    v-model="password"
    type="password"
    label="Password"
    placeholder="Password"
    required>
  </van-field>
</van-cell-group>

:::

Disabled

:::demo Disabled

<van-cell-group>
  <van-field value="Disabled" label="Username" disabled></van-field>
</van-cell-group>

:::

Error Info

:::demo Error Info

<van-cell-group>
  <van-field label="Username" placeholder="Username" error></van-field>
</van-cell-group>

:::

Auto resize

Textarea Filed can be auto resize when has autosize prop

:::demo Auto resize

<van-cell-group>
  <van-field
    v-model="message"
    label="Message"
    type="textarea"
    placeholder="Message"
    rows="1"
    autosize
  >
  </van-field>
</van-cell-group>

:::

API

Attribute	Description	Type	Default	Accepted Values
type	Filed type	String	text	number email textarea tel datetime date password url
value	Filed value	String	-	-
label	Filed label	String	-	-
disabled	Disable field	Boolean	false	-
error	Whether to show error info	Boolean	false	-
autosize	Textarea auto resize	Boolean	false	-
icon	Right side Icon name	String	-	-

Event

Event	Description	Parameters
focus	Triggered when filed get focused	-
blur	Triggered when blur filed	-
click-icon	Triggered when click the icon of filed	-

Slot

name	Description
icon	Custom icon