Painless Vue forms

Features

• 🍞 Easy: Declarative validation that is familiar and easy to setup
• 🧘‍♀️ Flexible: Synchronous, Asynchronous, field-level or form-level validation
• ⚡️ Fast: Build faster forms faster with intuitive API and small footprint
• 🏏 Minimal: Only handles the complicated form concerns, gives you full control over everything else
• 😎 UI Agnostic: Works with native HTML elements or your favorite UI library components
• 🦾 Progressive: Works whether you use Vue.js as a progressive enhancement or in a complex setup
• ✅ Built-in Rules: Companion lib with 25+ Rules that covers most needs in most web applications
• 🌐 i18n: 45+ locales for built-in rules contributed by developers from all over the world

Getting Started

Installation

1# Install with yarn
2yarn add vee-validate
3
4# Install with npm
5npm install vee-validate --save

Vue version support

The main v4 version supports Vue 3.x only, for previous versions of Vue, check the following the table

vue Version	vee-validate version	Documentation Link
2.x	2.x or 3.x	v2 or v3
3.x	4.x	v4

Usage

vee-validate offers two styles to integrate form validation into your Vue.js apps.

Composition API

The fastest way to create a form and manage its validation, behavior, and values is with the composition API.

Create your form with useForm and then use defineField to create your field model and props/attributes and handleSubmit to use the values and send them to an API.

1<script setup>
2import { useForm } from 'vee-validate';
3
4// Validation, or use `yup` or `zod`
5function required(value) {
6  return value ? true : 'This field is required';
7}
8
9// Create the form
10const { defineField, handleSubmit, errors } = useForm({
11  validationSchema: {
12    field: required,
13  },
14});
15
16// Define fields
17const [field, fieldProps] = defineField('field');
18
19// Submit handler
20const onSubmit = handleSubmit(values => {
21  // Submit to API
22  console.log(values);
23});
24</script>
25
26<template>
27  <form @submit="onSubmit">
28    <input v-model="field" v-bind="fieldProps" />
29    <span>{{ errors.field }}</span>
30
31    <button>Submit</button>
32  </form>
33</template>

You can do so much more than this, for more info check the composition API documentation.

Declarative Components

Higher-order components can also be used to build forms. Register the Field and Form components and create a simple required validator:

1<script setup>
2import { Field, Form } from 'vee-validate';
3
4// Validation, or use `yup` or `zod`
5function required(value) {
6  return value ? true : 'This field is required';
7}
8
9// Submit handler
10function onSubmit(values) {
11  // Submit to API
12  console.log(values);
13}
14</script>
15
16<template>
17  <Form v-slot="{ errors }" @submit="onSubmit">
18    <Field name="field" :rules="required" />
19
20    <span>{{ errors.field }}</span>
21
22    <button>Submit</button>
23  </Form>
24</template>

The Field component renders an input of type text by default but you can control that

📚 Documentation

Read the documentation and demos.

Contributing

You are welcome to contribute to this project, but before you do, please make sure you read the contribution guide.

Credits

• Inspired by Laravel's validation syntax
• v4 API Inspired by Formik's
• Nested path types by react-hook-form
• Logo by Baianat

Emeriti

Here we honor past contributors and sponsors who have been a major part on this project.

• Baianat.

⚖️ License

Released under MIT by @logaretm.