# vuelidator > Vue validator Latest version **0.1.4** (published 2020-08-11) · MIT license · 0 weekly downloads ## Install ```sh npm install vuelidator pnpm add vuelidator yarn add vuelidator bun add vuelidator ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.4 | | Published | 2020-08-11 | | First published | 2018-09-28 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Dependencies | 2 | | Unpacked size | 588.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2 | | Author | Yaroslav Savaryn | | Maintainers | yariksav | | Keywords | vue, validator, validation, validate | ## Links - npm: https://www.npmjs.com/package/vuelidator - Repository: https://github.com/yariksav/vuelidator - Homepage: https://github.com/yariksav/vuelidator#readme - Issues: https://github.com/yariksav/vuelidator/issues - npm.io page: https://npm.io/package/vuelidator ## Dependencies (2) - [haye](https://npm.io/package/haye.md) ^2.0.2 - [validator](https://npm.io/package/validator.md) ^13.1.1 ## Alternatives - [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads - [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads - [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads - [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads - [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads ## Recent versions - 0.1.4 (latest) — 2020-08-11 - 0.1.2 — 2020-07-20 - 0.1.1 — 2020-07-20 - 0.1.0 — 2019-03-16 - 0.0.4 — 2018-10-10 - 0.0.2 — 2018-09-30 - 0.0.1 — 2018-09-28 ## README # Vuelidator ### This package will help you to validate your datas in vue components > This module uses [validator.js](https://github.com/chriso/validator.js) and [haye](https://github.com/poppinss/haye) packages

## Setup Install the package from npm ```npm npm install vuelidator ``` and use in your component ```js import { Validatable } from 'vuelidator' ... { mixins: [ Validatable ] ... } ``` ## Config validator rules Rules can be in string format: 'required|min:5|alpha' To config your data rules fill validationRules in component computed propetry ```js ... computed: { validationRules () { return { slug: 'required|alpha|min:5|max:16', name: 'required|lengthrange:5,16', permissions: [ { name: 'required', message: this.$t('Please select at least one permission') } ] } }, } ``` ## Validators ### Locales Several validators receives `locale` param, there locales.
Locale is one of `['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-FR', 'hu-HU', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']`) and defaults to `en-US`. Validator | Description --------------------------- | -------------------------------------- **contains** | check if the string contains the seed. **equals** | check if the string matches the comparison. **after** | check if the string is a date that's after the specified date (defaults to now). **alpha** | check if the string contains only letters. Params: `locale` **alpha_numeric** | check if the string contains only letters and numbers. Params: `locale` **base64** | check if a string is base64 encoded. **before** | check if the string is a date that's before the specified date. **boolean** | check if a string is a boolean. **creditcard** | check if the string is a credit card. **currency** | check if the string is a valid currency amount **decimal** | check if the string represents a decimal number, such as 0.1, .3, 1.1, 1.00003, 4.0, etc.
Params: `locale` **divisibleby** | check if the string is a number that's divisible by another. **email** | check if the string is an email **empty** | check if the string has a length of zero **max** | check length of string should be less than max **maxval** | check value of field should be less than max, **min** | check length of string should be greater than min **minval** | check value should be greater than min **numeric** | check if the string is a float. **hash** | check if the string is a hash of type algorithm.

Algorithm is one of `['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b']` **hexcolor** | check if the string is a hexadecimal color. **hexadecimal** | check if the string is a hexadecimal number. **ip** | check if the string is an IP (version 4 or 6). **iprange** | check if the string is an IP Range(version 4 only). **in** | check if the string is in a array of allowed values. **integer** | check if the string is an integer **json** | check if the string is valid JSON (note: uses JSON.parse). **jwt** | check if the string is valid JWT token. **latlong** | check if the string is a valid latitude-longitude coordinate in the format `lat,long` or `lat, long`. **length** | check if the string's or array length equals value **lengthrange** | check if the string's length falls in a range **lowercase** | check if the string is lowercase. **macaddress** | check if the string is a MAC address **md5** | check if the string is a MD5 hash. **phone** | check if the string is a mobile phone number. Locale **number** | check if the string contains only numbers **port** | check if the string is a valid port number. **postalcode** | check if the string is a postal code,

(locale is one of `[ 'AD', 'AT', 'AU', 'BE', 'BG', 'CA', 'CH', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IL', 'IN', 'IS', 'IT', 'JP', 'KE', 'LI', 'LT', 'LU', 'LV', 'MX', 'NL', 'NO', 'PL', 'PT', 'RO', 'RU', 'SA', 'SE', 'SI', 'TN', 'TW', 'US', 'ZA', 'ZM' ]` OR 'any'. If 'any' is used, function will check if any of the locals match. **url** | check if the string is an URL **uuid** | check if the string is a UUID (version 3, 4 or 5). **uppercase** | check if the string is uppercase. **matches** | check if string matches the pattern.

Either `matches('foo', /foo/i)` or `matches('foo', 'foo', 'i')`. ## Messages The library tries to get messages from i18n plugin by tag `validators.${rule.name}` If i18n not instaled, messages will get from default options If you need own message options, just override `onValidationMessage` method ```js methods: { onValidationMessage ({ field, rule }) { return this.$i18n ? this.$t(`validators.${rule.name}`, rule.args) : rule.name }, ... ``` ## Properties added by mixin: - `isValid`: checks is all data is valid. In first getter call validation will start in silent mode without provide errors - `errors`: objects with error messages by filed name. To show error, just use for instance `v-if="errors.name"` - `successes`: object with successed flags by filed name ## Methods added by mixin - Start validation with rules, provided in `validationRules` and data in vm.$data ```js this.validate() ``` - Start validation with specific rules and data in vm.$data ```js this.validate(rules) ``` - Start validation with specific rules and data ```js this.validate(rules, data) ``` --- _Source: https://npm.io/package/vuelidator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._