form-backend-validation

An easy way to validate forms using back end logic

Wouldn't it be great if you could just use your back end to validate forms on the front end? This package provides a Form class does exactly that. It can post itself to a configured endpoint and manage errors. The class meant to be used with a Laravel back end.

Take a look at the usage section to view a detailed example on how to use it.

The code of this package is based on the Object-Oriented Forms lesson in the Vue 2.0 series on Laracasts.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

The best postcards will get published on the open source page on our website.

Install

You can install the package via yarn:

$ yarn add form-backend-validation

Or via npm:

$ npm install form-backend-validation

Usage

You find an example implementation with Laravel and Vue in the spatie/form-backend-validation-example-app repo.

import Form from 'form-backend-validation';

// instantiate a form class with some value
const form = new Form({
    field1: 'value 1',
    field2: 'value 2',
    person: {
        first_name: 'John',
        last_name: 'Doe',
    },
});

// a form can also be initiated with an array
const form = new Form(['field1', 'field2']);

// submitting the form, you can also use `.put`, `.patch` and `.delete`
form.post(anUrl)
   .then(response => ...)
   .catch(response => ...);

// returns true if request is being executed
form.processing;


// if there were any errors, you can get to them easily

// example errors object
{ 
    'field1': ['Value is required'], // single field
    'person.first_name': ['Value is required'], // field in person object
}

// returns an object in which the keys are the field names 
// and the values array with error message sent by the server
form.errors.all() 

// returns true if there were any error
form.errors.any(); 

// returns true if there is an error for the given field name or object
form.errors.has(key)

// returns an array with errors for the given field name
form.errors.get(key)

// clear all errors
form.errors.clear()

// clear the error of the given field name or all errors on the given object
form.errors.clear(key)

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ npm run test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please contact Freek Van der Herten instead of using the issue tracker.

Credits

• Freek Van der Herten
• All Contributors

Initial code of this package was copied from Jeffrey Way's Vue-Forms repo

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.

Changelog

1.4.1 - 2017-04-26

• Changed: Axios is now a peer dependency to avoid multiple installed versions. Add axios to your project with npm install axios --save or yarn add axios