Newly Potted Mandrakes

    @precision-nutrition/vee-validate
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.8 • Public • Published

    codecov Build Status Codacy Badge CDNJS npm npm Average time to resolve an issue Percentage of issues still open


    vee-validate is a template-based validation framework for Vue.js that allows you to validate input fields 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.

    This plugin is inspired by PHP Framework Laravel's validation.

    Installation

    yarn

    yarn add vee-validate
    

    npm

    npm i vee-validate --save
    

    CDN

    vee-validate is also available on these cdns:

    Getting Started

    In your script entry point:

    import Vue from 'vue';
    import VeeValidate from 'vee-validate';
    
    Vue.use(VeeValidate);

    Now you are all setup to use the plugin.

    Usage

    There are two ways to use vee-validate, Using v-validate directive or using Validation* components.

    Using directive

    Just apply the v-validate directive on your input and pass a string value which is a list of validations separated by a pipe. For example, we will use the required and the email validators:

    <input v-validate="'required|email'" type="text" name="email">

    Now every time the input changes, the validator will run the list of validations from left to right, populating the errors helper object whenever an input fails validation.

    To access the errors object (in your vue instance):

    this.$validator.errorBag;
    // or
    this.errors; // injected into $data by the plugin, you can customize the property name.

    Let's display the error for the email input we've created:

    <!-- If it has an email error, display the first message associated with it. -->
    <span v-show="errors.has('email')">{{ errors.first('email') }}</span>

    Using Components

    Validation components uses the scoped slots feature to pass down validation state and results.

    <template>
      <div>
        <ValidationProvider rules="required|email">
          <div slot-scope="{ errors }">
            <input v-model="value">
            <p>{{ errors[0] }}</p>
          </div>
        </ValidationProvider>
      </div>
    </template>
    
    <script>
    import { ValidationProvider } from 'vee-validate';
    
    export default {
      data: () => ({
        value: ''
      }),
      components: {
        ValidationProvider
      }
    }
    </script>

    Documentation

    Read the documentation and demos.

    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 repo with anything you think is useful. Fixes are more than welcome. However if you are adding a new validation rule, it should have multiple uses or be as generic as possible.

    You can find more information in the contribution guide.

    UI Integrations

    These libraries/projects make it a breeze integrating vee-validate into your favorite UI library/framework.

    Tutorials and Examples

    Credits

    license

    MIT

    Install

    npm i @precision-nutrition/vee-validate

    DownloadsWeekly Downloads

    115

    Version

    2.1.8

    License

    MIT

    Unpacked Size

    1.18 MB

    Total Files

    59

    Last publish

    Collaborators

    • jasonbekolay
    • grapho
    • trianglegrrl
    • jfh
    • ghedamat
    • pnfinance
    • pn-bot
    • elucid
    • dougestey
    • grahamma
    • jonhunt-pn
    • christophermilne
    • benmossbitfield
    • vpuzzella
    • ivanvotti
    • miguelverissimo
    • ryborg
    • pn-ips