import{o as a,a as n,y as l}from"./vue-libs.b44bc779.js";const t={class:"van-doc-markdown-body"},p=l(`
\u7528\u4E8E\u6570\u636E\u5F55\u5165\u3001\u6821\u9A8C\uFF0C\u652F\u6301\u8F93\u5165\u6846\u3001\u5355\u9009\u6846\u3001\u590D\u9009\u6846\u3001\u6587\u4EF6\u4E0A\u4F20\u7B49\u7C7B\u578B\uFF0C\u9700\u8981\u4E0E Field \u8F93\u5165\u6846 \u7EC4\u4EF6\u642D\u914D\u4F7F\u7528\u3002
\u901A\u8FC7\u4EE5\u4E0B\u65B9\u5F0F\u6765\u5168\u5C40\u6CE8\u518C\u7EC4\u4EF6\uFF0C\u66F4\u591A\u6CE8\u518C\u65B9\u5F0F\u8BF7\u53C2\u8003\u7EC4\u4EF6\u6CE8\u518C\u3002
import { createApp } from 'vue';
import { Form, Field, CellGroup } from 'vant';
const app = createApp();
app.use(Form);
app.use(Field);
app.use(CellGroup);
\u5728\u8868\u5355\u4E2D\uFF0C\u6BCF\u4E2A Field \u7EC4\u4EF6 \u4EE3\u8868\u4E00\u4E2A\u8868\u5355\u9879\uFF0C\u4F7F\u7528 Field \u7684 rules
\u5C5E\u6027\u5B9A\u4E49\u6821\u9A8C\u89C4\u5219\u3002
<van-form @submit="onSubmit">
<van-cell-group inset>
<van-field
v-model="username"
name="\u7528\u6237\u540D"
label="\u7528\u6237\u540D"
placeholder="\u7528\u6237\u540D"
:rules="[{ required: true, message: '\u8BF7\u586B\u5199\u7528\u6237\u540D' }]"
/>
<van-field
v-model="password"
type="password"
name="\u5BC6\u7801"
label="\u5BC6\u7801"
placeholder="\u5BC6\u7801"
:rules="[{ required: true, message: '\u8BF7\u586B\u5199\u5BC6\u7801' }]"
/>
</van-cell-group>
<div style="margin: 16px;">
<van-button round block type="primary" native-type="submit">
\u63D0\u4EA4
</van-button>
</div>
</van-form>
import { ref } from 'vue';
export default {
setup() {
const username = ref('');
const password = ref('');
const onSubmit = (values) => {
console.log('submit', values);
};
return {
username,
password,
onSubmit,
};
},
};
\u901A\u8FC7 rules
\u5B9A\u4E49\u8868\u5355\u6821\u9A8C\u89C4\u5219\uFF0C\u6240\u6709\u53EF\u7528\u5B57\u6BB5\u89C1\u4E0B\u65B9\u8868\u683C\u3002
<van-form @failed="onFailed">
<van-cell-group inset>
<!-- \u901A\u8FC7 pattern \u8FDB\u884C\u6B63\u5219\u6821\u9A8C -->
<van-field
v-model="value1"
name="pattern"
placeholder="\u6B63\u5219\u6821\u9A8C"
:rules="[{ pattern, message: '\u8BF7\u8F93\u5165\u6B63\u786E\u5185\u5BB9' }]"
/>
<!-- \u901A\u8FC7 validator \u8FDB\u884C\u51FD\u6570\u6821\u9A8C -->
<van-field
v-model="value2"
name="validator"
placeholder="\u51FD\u6570\u6821\u9A8C"
:rules="[{ validator, message: '\u8BF7\u8F93\u5165\u6B63\u786E\u5185\u5BB9' }]"
/>
<!-- \u901A\u8FC7 validator \u8FD4\u56DE\u9519\u8BEF\u63D0\u793A -->
<van-field
v-model="value3"
name="validatorMessage"
placeholder="\u6821\u9A8C\u51FD\u6570\u8FD4\u56DE\u9519\u8BEF\u63D0\u793A"
:rules="[{ validator: validatorMessage }]"
/>
<!-- \u901A\u8FC7 validator \u8FDB\u884C\u5F02\u6B65\u51FD\u6570\u6821\u9A8C -->
<van-field
v-model="value4"
name="asyncValidator"
placeholder="\u5F02\u6B65\u51FD\u6570\u6821\u9A8C"
:rules="[{ validator: asyncValidator, message: '\u8BF7\u8F93\u5165\u6B63\u786E\u5185\u5BB9' }]"
/>
</van-cell-group>
<div style="margin: 16px;">
<van-button round block type="primary" native-type="submit">
\u63D0\u4EA4
</van-button>
</div>
</van-form>
import { ref } from 'vue';
import { Toast } from 'vant';
export default {
setup() {
const value1 = ref('');
const value2 = ref('');
const value3 = ref('abc');
const value4 = ref('');
const pattern = /\\d{6}/;
// \u6821\u9A8C\u51FD\u6570\u8FD4\u56DE true \u8868\u793A\u6821\u9A8C\u901A\u8FC7\uFF0Cfalse \u8868\u793A\u4E0D\u901A\u8FC7
const validator = (val) => /1\\d{10}/.test(val);
// \u6821\u9A8C\u51FD\u6570\u53EF\u4EE5\u76F4\u63A5\u8FD4\u56DE\u4E00\u6BB5\u9519\u8BEF\u63D0\u793A
const validatorMessage = (val) => \`\${val} \u4E0D\u5408\u6CD5\uFF0C\u8BF7\u91CD\u65B0\u8F93\u5165\`;
// \u6821\u9A8C\u51FD\u6570\u53EF\u4EE5\u8FD4\u56DE Promise\uFF0C\u5B9E\u73B0\u5F02\u6B65\u6821\u9A8C
const asyncValidator = (val) =>
new Promise((resolve) => {
Toast.loading('\u9A8C\u8BC1\u4E2D...');
setTimeout(() => {
Toast.clear();
resolve(val === '1234');
}, 1000);
});
const onFailed = (errorInfo) => {
console.log('failed', errorInfo);
};
return {
value1,
value2,
value3,
value4,
pattern,
onFailed,
validator,
asyncValidator,
};
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Switch \u7EC4\u4EF6\u3002
<van-field name="switch" label="\u5F00\u5173">
<template #input>
<van-switch v-model="checked" size="20" />
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const checked = ref(false);
return { checked };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Checkbox \u7EC4\u4EF6\u3002
<van-field name="checkbox" label="\u590D\u9009\u6846">
<template #input>
<van-checkbox v-model="checked" shape="square" />
</template>
</van-field>
<van-field name="checkboxGroup" label="\u590D\u9009\u6846\u7EC4">
<template #input>
<van-checkbox-group v-model="groupChecked" direction="horizontal">
<van-checkbox name="1" shape="square">\u590D\u9009\u6846 1</van-checkbox>
<van-checkbox name="2" shape="square">\u590D\u9009\u6846 2</van-checkbox>
</van-checkbox-group>
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const checked = ref(false);
const groupChecked = ref([]);
return {
checked,
groupChecked,
};
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Radio \u7EC4\u4EF6\u3002
<van-field name="radio" label="\u5355\u9009\u6846">
<template #input>
<van-radio-group v-model="checked" direction="horizontal">
<van-radio name="1">\u5355\u9009\u6846 1</van-radio>
<van-radio name="2">\u5355\u9009\u6846 2</van-radio>
</van-radio-group>
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const checked = ref('1');
return { checked };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Stepper \u7EC4\u4EF6\u3002
<van-field name="stepper" label="\u6B65\u8FDB\u5668">
<template #input>
<van-stepper v-model="value" />
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const value = ref(1);
return { value };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Rate \u7EC4\u4EF6\u3002
<van-field name="rate" label="\u8BC4\u5206">
<template #input>
<van-rate v-model="value" />
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const value = ref(3);
return { value };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Slider \u7EC4\u4EF6\u3002
<van-field name="slider" label="\u6ED1\u5757">
<template #input>
<van-slider v-model="value" />
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const value = ref(50);
return { value };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Uploader \u7EC4\u4EF6\u3002
<van-field name="uploader" label="\u6587\u4EF6\u4E0A\u4F20">
<template #input>
<van-uploader v-model="value" />
</template>
</van-field>
import { ref } from 'vue';
export default {
setup() {
const value = ref([
{ url: 'https://fastly.jsdelivr.net/npm/@vant/assets/leaf.jpeg' },
]);
return { value };
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Picker \u7EC4\u4EF6\u3002
<van-field
v-model="result"
is-link
readonly
name="picker"
label="\u9009\u62E9\u5668"
placeholder="\u70B9\u51FB\u9009\u62E9\u57CE\u5E02"
@click="showPicker = true"
/>
<van-popup v-model:show="showPicker" position="bottom">
<van-picker
:columns="columns"
@confirm="onConfirm"
@cancel="showPicker = false"
/>
</van-popup>
import { ref } from 'vue';
export default {
setup() {
const result = ref('');
const showPicker = ref(false);
const columns = ['\u676D\u5DDE', '\u5B81\u6CE2', '\u6E29\u5DDE', '\u5609\u5174', '\u6E56\u5DDE'];
const onConfirm = (value) => {
result.value = value;
showPicker.value = false;
};
return {
result,
columns,
onConfirm,
showPicker,
};
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 DatetimePicker \u7EC4\u4EF6\u3002
<van-field
v-model="result"
is-link
readonly
name="datetimePicker"
label="\u65F6\u95F4\u9009\u62E9"
placeholder="\u70B9\u51FB\u9009\u62E9\u65F6\u95F4"
@click="showPicker = true"
/>
<van-popup v-model:show="showPicker" position="bottom">
<van-datetime-picker
type="time"
@confirm="onConfirm"
@cancel="showPicker = false"
/>
</van-popup>
import { ref } from 'vue';
export default {
setup() {
const result = ref('');
const showPicker = ref(false);
const onConfirm = (value) => {
result.value = value;
showPicker.value = false;
};
return {
result,
onConfirm,
showPicker,
};
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Area \u7EC4\u4EF6\u3002
<van-field
v-model="result"
is-link
readonly
name="area"
label="\u5730\u533A\u9009\u62E9"
placeholder="\u70B9\u51FB\u9009\u62E9\u7701\u5E02\u533A"
@click="showArea = true"
/>
<van-popup v-model:show="showArea" position="bottom">
<van-area
:area-list="areaList"
@confirm="onConfirm"
@cancel="showArea = false"
/>
</van-popup>
import { ref } from 'vue';
import { areaList } from '@vant/area-data';
export default {
setup() {
const result = ref('');
const showArea = ref(false);
const onConfirm = (areaValues) => {
showArea.value = false;
result.value = areaValues
.filter((item) => !!item)
.map((item) => item.name)
.join('/');
};
return {
result,
areaList,
showArea,
onConfirm,
};
},
};
\u5728\u8868\u5355\u4E2D\u4F7F\u7528 Calendar \u7EC4\u4EF6\u3002
<van-field
v-model="value"
is-link
readonly
name="calendar"
label="\u65E5\u5386"
placeholder="\u70B9\u51FB\u9009\u62E9\u65E5\u671F"
@click="showCalendar = true"
/>
<van-calendar v-model:show="showCalendar" @confirm="onConfirm" />
import { ref } from 'vue';
export default {
setup() {
const result = ref('');
const showCalendar = ref(false);
const onConfirm = (date) => {
result.value = \`\${date.getMonth() + 1}/\${date.getDate()}\`;
showCalendar.value = false;
};
return {
result,
onConfirm,
showCalendar,
};
},
};
\u53C2\u6570 | \u8BF4\u660E | \u7C7B\u578B | \u9ED8\u8BA4\u503C |
---|---|---|---|
label-width | \u8868\u5355\u9879 label \u5BBD\u5EA6\uFF0C\u9ED8\u8BA4\u5355\u4F4D\u4E3Apx | number | string | 6.2em |
label-align | \u8868\u5355\u9879 label \u5BF9\u9F50\u65B9\u5F0F\uFF0C\u53EF\u9009\u503C\u4E3A center right | string | left |
input-align | \u8F93\u5165\u6846\u5BF9\u9F50\u65B9\u5F0F\uFF0C\u53EF\u9009\u503C\u4E3A center right | string | left |
error-message-align | \u9519\u8BEF\u63D0\u793A\u6587\u6848\u5BF9\u9F50\u65B9\u5F0F\uFF0C\u53EF\u9009\u503C\u4E3A center right | string | left |
validate-trigger | \u8868\u5355\u6821\u9A8C\u89E6\u53D1\u65F6\u673A\uFF0C\u53EF\u9009\u503C\u4E3A onChange \u3001onSubmit \uFF0C\u652F\u6301\u901A\u8FC7\u6570\u7EC4\u540C\u65F6\u8BBE\u7F6E\u591A\u4E2A\u503C\uFF0C\u5177\u4F53\u7528\u6CD5\u89C1\u4E0B\u65B9\u8868\u683C | string | string[] | onBlur |
colon | \u662F\u5426\u5728 label \u540E\u9762\u6DFB\u52A0\u5192\u53F7 | boolean | false |
disabled | \u662F\u5426\u7981\u7528\u8868\u5355\u4E2D\u7684\u6240\u6709\u8F93\u5165\u6846 | boolean | false |
readonly | \u662F\u5426\u5C06\u8868\u5355\u4E2D\u7684\u6240\u6709\u8F93\u5165\u6846\u8BBE\u7F6E\u4E3A\u53EA\u8BFB\u72B6\u6001 | boolean | false |
validate-first | \u662F\u5426\u5728\u67D0\u4E00\u9879\u6821\u9A8C\u4E0D\u901A\u8FC7\u65F6\u505C\u6B62\u6821\u9A8C | boolean | false |
scroll-to-error | \u662F\u5426\u5728\u63D0\u4EA4\u8868\u5355\u4E14\u6821\u9A8C\u4E0D\u901A\u8FC7\u65F6\u6EDA\u52A8\u81F3\u9519\u8BEF\u7684\u8868\u5355\u9879 | boolean | false |
show-error | \u662F\u5426\u5728\u6821\u9A8C\u4E0D\u901A\u8FC7\u65F6\u6807\u7EA2\u8F93\u5165\u6846 | boolean | false |
show-error-message | \u662F\u5426\u5728\u6821\u9A8C\u4E0D\u901A\u8FC7\u65F6\u5728\u8F93\u5165\u6846\u4E0B\u65B9\u5C55\u793A\u9519\u8BEF\u63D0\u793A | boolean | true |
submit-on-enter | \u662F\u5426\u5728\u6309\u4E0B\u56DE\u8F66\u952E\u65F6\u63D0\u4EA4\u8868\u5355 | boolean | true |
\u8868\u5355\u9879\u7684 API \u53C2\u89C1\uFF1AField \u7EC4\u4EF6
\u4F7F\u7528 Field \u7684 rules
\u5C5E\u6027\u53EF\u4EE5\u5B9A\u4E49\u6821\u9A8C\u89C4\u5219\uFF0C\u53EF\u9009\u5C5E\u6027\u5982\u4E0B:
\u952E\u540D | \u8BF4\u660E | \u7C7B\u578B |
---|---|---|
required | \u662F\u5426\u4E3A\u5FC5\u9009\u5B57\u6BB5\uFF0C\u5F53\u503C\u4E3A\u7A7A\u503C\u65F6\uFF08\u7A7A\u5B57\u7B26\u4E32\u3001\u7A7A\u6570\u7EC4\u3001false \u3001undefined \u3001null \uFF09\uFF0C\u6821\u9A8C\u4E0D\u901A\u8FC7 | boolean |
message | \u9519\u8BEF\u63D0\u793A\u6587\u6848\uFF0C\u53EF\u4EE5\u8BBE\u7F6E\u4E3A\u4E00\u4E2A\u51FD\u6570\u6765\u8FD4\u56DE\u52A8\u6001\u7684\u6587\u6848\u5185\u5BB9 | string | (value, rule) => string |
validator | \u901A\u8FC7\u51FD\u6570\u8FDB\u884C\u6821\u9A8C\uFF0C\u53EF\u4EE5\u8FD4\u56DE\u4E00\u4E2A Promise \u6765\u8FDB\u884C\u5F02\u6B65\u6821\u9A8C | (value, rule) => boolean | string | Promise |
pattern | \u901A\u8FC7\u6B63\u5219\u8868\u8FBE\u5F0F\u8FDB\u884C\u6821\u9A8C\uFF0C\u6B63\u5219\u65E0\u6CD5\u5339\u914D\u8868\u793A\u6821\u9A8C\u4E0D\u901A\u8FC7 | RegExp |
trigger | \u8BBE\u7F6E\u672C\u9879\u89C4\u5219\u7684\u89E6\u53D1\u65F6\u673A\uFF0C\u4F18\u5148\u7EA7\u9AD8\u4E8E Form \u7EC4\u4EF6\u8BBE\u7F6E\u7684 validate-trigger \u5C5E\u6027\uFF0C\u53EF\u9009\u503C\u4E3A onChange \u3001onBlur \u3001onSubmit | string | string[] |
formatter | \u683C\u5F0F\u5316\u51FD\u6570\uFF0C\u5C06\u8868\u5355\u9879\u7684\u503C\u8F6C\u6362\u540E\u8FDB\u884C\u6821\u9A8C | (value, rule) => any |
validateEmpty v3.6.0 | \u8BBE\u7F6E validator \u548C pattern \u662F\u5426\u8981\u5BF9\u7A7A\u503C\u8FDB\u884C\u6821\u9A8C\uFF0C\u9ED8\u8BA4\u503C\u4E3A true \uFF0C\u53EF\u4EE5\u8BBE\u7F6E\u4E3A false \u6765\u7981\u7528\u8BE5\u884C\u4E3A | boolean |
\u901A\u8FC7 validate-trigger
\u5C5E\u6027\u53EF\u4EE5\u81EA\u5B9A\u4E49\u8868\u5355\u6821\u9A8C\u7684\u89E6\u53D1\u65F6\u673A\u3002
\u503C | \u63CF\u8FF0 |
---|---|
onSubmit | \u4EC5\u5728\u63D0\u4EA4\u8868\u5355\u65F6\u89E6\u53D1\u6821\u9A8C |
onBlur | \u5728\u63D0\u4EA4\u8868\u5355\u548C\u8F93\u5165\u6846\u5931\u7126\u65F6\u89E6\u53D1\u6821\u9A8C |
onChange | \u5728\u63D0\u4EA4\u8868\u5355\u548C\u8F93\u5165\u6846\u5185\u5BB9\u53D8\u5316\u65F6\u89E6\u53D1\u6821\u9A8C |
\u4E8B\u4EF6\u540D | \u8BF4\u660E | \u56DE\u8C03\u53C2\u6570 |
---|---|---|
submit | \u63D0\u4EA4\u8868\u5355\u4E14\u9A8C\u8BC1\u901A\u8FC7\u540E\u89E6\u53D1 | values: object |
failed | \u63D0\u4EA4\u8868\u5355\u4E14\u9A8C\u8BC1\u4E0D\u901A\u8FC7\u540E\u89E6\u53D1 | errorInfo: { values: object, errors: object[] } |
\u901A\u8FC7 ref \u53EF\u4EE5\u83B7\u53D6\u5230 Form \u5B9E\u4F8B\u5E76\u8C03\u7528\u5B9E\u4F8B\u65B9\u6CD5\uFF0C\u8BE6\u89C1\u7EC4\u4EF6\u5B9E\u4F8B\u65B9\u6CD5\u3002
\u65B9\u6CD5\u540D | \u8BF4\u660E | \u53C2\u6570 | \u8FD4\u56DE\u503C |
---|---|---|---|
submit | \u63D0\u4EA4\u8868\u5355\uFF0C\u4E0E\u70B9\u51FB\u63D0\u4EA4\u6309\u94AE\u7684\u6548\u679C\u7B49\u4EF7 | - | - |
getValues v3.4.8 | \u83B7\u53D6\u6240\u6709\u8868\u5355\u9879\u5F53\u524D\u7684\u503C | - | Record<string, unknown> |
validate | \u9A8C\u8BC1\u8868\u5355\uFF0C\u652F\u6301\u4F20\u5165\u4E00\u4E2A\u6216\u591A\u4E2A name \u6765\u9A8C\u8BC1\u5355\u4E2A\u6216\u90E8\u5206\u8868\u5355\u9879\uFF0C\u4E0D\u4F20\u5165 name \u65F6\uFF0C\u4F1A\u9A8C\u8BC1\u6240\u6709\u8868\u5355\u9879 | name?: string | string[] | Promise<void> |
resetValidation | \u91CD\u7F6E\u8868\u5355\u9879\u7684\u9A8C\u8BC1\u63D0\u793A\uFF0C\u652F\u6301\u4F20\u5165\u4E00\u4E2A\u6216\u591A\u4E2A name \u6765\u91CD\u7F6E\u5355\u4E2A\u6216\u90E8\u5206\u8868\u5355\u9879\uFF0C\u4E0D\u4F20\u5165 name \u65F6\uFF0C\u4F1A\u91CD\u7F6E\u6240\u6709\u8868\u5355\u9879 | name?: string | string[] | - |
getValidationStatus v3.5.0 | \u83B7\u53D6\u6240\u6709\u8868\u5355\u9879\u7684\u6821\u9A8C\u72B6\u6001\uFF0C\u72B6\u6001\u5305\u62EC passed \u3001failed \u3001unvalidated | - | Record<string, FieldValidationStatus> |
scrollToField | \u6EDA\u52A8\u5230\u5BF9\u5E94\u8868\u5355\u9879\u7684\u4F4D\u7F6E\uFF0C\u9ED8\u8BA4\u6EDA\u52A8\u5230\u9876\u90E8\uFF0C\u7B2C\u4E8C\u4E2A\u53C2\u6570\u4F20 false \u53EF\u6EDA\u52A8\u81F3\u5E95\u90E8 | name: string, alignToTop: boolean | - |
\u7EC4\u4EF6\u5BFC\u51FA\u4EE5\u4E0B\u7C7B\u578B\u5B9A\u4E49\uFF1A
import type { FormProps, FormInstance } from 'vant';
FormInstance
\u662F\u7EC4\u4EF6\u5B9E\u4F8B\u7684\u7C7B\u578B\uFF0C\u7528\u6CD5\u5982\u4E0B\uFF1A
import { ref } from 'vue';
import type { FormInstance } from 'vant';
const formRef = ref<FormInstance>();
formRef.value?.submit();
\u540D\u79F0 | \u8BF4\u660E |
---|---|
default | \u8868\u5355\u5185\u5BB9 |
Vant \u652F\u6301\u5728 Form \u7EC4\u4EF6\u4E2D\u63D2\u5165\u81EA\u5B9A\u4E49\u7684\u8868\u5355\u9879\uFF0C\u5177\u4F53\u7528\u6CD5\u53C2\u89C1 useCustomFieldValue\u3002