Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/vreg/node_modules/vee-validate/ |
<p align="center">
<a href="https://vee-validate.logaretm.com/v3" target="_blank">
<img width="200" src="https://github.com/logaretm/vee-validate/blob/v3/logo.png">
</a>
</p>
<p align="center">
[](https://codecov.io/gh/logaretm/vee-validate)
[](https://travis-ci.org/logaretm/vee-validate)
[](https://cdnjs.com/libraries/vee-validate/)
[](https://npm-stat.com/charts.html?package=vee-validate)
[](https://www.npmjs.com/package/vee-validate)
[](http://isitmaintained.com/project/logaretm/vee-validate 'Average time to resolve an issue')
[](http://isitmaintained.com/project/logaretm/vee-validate 'Percentage of issues still open')
</p>
<br>
vee-validate is a template-based validation framework for [Vue.js](https://vuejs.org/) that allows you to validate inputs and display errors.
Being template-based you only need to specify for each input what kind of validators should be used when the value changes. The errors will be automatically generated with 40+ locales supported. [Many rules are available out of the box](https://vee-validate.logaretm.com/v3/guide/rules.html).
This plugin is inspired by [PHP Framework Laravel's validation](https://laravel.com/).
### Features
- Template based validation that is both familiar and easy to setup.
- 🌍 i18n Support and error Messages in 40+ locales.
- 💫 Async and Custom Rules Support.
- 💪 Written in TypeScript.
- No dependencies.
### Vue 3 Support
Since Vue 3.0 was released, `vee-validate@v4` targets Vue 3 support with a completely new API. It will not be tagged as latest until Vue is tagged as latest as well.
Currently we are in Alpha releases, to install vee-validate v4 use the `next` tag:
```bash
yarn add vee-validate@next
# or
npm install vee-validate@next
```
You can find the documentation for v4 here:
https://vee-validate.logaretm.com/v4/
### Installation
#### yarn
```bash
yarn add vee-validate
```
#### npm
```bash
npm i vee-validate --save
```
#### CDN
vee-validate is also available on these CDNs:
- [jsdelivr](https://cdn.jsdelivr.net/npm/vee-validate@latest/dist/vee-validate.js) [](https://www.jsdelivr.com/package/npm/vee-validate)
- [unpkg](https://unpkg.com/vee-validate)
> When using a CDN via script tag, all the exported modules on VeeValidate are available on the VeeValidate Object. ex: VeeValidate.Validator
### Getting Started
Install the rules you will use in your app, we will install the `required` rule for now:
```js
import { extend } from 'vee-validate';
import { required, email } from 'vee-validate/dist/rules';
// Add the required rule
extend('required', {
...required,
message: 'This field is required'
});
// Add the email rule
extend('email', {
...email,
message: 'This field must be a valid email'
});
```
Import the `ValidationProvider` component and register it:
#### Global Registration
```js
import { ValidationProvider } from 'vee-validate';
// Register it globally
// main.js or any entry file.
Vue.component('ValidationProvider', ValidationProvider);
```
#### Local Registration
```js
import { ValidationProvider } from 'vee-validate';
export default {
components: {
ValidationProvider
}
};
```
All the JavaScript work is done. Next in the template add the inputs you want to validate them:
```vue
<ValidationProvider name="email" rules="required|email">
<div slot-scope="{ errors }">
<input v-model="email">
<p>{{ errors[0] }}</p>
</div>
</ValidationProvider>
```
The validation provider accepts two props: `rules` which is in its simplest form, a string containing the validation rules separated by a `|` character, and a `name` prop which is the field name that will be used in error messages.
and That's it, your input will be validated automatically, notice that the `ValidationProvider` uses [scoped slots](https://vuejs.org/v2/guide/components-slots.html#Scoped-Slots) to pass down validation state and results.
There is more that can be done! You can customize events, validate initial values, manually validate or reset the field and much more. Make sure to [read the docs](https://vee-validate.logaretm.com/v3).
### Documentation
Read the [documentation and demos](https://vee-validate.logaretm.com/v3/).
### Compatibility
This library uses ES6 Promises so be sure to provide a polyfill for it for the browsers that do not support it.
### Contributing
You are welcome to contribute to this project, but before you do, please make sure you read the [contribution guide](CONTRIBUTING.md).
### Tutorials and Examples
#### Docs Highlights
- [Backend and Server Side Validation](https://vee-validate.logaretm.com/v3/advanced/server-side-validation.html)
- [Localization (i18n)](https://vee-validate.logaretm.com/v3/guide/localization.html)
- [Handling Forms](https://vee-validate.logaretm.com/v3/guide/forms.html)
- [UI Libraries Validation Samples](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html)
- [Vuetify](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html#vuetify)
- [Quasar](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html#quasar)
- [BootstrapVue](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html#bootstrapvue)
- [Buefy](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html#buefy)
- [Ant Design](https://vee-validate.logaretm.com/v3/guide/3rd-party-libraries.html#ant-design)
### Credits
- Inspired by Laravel's [validation syntax](https://laravel.com/docs/5.4/validation).
- Logo by @baianat design team.
### License
MIT