vee-validate

WebJar for vee-validate

License

License

MIT
Categories

Categories

Github Development Tools Version Controls
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

github-com-logaretm-vee-validate
Last Version

Last Version

2.0.0-beta.18
Release Date

Release Date

Type

Type

jar
Description

Description

vee-validate
WebJar for vee-validate
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/logaretm/vee-validate

Download github-com-logaretm-vee-validate

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/github-com-logaretm-vee-validate/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>github-com-logaretm-vee-validate</artifactId>
    <version>2.0.0-beta.18</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-logaretm-vee-validate/
implementation 'org.webjars.npm:github-com-logaretm-vee-validate:2.0.0-beta.18'
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-logaretm-vee-validate/
implementation ("org.webjars.npm:github-com-logaretm-vee-validate:2.0.0-beta.18")
'org.webjars.npm:github-com-logaretm-vee-validate:jar:2.0.0-beta.18'
<dependency org="org.webjars.npm" name="github-com-logaretm-vee-validate" rev="2.0.0-beta.18">
  <artifact name="github-com-logaretm-vee-validate" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='github-com-logaretm-vee-validate', version='2.0.0-beta.18')
)
libraryDependencies += "org.webjars.npm" % "github-com-logaretm-vee-validate" % "2.0.0-beta.18"
[org.webjars.npm/github-com-logaretm-vee-validate "2.0.0-beta.18"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Financial Contributors on Open Collective codecov circleci CDNJS npm npm Bundle Size Average time to resolve an issue Percentage of issues still open


vee-validate is a form validation library for Vue.js that allows you to validate inputs and build better form UIs in a familiar declarative style or using composition functions

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 and painful form concerns, gives you full control over everything else
  • ๐Ÿค Tiny: Small footprint < 5kb which makes your apps faster to load
  • ๐Ÿ˜Ž UI Agnostic: Works with native HTML elements or your favorite UI library components
  • ๐Ÿฆพ Progressive: Works with any setup 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

# install with yarn
yarn add vee-validate@next

# install with npm
npm install vee-validate@next --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 or v3
3.x 4.x v4

Usage

Declarative Components (Recommended)

Higher-order components are better suited for most of your cases. Register the Field and Form components and create a simple required validator:

import { Field, Form } from 'vee-validate';

export default {
  components: {
    Field,
    Form,
  },
  methods: {
    isRequired(value) {
    return value ? true : 'This field is required';
  },
};

Then use the Form and Field components to render your form:

<Form v-slot="{ errors }">
  <Field name="field" :rules="isRequired" />

  <span>{{ errors.field }}</span>
</Form>

The Field component renders an input of type text by default but you can control that

Composition API

If you want more fine grained control, you can use useField function to compose validation logic into your component:

import { useField } from 'vee-validate';

export default {
  setup() {
    // Validator function
    const isRequired = value => (value ? true : 'This field is required');
    const { value, errorMessage } = useField('field', isRequired);

    return {
      value,
      errorMessage,
    };
  },
};

Then in your template use v-model to bind the value to your input and display the errors using errorMessage:

<input name="field" v-model="value" />
<span>{{ errorMessage }}</span>

๐Ÿ“š Documentation

Read the documentation and demos.

Contributing

You are welcome to contribute to this project, but before you do, please make sure you read the contribution guide

Credits

Emeriti

Here we honor past contributors and sponsors who have been a major part on this project.

โš–๏ธ License

MIT

Versions

Version
2.0.0-beta.18