laravel-form-validation
TypeScript icon, indicating that this package has built-in type declarations

1.3.0 • Public • Published

Laravel Form Validation

downloads npm-version github-tag license tests codecov ts

This package make use of AJAX to validate your forms with backend logic.

Installation

npm install laravel-form-validation@^1.0 

Usage

An example using Vue.js v2.7 and Bootstrap v4.6

<template>
    <form @submit.prevent="submit">

        <!-- Display a global message if there are any errors -->
        <div class="alert alert-danger my-3" v-show="form.$errors.any()">
            Please check the form and try again!
        </div>

        <div class="form-group">
            <label>Name</label>
            <input type="text"
                   class="form-control"
                   v-model="user.name"
                   :class="{ 'is-invalid': form.$errors.has('name') }"
                   @keyup="form.$errors.clear('name')">

            <!-- Display first error for a field -->
            <div class="invalid-feedback" v-show="form.$errors.has('name')">
                {{ form.$errors.first('name') }}
            </div>
        </div>

        <div class="form-group">
            <label>Avatar</label>
            <div class="custom-file">

                <!-- Transform File object to FormData() automatically -->
                <input type="file"
                       id="input-avatar"
                       accept="image/*"
                       :class="{ 'is-invalid': form.$errors.has('avatar') }"
                       @change="user.avatar = $event.target.files[0]">
                <label class="custom-file-label" for="input-avatar">Choose image...</label>

                <!-- Display all errors for a field -->
                <div class="invalid-feedback" v-show="form.$errors.has('avatar')">
                    <div v-for="message in form.$errors.get('name')">{{ message }}</div>
                </div>
            </div>
        </div>

        <!-- Get file upload progress percentage using form.$progress -->
        <div class="progress" v-show="form.$pending">
            <div class="progress-bar" :style="{ width: form.$progress + '%' }">{{ form.$progress }}%</div>
        </div>

        <!-- Prevent re-submit using form.$pending -->
        <button type="submit" :disabled="form.$pending">Submit</button>
    </form>
</template>

<script>
    import Form from 'laravel-form-validation';

    export default {
        data() {
            return {
                user: {name: 'Joy', avatar: null},
                form: new Form()
            }
        },

        methods: {
            submit() {
                this.form.post('/profile', this.user)
                    .then(response => {
                        // This is the data returned from your server
                        console.log(response);
                    })
                    .catch(error => {
                        // Handle errors
                    });
            }
        }
    }
</script>

API

You can take a look at individual classes and their methods

Vue.js helpers

This package comes with two helpers to work with bootstrap css

Register in one shot

You can register the component and directive

import {VueFormPlugin} from "laravel-form-validation";

Vue.use(VueFormPlugin)

IsInvalid directive

Setup global directive manually

import {IsInvalidDirective} from 'laravel-form-validation';

Vue.directive('invalid', IsInvalidDirective);

Use on form inputs, you must specify name attribute on your input fields

<input type="email" v-invalid="form.$errors" name="email">

FieldError component

Setup global component manually

import {FieldErrorComponent} from 'laravel-form-validation';

Vue.component('field-error', FieldErrorComponent);

Use in forms to show validation message for specific field

<field-error :bag="form.$errors" field="email"></field-error>

Customize axios instance (optional)

The package uses axios for making AJAX requests, you can pass your own axios instance and Form class will start using it.

// app.js
import axios from 'axios';
import Form from 'laravel-form-validation';
// Make your modifications
axios.defaults.headers.common['X-CSRF-TOKEN'] = window.Laravel.csrfToken;
axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';
Form.$defaults.axios = axios;

Acknowledgements

This package is highly inspired by various other similar implementations:

Testing

  • This package is using Jest for testing.
  • Tests can be found in __test__ folder.
  • Execute tests with this command npm test

License

MIT License

Package Sidebar

Install

npm i laravel-form-validation

Weekly Downloads

12

Version

1.3.0

License

MIT

Unpacked Size

53 kB

Total Files

23

Last publish

Collaborators

  • ankurk91