ferdinandfrank/vue-forms

A collection of vue.js form and input components to create pretty ajax requests.

Installs: 79

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 4

Forks: 0

Open Issues: 0

Language:JavaScript

v1.4.1 2018-06-24 12:16 UTC

This package is not auto-updated.

Last update: 2020-11-14 07:53:41 UTC


README

GitHub package version Packagist GitHub license

Warning: This package is not maintained anymore!

This package provides a collection of Vue.js form and input components to create pretty and easy ajax requests on a Laravel application.

Full documentation: https://ferdinandfrank.github.io/vue-forms/

Example

HTML form with two input components which get cleared after the submit. Additionally a success alert message will be shown after the server processed the request.

In your HTML / Blade file:

<ajax-form method="[METHOD]" action="[ACTION]" :clear="true">
    <form-input name="name" label="Name" :value="MyName"></form-input>
    <form-select name="gender" label="Gender" :value="m">
       <option value="m">Male</option>
       <option value="f">Female</option>
    </form-select>
    
    <button type="submit">Submit</button>
</ajax-form>

In your controller method:

public function handleRequest(Request $request) {
   // Handle the request

   return response()->json([
       'alert' => [
           'title'   => 'Success',
           'message' => 'Request was successful!',
           'accept'  => 'Alright!'
       ]
   ]);
}

Requirements

Server Requirements

JS Requirements

There are a few requirements of your Laravel application for the package to work properly on the client side. You can install them by just including the according entries in your package.json file (see Installation #4).

Mandatory

  • Vue.js >= 2.1.10: To render the Vue.js components.
  • Lodash >= 4.17.4: For using JS helper functions in the scripts which makes the code cleaner
  • MomentJS >= 2.18.1: For date formatting on JS
  • JQuery >= 3.1.1: For element selection and ajax requests

Optional

  • Bootstrap >= 3.3.7: For the design of the input components
  • Sweetalert >= 2.0.4: To show pretty alert / confirm messages
  • Tooltip.js >= 1.1.5: To show help texts on the inputs as a pretty tooltip

Optional Requirements

To show a loading icon when a form gets submitted as well as to show a help icon next to the inputs, Font Awesome will be used. Font Awesome need to be installed properly on the application to show these icons. Otherwise the components need to be configured.

The HTML content of the components is designed for the usage with Bootstrap 4. To have a nice design of the inputs out of the box, Bootstrap is required.

Installation

  1. To get started, install the package via the Composer package manager:

    composer require ferdinandfrank/vue-forms
  2. In Laravel >= 5.5 this package registers automatically. For previous Laravel versions add the following entry to your providers array in config/app.php:

    'providers' => [
       ...
       ...
       \FerdinandFrank\VueForms\Providers\VueFormsServiceProvider::class
    ]
  3. Publish the Vue.js components and other scripts to the resources/assets/vendor/vue-forms folder, so you can edit and include the package's files within you application's scripts:

    php artisan vue-forms:init
  4. Add the following entries to the dependencies array in your package.json file, if these do not yet exist. The first four are required, the last four (sweetalert, bootstrap-sass, popper.js, tooltip.js) optional (see Optional Requirements).

    "dependencies": {
        "vue": "^2.1.10",
        "lodash": "^4.17.4",
        "jquery": "^3.1.1",
        "moment": "^2.18.1",
        "sweetalert": "^2.0.4",
        "bootstrap-sass": "^3.3.7",
        "popper.js": "^1.12.5",
        "tooltip.js": "^1.1.5"
      }
    
  5. Include the main JS within your application's script, e.g., from resources/assets/js/app.js copy the following statement:

    require('../vendor/vue-forms/js/vue-forms');
  6. Include the main SCSS within your application's script, e.g., from resources/assets/sass/app.scss copy the following statement:

    @import "../vendor/vue-forms/scss/vue-forms";
  7. Compile your scripts via webpack or any other compiler.

That's it! You can now use the Vue.js components of this package.

Documentation

Click here for the full documentation

License

MIT