BootForms is a Laravel package to rapidly generate markup for standard Bootstrap 3 forms. Probably not perfect for your super custom branded ready-for-release apps, but a huge time saver when you are still in the prototyping stage!
This package forks abandoned Adam Wathan's repository to provide support for newer Laravel versions as well as following changes over the original package:
- support for package autodiscovery
- improved support for IDE autocompletion (using
laravel-ide-helper
) - improved support for model binding
- changed into Laravel-only package to simplify experience even more
- dropped support for Laravel versions older than 5.5
This package supports Laravel autodiscovery so all you have to do is running this command in your terminal in the root of your project:
composer require galahad/bootforms
BootForms lets you create a label and form control and wrap it all in a form group in one call.
// <form method="POST">
// <div class="form-group">
// <label for="field_name">Field Label</label>
// <input type="text" class="form-control" id="field_name" name="field_name">
// </div>
// </form>
{!! BootForm::open() !!}
{!! BootForm::text('Field Label', 'field_name') !!}
{!! BootForm::close() !!}
Note: Don't forget to
open()
forms before trying to create fields! BootForms needs to know if you opened a vertical or horizontal form before it can render a field, so you'll get an error if you forget.
If you need to customize your form elements in any way (such as adding a default value or placeholder to a text element), simply chain the calls you need to make and they will fall through to the underlying form element.
Attributes can be added either via the attribute
method, or by simply using the attribute name as the method name.
// <div class="form-group">
// <label for="first_name">First Name</label>
// <input type="text" class="form-control" id="first_name" name="first_name" placeholder="John Doe">
// </div>
BootForm::text('First Name', 'first_name')->placeholder('John Doe');
// <div class="form-group">
// <label for="color">Color</label>
// <select class="form-control" id="color" name="color">
// <option value="red">Red</option>
// <option value="green" selected>Green</option>
// </select>
// </div>
BootForm::select('Color', 'color')->options(['red' => 'Red', 'green' => 'Green'])->select('green');
// <form method="GET" action="/users">
BootForm::open()->get()->action('/users');
// <div class="form-group">
// <label for="first_name">First Name</label>
// <input type="text" class="form-control" id="first_name" name="first_name" value="John Doe">
// </div>
BootForm::text('First Name', 'first_name')->defaultValue('John Doe');
For more information about what's possible, check out the documentation for the basic Forms package.
Typical Bootstrap form boilerplate might look something like this:
<form>
<div class="form-group">
<label for="first_name">First Name</label>
<input type="text" class="form-control" name="first_name" id="first_name">
</div>
<div class="form-group">
<label for="last_name">Last Name</label>
<input type="text" class="form-control" name="last_name" id="last_name">
</div>
<div class="form-group">
<label for="date_of_birth">Date of Birth</label>
<input type="date" class="form-control" name="date_of_birth" id="date_of_birth">
</div>
<div class="form-group">
<label for="email">Email address</label>
<input type="email" class="form-control" name="email" id="email">
</div>
<div class="form-group">
<label for="password">Password</label>
<input type="password" class="form-control" name="password" id="password">
</div>
<button type="submit" class="btn btn-default">Submit</button>
</form>
BootForms makes a few decisions for you and allows you to pare it down a bit more:
{!! BootForm::open() !!}
{!! BootForm::text('First Name', 'first_name') !!}
{!! BootForm::text('Last Name', 'last_name') !!}
{!! BootForm::date('Date of Birth', 'date_of_birth') !!}
{!! BootForm::email('Email', 'email') !!}
{!! BootForm::password('Password', 'password') !!}
{!! BootForm::submit('Submit') !!}
{!! BootForm::close() !!}
Another nice thing about BootForms is that it will automatically add error states and error messages to your controls if it sees an error for that control in the error store.
Essentially, this takes code that would normally look like this:
<div class="form-group {!! $errors->has('first_name') ? 'has-error' : '' !!}">
<label for="first_name">First Name</label>
<input type="text" class="form-control" id="first_name">
{!! $errors->first('first_name', '<p class="help-block">:message</p>') !!}
</div>
And reduces it to this:
{!! BootForm::text('First Name', 'first_name') !!}
...with the has-error
class being added automatically if there is an error in the session.
To use a horizontal form instead of the standard basic form, simply swap the BootForm::open()
call with a call to openHorizontal($columnSizes)
instead:
// Width in columns of the left and right side
// for each breakpoint you'd like to specify.
$columnSizes = [
'sm' => [4, 8],
'lg' => [2, 10]
];
{!! BootForm::openHorizontal($columnSizes) !!}
{!! BootForm::text('First Name', 'first_name') !!}
{!! BootForm::text('Last Name', 'last_name') !!}
{!! BootForm::text('Date of Birth', 'date_of_birth') !!}
{!! BootForm::email('Email', 'email') !!}
{!! BootForm::password('Password', 'password') !!}
{!! BootForm::submit('Submit') !!}
{!! BootForm::close() !!}
You can hide labels by chaining the hideLabel()
helper off of any element definition.
BootForm::text('First Name', 'first_name')->hideLabel()
The label will still be generated in the markup, but hidden using Bootstrap's .sr-only
class, so you don't reduce the accessibility of your form.
You can add a help block underneath a form element using the helpBlock()
helper.
BootForm::text('Password', 'password')->helpBlock('A strong password should be long and hard to guess.')
Note: This help block will automatically be overridden by errors if there are validation errors.
BootForms makes it easy to bind an object to a form to provide default values. Read more about it here.
BootForm::open()->action( route('users.update', $user) )->put()
BootForm::bind($user)
BootForm::close()