What is vee-validate?
vee-validate is a form validation library for Vue.js that allows you to validate inputs and forms with ease. It provides a set of validation rules and the ability to create custom rules, making it highly flexible and customizable.
What are vee-validate's main functionalities?
Basic Validation
This example demonstrates basic validation using vee-validate. The input field for email is validated to ensure it is required and follows the email format. Errors are displayed using the `errors.first` method.
{
"template": "<form @submit.prevent=\"submitForm\"><input v-model=\"email\" name=\"email\" v-validate=\"'required|email'\" /><span>{{ errors.first('email') }}</span><button type=\"submit\">Submit</button></form>",
"data": "function() { return { email: '' }; }",
"methods": "{ submitForm() { this.$validator.validateAll().then((result) => { if (result) { alert('Form Submitted!'); } }); } }"
}
Custom Validation Rules
This example shows how to create and use custom validation rules in vee-validate. The custom rule 'unique' checks if the username is not 'admin' and displays an error message if it is.
{
"template": "<form @submit.prevent=\"submitForm\"><input v-model=\"username\" name=\"username\" v-validate=\"'required|unique'\" /><span>{{ errors.first('username') }}</span><button type=\"submit\">Submit</button></form>",
"data": "function() { return { username: '' }; }",
"methods": "{ submitForm() { this.$validator.validateAll().then((result) => { if (result) { alert('Form Submitted!'); } }); } }",
"created": "function() { this.$validator.extend('unique', { getMessage: field => `The ${field} is already taken.`, validate: value => new Promise(resolve => { setTimeout(() => { resolve({ valid: value !== 'admin' }); }, 500); }) }); }"
}
Validation with Async Rules
This example demonstrates how to use asynchronous validation rules in vee-validate. The custom rule 'is-available' checks if the email is not 'test@example.com' with a simulated delay.
{
"template": "<form @submit.prevent=\"submitForm\"><input v-model=\"email\" name=\"email\" v-validate=\"'required|email|is-available'\" /><span>{{ errors.first('email') }}</span><button type=\"submit\">Submit</button></form>",
"data": "function() { return { email: '' }; }",
"methods": "{ submitForm() { this.$validator.validateAll().then((result) => { if (result) { alert('Form Submitted!'); } }); } }",
"created": "function() { this.$validator.extend('is-available', { getMessage: field => `The ${field} is not available.`, validate: value => new Promise(resolve => { setTimeout(() => { resolve({ valid: value !== 'test@example.com' }); }, 1000); }) }); }"
}
Other packages similar to vee-validate
vuelidate
Vuelidate is another popular validation library for Vue.js. It provides a simple and flexible way to validate forms and inputs. Unlike vee-validate, Vuelidate uses a model-based approach, which can be more intuitive for some developers.
vue-formulate
Vue Formulate is a powerful form library for Vue.js that includes built-in validation. It offers a wide range of features, including form generation, validation, and custom input components. Compared to vee-validate, Vue Formulate provides a more comprehensive solution for form handling.
buefy
Buefy is a lightweight UI component library for Vue.js based on Bulma. It includes form validation features as part of its form components. While not as feature-rich as vee-validate, Buefy provides a good option for developers already using Bulma for styling.
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
yarn add vee-validate
npm 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
If you want more fine grained control, you can use useField
function to compose validation logic into your component:
<script setup>
// MyInputComponent.vue
import { useField } from 'vee-validate';
const props = defineProps<{
name: string;
}>();
// Validator function
const isRequired = value => (value ? true : 'This field is required');
const { value, errorMessage } = useField(props.name, isRequired);
</script>
<template>
<input v-model="value" />
<span>{{ errorMessage }}</span>
</template>
Then you can you can use useForm
to make your form component automatically pick up your input fields declared with useField
and manage them:
<script setup>
import { useForm } from 'vee-validate';
import MyInputComponent from '@/components/MyInputComponent.vue';
const { handleSubmit } = useForm();
const onSubmit = handleSubmit(values => {
// Submit to API
console.log(values); // { email: 'email@gmail.com' }
});
</script>
<template>
<form @submit="onSubmit">
<MyInputComponent name="email" />
</form>
</template>
You can do so much more than this, for more info check the composition API documentation.
Declarative Components
Higher-order components are better suited for most of your cases. Register the Field
and Form
components and create a simple required
validator:
import { Field, Form } from 'vee-validate';
export default {
components: {
Field,
Form,
},
methods: {
isRequired(value) {
return value ? true : 'This field is required';
},
},
};
Then use the Form
and Field
components to render your form:
<Form v-slot="{ errors }">
<Field name="email" :rules="isRequired" />
<span>{{ errors.email }}</span>
</Form>
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
Emeriti
Here we honor past contributors and sponsors who have been a major part on this project.
βοΈ License
Released under MIT by @logaretm.