galahad/bootforms

Form builder with Bootstrap-specific conveniences. Remembers old input, retrieves error messages and handles all your boilerplate Bootstrap markup automatically.

Monday, February 19, 2018
by inxilpro
Repository
1 Watchers
6 Stars
1,807 Installations

PHP
0 Dependents
0 Suggesters
106 Forks
0 Open issues
39 Versions
63 % Grown

The README.md

, _(*1)

BootForms

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!, _(*2)

Check out Aire

This package has been replaced by Aire which is a modern form builder with similar features but an improved API, more tests, more documentation, and support for non-Bootstrap themes. It uses Tailwind by default, but has full support for Bootstrap via a plugin., _(*3)

BootForms is no longer actively maintained. I'll try to merge any bugfixes for the forseeable future, but I strongly urge you to check out Aire., _(*4)

Fork

This package forks abandoned Adam Wathan's repository to provide support for newer Laravel versions as well as following changes over the original package:, _(*5)

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

Installation
Using BootForms
Related Resources

Installing with Composer

This package supports Laravel autodiscovery so all you have to do is running this command in your terminal in the root of your project:, _(*6)

composer require galahad/bootforms

Using BootForms

Basic Usage

BootForms lets you create a label and form control and wrap it all in a form group in one call., _(*7)

//  <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., _(*8)

Customizing Elements

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., _(*9)

Attributes can be added either via the attribute method, or by simply using the attribute name as the method name., _(*10)

// 


//    First Name
//    
// 


BootForm::text('First Name', 'first_name')->placeholder('John Doe');

// 


//   Color
//   
// 


BootForm::select('Color', 'color')->options(['red' => 'Red', 'green' => 'Green'])->select('green');

// 

<

form method="GET" action="/users">
BootForm::open()->get()->action('/users');

// 


//    First Name
//    
// 


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., _(*11)

Reduced Boilerplate

Typical Bootstrap form boilerplate might look something like this:, _(*12)

<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:, _(*13)

{!! 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() !!}

Automatic Validation State

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., _(*14)

Essentially, this takes code that would normally look like this:, _(*15)

<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:, _(*16)

{!! BootForm::text('First Name', 'first_name') !!}

...with the has-error class being added automatically if there is an error in the session., _(*17)

Horizontal Forms

To use a horizontal form instead of the standard basic form, simply swap the BootForm::open() call with a call to openHorizontal($columnSizes) instead:, _(*18)


// 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() !!}

Additional Tips

Hiding Labels

You can hide labels by chaining the hideLabel() helper off of any element definition., _(*19)

BootForm::text('First Name', 'first_name')->hideLabel(), _(*20)

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., _(*21)

Help Blocks

You can add a help block underneath a form element using the helpBlock() helper., _(*22)

BootForm::text('Password', 'password')->helpBlock('A strong password should be long and hard to guess.'), _(*23)

Note: This help block will automatically be overridden by errors if there are validation errors., _(*24)

Model Binding

BootForms makes it easy to bind an object to a form to provide default values. Read more about it here., _(*25)

BootForm::open()->action( route('users.update', $user) )->put()
BootForm::bind($user)
BootForm::close()

The Versions

19/02 2018

dev-master

9999999-dev

Form builder with Bootstrap-specific conveniences. Remembers old input, retrieves error messages and handles all your boilerplate Bootstrap markup automatically.

library bootforms

Form builder with Bootstrap-specific conveniences. Remembers old input, retrieves error messages and handles all your boilerplate Bootstrap markup automatically.

galahad/bootforms

The README.md

BootForms

Check out Aire

Fork

Table of Contents

Installing with Composer

Using BootForms

Basic Usage

Customizing Elements

Reduced Boilerplate

Automatic Validation State

Horizontal Forms

Additional Tips

Hiding Labels

Help Blocks

Model Binding

The Versions

dev-master

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

1.1.0

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.10

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.9

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.8

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.7

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.6

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.5

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.4

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.3

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.2

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell

v1.0.1

The Requires

The Development Requires

by Adam Wathan

by Chris Morrell