Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/logaretm/vee-validate
✅ Painless Vue forms
https://github.com/logaretm/vee-validate
form form-validation forms hacktoberfest validate validation validation-library validations validator vee-validate vue vue2 vue3 vue3-composition-api vuejs
Last synced: 6 days ago
JSON representation
✅ Painless Vue forms
- Host: GitHub
- URL: https://github.com/logaretm/vee-validate
- Owner: logaretm
- License: mit
- Created: 2016-07-30T01:10:44.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T16:44:32.000Z (3 months ago)
- Last Synced: 2024-10-29T22:51:26.684Z (3 months ago)
- Topics: form, form-validation, forms, hacktoberfest, validate, validation, validation-library, validations, validator, vee-validate, vue, vue2, vue3, vue3-composition-api, vuejs
- Language: TypeScript
- Homepage: https://vee-validate.logaretm.com/v4
- Size: 22.4 MB
- Stars: 10,802
- Watchers: 114
- Forks: 1,264
- Open Issues: 63
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- stars - logaretm/vee-validate
- awesome - logaretm/vee-validate - ✅ Painless Vue forms (TypeScript)
- awesome-vue-3 - vee-validate - VeeValidate (v4) Vue 3 Template driven form validation (Packages)
- StarryDivineSky - logaretm/vee-validate
- awesome-egypt-opensource - logaretm/vee-validate - VeeValidate is the most popular Vue.js form library. It takes care of value tracking, validation, errors, submissions and more. (Projects / Web and Publishing)
README
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
```sh
# Install with yarn
yarn add vee-validate
# Install with npm
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](https://vee-validate.logaretm.com/v2) or [v3](https://vee-validate.logaretm.com/v3) |
| `3.x` | `4.x` | [v4](https://vee-validate.logaretm.com/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.
```vue
import { useForm } from 'vee-validate';
// Validation, or use `yup` or `zod`
function required(value) {
return value ? true : 'This field is required';
}
// Create the form
const { defineField, handleSubmit, errors } = useForm({
validationSchema: {
field: required,
},
});
// Define fields
const [field, fieldProps] = defineField('field');
// Submit handler
const onSubmit = handleSubmit(values => {
// Submit to API
console.log(values);
});
{{ errors.field }}
Submit
```
You can do so much more than this, for more info [check the composition API documentation](https://vee-validate.logaretm.com/v4/guide/composition-api/getting-started/).
#### Declarative Components
Higher-order components can also be used to build forms. Register the `Field` and `Form` components and create a simple `required` validator:
```vue
import { Field, Form } from 'vee-validate';
// Validation, or use `yup` or `zod`
function required(value) {
return value ? true : 'This field is required';
}
// Submit handler
function onSubmit(values) {
// Submit to API
console.log(values);
}
{{ errors.field }}
Submit
```
The `Field` component renders an `input` of type `text` by default but you can [control that](https://vee-validate.logaretm.com/v4/api/field#rendering-fields)
## 📚 Documentation
Read the [documentation and demos](https://vee-validate.logaretm.com/v4).
## Contributing
You are welcome to contribute to this project, but before you do, please make sure you read the [contribution guide](/CONTRIBUTING.md).
## Credits
- Inspired by Laravel's [validation syntax](https://laravel.com/docs/5.4/validation)
- v4 API Inspired by [Formik's](https://github.com/formium/formik)
- Nested path types by [react-hook-form](https://github.com/react-hook-form/react-hook-form)
- Logo by [Baianat](https://github.com/baianat)
## Emeriti
Here we honor past contributors and sponsors who have been a major part on this project.
- [Baianat](https://github.com/baianat).
## ⚖️ License
Released under [MIT](/LICENSE) by [@logaretm](https://github.com/logaretm).