\n\n## Installation\n\nYou can use Vuelidate just by itself, but we suggest you use it along `@vuelidate/validators`, as it gives a nice collection of commonly used\nvalidators.\n\n**Vuelidate supports both Vue 3.0 and Vue 2.x**\n\n```bash\nnpm install @vuelidate/core @vuelidate/validators\n# or\nyarn add @vuelidate/core @vuelidate/validators\n```\n\n## Usage with Options API\n\nTo use Vuelidate with the Options API, you just need to return an empty Vuelidate instance from `setup`.\n\nYour validation state lives in the `data` and the rules are in `validations` function.\n\n```js\nimport { email, required } from '@vuelidate/validators'\nimport { useVuelidate } from '@vuelidate/core'\n\nexport default {\n name: 'UsersPage',\n data: () => ({\n form: {\n name: '',\n email: ''\n }\n }),\n setup: () => ({ v$: useVuelidate() }),\n validations () {\n return {\n form: {\n name: { required },\n email: { required, email }\n }\n }\n }\n}\n```\n\n## Usage with Composition API\n\nTo use Vuelidate with the Composition API, you need to provide it a state and set of validation rules, for that state.\n\nThe state can be a `reactive` object or a collection of `refs`.\n\n```js\nimport { reactive } from 'vue' // or '@vue/composition-api' in Vue 2.x\nimport { useVuelidate } from '@vuelidate/core'\nimport { email, required } from '@vuelidate/validators'\n\nexport default {\n setup () {\n const state = reactive({\n name: '',\n emailAddress: ''\n })\n const rules = {\n name: { required },\n emailAddress: { required, email }\n }\n\n const v$ = useVuelidate(rules, state)\n\n return { state, v$ }\n }\n}\n```\n\n## Providing global config to your Vuelidate instance\n\nYou can provide global configs to your Vuelidate instance using the third parameter of `useVuelidate` or by using the `validationsConfig`. These\nconfig options are used to change some core Vuelidate functionality, like `$autoDirty`, `$lazy`, `$scope` and more. Learn all about them\nin [Validation Configuration](https://vuelidate-next.netlify.app/api.html#validation-configuration).\n\n### Config with Options API\n\n```vue\n\n```\n\n### Config with Composition API\n\n```js\nimport { reactive } from 'vue' // or '@vue/composition-api' in Vue 2.x\nimport { useVuelidate } from '@vuelidate/core'\nimport { email, required } from '@vuelidate/validators'\n\nexport default {\n setup () {\n const state = reactive({})\n const rules = {}\n const v$ = useVuelidate(rules, state, { $lazy: true })\n\n return { state, v$ }\n }\n}\n```\n\n## The validation object, aka `v$` object\n\n```ts\ninterface ValidationState {\n $dirty: false, // validations will only run when $dirty is true\n $touch: Function, // call to turn the $dirty state to true\n $reset: Function, // call to turn the $dirty state to false\n $errors: [], // contains all the current errors { $message, $params, $pending, $invalid }\n $error: false, // true if validations have not passed\n $invalid: false, // as above for compatibility reasons\n // there are some other properties here, read the docs for more info\n}\n```\n\n## Validations rules are on by default\n\nValidation in Vuelidate 2 is by default on, meaning validators are called on initialisation, but an error is considered active, only after a field is dirty, so after `$touch()` is called or by using `$model`.\n\nIf you wish to make a validation lazy, meaning it only runs validations once it a field is dirty, you can pass a `{ $lazy: true }` property to\nVuelidate. This saves extra invocations for async validators as well as makes the initial validation setup a bit more performant.\n\n```js\nconst v = useVuelidate(rules, state, { $lazy: true })\n```\n\n### Resetting dirty state\n\nIf you wish to reset a form's `$dirty` state, you can do so by using the appropriately named `$reset` method. For example when closing a create/edit\nmodal, you dont want the validation state to persist.\n\n```vue\n\n\n\n\n```\n\n## Displaying error messages\n\nThe validation state holds useful data, like the invalid state of each property validator, along with extra properties, like an error message or extra\nparameters.\n\nError messages come out of the box with the bundled validators in `@vuelidate/validators` package. You can check how change those them over at\nthe [Custom Validators page](https://vuelidate-next.netlify.app/custom_validators.html)\n\nThe easiest way to display errors is to use the form's top level `$errors` property. It is an array of validation objects, that you can iterate over.\n\n```vue\n\n\n{{ error.$validator }}\n on property\n{{ error.$property }}\n says:\n{{ error.$message }}\n\n```\n\nYou can also check for errors on each form property:\n\n```vue\n\n\n\n```\n\nFor more info, visit the [Vuelidate Docs](https://vuelidate-next.netlify.org).\n\n## Development\n\nTo test the package run\n\n``` bash\n# install dependencies\nyarn install\n\n# create bundles.\nyarn build\n\n# Create docs inside /docs package\nyarn dev\n\n# run unit tests for entire monorepo\nyarn test:unit\n\n# You can also run for same command per package\n```\n","readmeFilename":"README.md"}
![\"Storyblok\"](\"https://a.storyblok.com/f/51376/3856x824/fea44d52a9/colored-full.png\")
\n \n![\"Vue](\"https://cdn.discordapp.com/attachments/258614093362102272/557267759130607630/Vue-Mastery-Big.png\")
\n \n