torgheh/bootmodal

There is no license information available for the latest version (v0.1.0) of this package.

v0.1.0 2017-05-17 22:02 UTC

Requires

• php: >=5.4.0
• illuminate/support: 4.2.*

Unknown License

• Torgheh

README

Bootmodal makes it easier for Laravel (currently only for Laravel 4.2) back-end and front-end developers to use Bootstrap modals. In administration interfaces modal dialogs are widely used but implementing them is always time consuming and involves lots of repetition especially if the requests are made through AJAX.
Bootmodal Laravel package provides back-end and front-end classes and plug-ins to accelerate this process.

Installation

Composer

"require": {
    "torgheh/bootmodal": "v0.1.0"
}

Then run the composer update.

Laravel configuration

Add the Bootmodal service provider to the providers array in app/cofig/app.php:

	'Torgheh\Bootmodal\BootmodalServiceProvider'

Next under the aliases array in app/cofig/app.php, you may add the Modal facade.

	'Modal'  => 'Torgheh\Bootmodal\Facades\Modal',

Finally to move the package Javascript asset to the public folder run the follwoing command.

php artisan asset:publish torgheh/bootmodal

The Javascript plugin must be added to the front-end layout.1

<script src="{{asset('packages/torgheh/bootmodal/bootmodal.js')}}" ></script>

Backend

Modal

In your controller the same way you make views in Laravel you can make modal views and return an Ajax response. The view should extend the default Bootmodal::layout.

return \Modal::make('dialogs.login')->with('data', $data);

You can also add validation errors and the old input data to the modal view. This is useful when you have Ajax form validation inside your modal.

return \Modal::make('dialogs.login')->withInput()->withErrors($validation);

Redirect

In some cases you might want to go from an Ajax response to a normal redirect, for instance after a successful sign in.

return \Modal::redirect($url);

You can also add the Laravel session data to the redirect response the same way Laravel works.

retun \Modal::redirect($url)->withError($validator)->with('message', 'error');

Options

Some of the Bootstrap modal options are adjustable through the Modal object:

• size: size of the dialog (normal, lg or sm)
• title: modal title
• animation: modal animation
• dismiss: dismiss button

return \Modal::make('dialogs.login')->with('data', $data)->setOption('size', 'sm')->setOption('title', 'Login');

View

The view extends on the bootmodal::layout. There are three sections in a Bootstrap modal that can be extended: modal-body and modal-footer or using modal-content you can replace the entire modal content.

Frontend

<script src="{{asset('packages/torgheh/bootmodal/bootmodal.js')}}" ></script>

Data attributes

You can bind two types of events to your HTML elements that will trigger the Bootmodal, click and submit.

Click:

<a href="#" data-action="{{url('login')}}" data-toggle="bootmodal">Login</a>

This will create and show a modal dialog directed through data-action attributes.

Sumbit:

<form action="{{url('login')}} method="post" data-toggle="bootmodal">

This will send an Ajax post request to the action attribute.

Two data attributes are necessary, data-toggle="bootmodal" and data-action for buttons.

JavaScript

You can also enable bootmodal through Javascript for forms and buttons.

$('#login-button').bootmodal();
$('#login-form').bootmodal();

Options

There are only two options available, the modal container which is the HTML body and Ajax cache option which is false, both by default.

$('#edit-button').bootmodal({ container: $('#modal-container') });
$('#tos-button').bootmodal({ cache: true });

Example

View

views/dialogs/login.blade.php

@extends('bootmodal::layout')
@section('modal-content')
	<div class="modal-header">
		<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
		<h4 class="modal-title" >Login</h4>
	</div>

	<form id="login-form" action="{{url('login')}}" method="post" data-toggle="bootmodal">
		<div class="modal-body">
			<ul id="errors">
				@foreach($errors->all() as $error )
					<li>{{$error}}</li>
				@endforeach
			</ul>

			<label class="control-label">
			Email: <input type="text" class="form-control" name="email" value="{{\Input::old('email')}}">
			</label>

			<label class="control-label">
			Password: <input type="password" class="form-control" name="password">
			</label>
		</div>
		<div class="modal-footer text-right" >
			<input type="submit" class="btn btn-default" value="login">
		</div>

	</form>
@stop

Controller

controllers/AuthController.php

<?php
class AuthController extends BaseController
{
	public function showLoginDialoge()
	{
		$foo = '';
		return \Modal::make('dialogs.login', compact('foo'));
	}
	public function postLogin()
	{
		$rules = ['email'=>'required|email', 'password'=>'required' ];
		$validator = \Validator::make(\Input::all(), $rules);
		
		if($validator->passes()){
		
			///authentication process
			return \Modal::redirect('home')->with('message', 'Successful login');
		}
		return \Modal::make('dialogs.login')->withErrors($validator)->withInput();
	}
	...
}

Routes

Route::get('login', array( 'uses'=>'AuthController@showLoginDialoge') );
Route::post('login', array( 'uses'=>'AuthController@postLogin') );

front-end

<a href="#" data-action="{{url('login')}}" data-toggle="bootmodal">Login</a>