Bootstrap Forms
===============
[![Build Status](https://secure.travis-ci.org/sethvargo/bootstrap_forms.png?branch=master)](http://travis-ci.org/sethvargo/bootstrap_forms)

Bootstrap Forms is a nice Rails generator that makes working with [Bootstrap (by Twitter)](http://twitter.github.com/bootstrap) even easier on Rails.

Forms with Bootstrap are crowded with additional layout markup. While it's necessary, you shouldn't have to type it every time you create a form! That's why I created Bootstrap Forms.

Bootstrap 2.0 Compliant!
------------------------
A super special thanks to [vincenzor](https://github.com/vincenzor) for updating `bootstrap_forms` to comply with the new methods and features in Twitter Bootstrap 2.0.

To get these new features, ensure you are using `bootstrap_forms ~> 2.0.0`.

Note/Caution/Warning
--------------------
There were **major** changes in the release of version `0.1.0`:

 1. The gem name has officially changed from `bootstrap-forms` to `bootstrap_forms` to match gem naming conventions. The old gem still exists on rubygems for legacy applications, however, you should update to the new gem as quickly as possible. It's faster and more stable. The old gem is no longer maintained.
 2. `form_for` is no longer overridden by default. There were multiple users who were concerned that this behavior was ill advised. Instead, a new form helper, `bootstrap_form_for` has been created. This is in line with other form building libraries.
 3. The gem is now a Rails 3 Engine. As such, **Bootstrap Forms will not work in < Rails 3.0**. The engine is automatically mounted when including the gem in your `Gemfile`.

Installation
------------
Add it to your `Gemfile`:

    gem 'bootstrap_forms'

Don't forget to run the `bundle` command. The gem will add the method `bootstrap_form_for` for use in your project. This is different from `bootstrap_forms < 0.1.0`. In previous versions, the default form builders were overridden by default. With backlash from various community members, this is no longer the default.

Be sure to restart your Rails server after installing the gem.

Why?
----
With Bootstrap, you would need the following code for a form:

```haml
/ using HAML
= form_for @model do |f|
  .clearfix
    %label MyLabel
    .input
      = f.text_area :field, :opts => {...}
```

Using Bootstrap Forms, this is **much** simpler:

```haml
/ using HAML
= bootstrap_form_for @model do |f|
  = f.text_area :field, :opts => {...}
```

The custom form builder will automatically wrap everything for you. This helps clean up your view layer significantly!

Additional Form Methods
-----------------------
Just when you thought you were done... Bootstrap Forms includes additional form helpers that make life **a lot** easier! For example, the markup required for a list of checkboxes is quite cumbersome... well, it used to be.

### collection_check_boxes
`collection_check_boxes` behaves very similarly to `collection_select`:

```haml
= f.collection_check_boxes :category_ids, Category.all, :id, :name
```

You can set the `inline` option to build inline checkboxes:

```haml
= f.collection_check_boxes :category_ids, Category.all, :id, :name, :inline => true
```

### collection_radio_buttons
See description above...

```haml
= f.collection_radio_buttons :primary_category_id, Category.all, :id, :name
```

You can set the `inline` option to build inline radios:

```haml
= f.collection_radio_buttons :primary_category_id, Category.all, :id, :name, :inline => true
```

### check_box

Also supports `inline` option:

```haml
= f.check_box :enabled, :inline => true
```

### radio_buttons

```haml
= f.radio_buttons :published, { "Published" => true, "Unpublished" => false }
```

You can set the `:inline` option to build inline radios.

```haml
= f.radio_buttons :published, { "Published" => true, "Unpublished" => false }, { :inline => true }
```

You can set radio options by passing a hash instead of a value:

```haml
= f.radio_buttons :published, { "Published" => true, "Unpublished" => {:value => false, :disabled => true} }
```

Ruby 1.8 doesn't guarantee hashes are ordered. If you care, pass in nested arrays or `ActiveSupport::OrderedHash`.

Uneditable Input
----------------
Bootstrap Forms adds another helper method that generates the necessary markup for uneditable inputs:

```haml
= f.uneditable_input :name
```

yields:

```html
<div class="clearfix">
  <label for="organization_name">Organization Name</label>
  <div class="input">
    <span class="uneditable-input">The Variety Hour</span>
  </div>
</div>
```

Submit Tag
----------
Bootstrap Forms also adds a default actions panel when you call `f.actions`:

```haml
= f.actions
```

generates:

```html
<div class="actions">
  <input type="submit" value="..." class="btn primary" />
  <a href="..." class="btn">Cancel</a>
</div>
```

You can skip the cancel button by passing the `:include_cancel` button a `false` value.

Pretty swell if you ask me.

Adding More Options
-------------------
You can add as many options to any form helper tag. If they are interpreted by Bootstrap Forms, they are interpreted and rendered in the output. If not, they are passed along as values to the final HTML form object.

### Form Options
<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
    <th>Usage</th>
    <th>Default</th>
  </tr>
  <tr>
    <th>summary_errors</th>
    <td>Show summary errors at the top</td>
    <td><tt>= bootstrap_form_for @thing, summary_errors: false</td></td>
    <td><tt>true</tt></td>
  </tr>
</table>

### Field Options

<table>
  <tr>
    <th>Name</th>
    <th>Description</th>
    <th>Usage</th>
  </tr>
  <tr>
    <th>help_inline</th>
    <td>Add inline help text</td>
    <td><tt>= f.text_field :name, :help_inline => 'help me!'</td></td>
  </tr>
  <tr>
    <th>help_block</th>
    <td>Add block help text (below)</td>
    <td><tt>= f.text_field :name, :help_block => 'help me!'</td></td>
  </tr>
  <tr>
    <th>error</th>
    <td>Styles the field as error (red)</td>
    <td><tt>= f.text_field :name, :error => 'This is an error!'</td></td>
  </tr>
  <tr>
    <th>success</th>
    <td>Styles the field as success (green)</td>
    <td><tt>= f.text_field :name, :success => 'This checked out OK'</td></td>
  </tr>
  <tr>
    <th>warning</th>
    <td>Styles the field as warning (yellow)</td>
    <td><tt>= f.text_field :name, :warning => 'Take a look at this...'</td></td>
  </tr>
  <tr>
    <th>prepend</th>
    <td>Adds special text to the front of the input</td>
    <td><tt>= f.text_field :name, :prepend => '@'</td></td>
  </tr>
  <tr>
    <th>append</th>
    <td>Adds special text at the end of the input</td>
    <td><tt>= f.text_field :name, :append => '@'</td></td>
  </tr>
  <tr>
    <th>append_button</th>
    <td>
      Adds the given button to the end of the input. The value is a hash.<br/>
      :label is the button label<br/>
      :icon adds an icon before the label<br/>
      :class has a default value of 'btn'<br/>
      :type has a default value of 'button'<br/>
      Any other entries are passed directly to Rails's tag helper.
    </td>
    <td><tt>= f.text_field :name, :append_button => { :label => 'Button label', :icon => 'icon-plus', :type => 'button' }</td></td>
  </tr>
  <tr>
    <th>label</th>
    <td>Customize the field's label. Pass false to have no label.</td>
    <td><tt>= f.text_field :name, :label => 'Other name'</td></td>
  </tr>
  <tr>
    <th>control_group</th>
    <td>Pass false to remove the control group and controls HTML, leaving only the label and input.</td>
    <td><tt>= f.text_field :name, :control_group => false</tt></td>
  </tr>
  <tr>
    <th>:required => false</th>
    <td>Pass false to ignore presence validation checks that add a required attribute on the generated element.</td>
    <td><tt>= f.text_field :name, :required => false</tt></td>
  </tr>
</table>

Internationalization/Custom Errors
----------------------------------
As of `1.0.2`, `bootstrap_forms` supports I18n! More support is being added, but you can change the error header and cancel button like this:

```yaml
# config/locales/en.yml
en:
  bootstrap_forms:
    errors:
      header: 'Your %{model} is wrong!'
    buttons:
      cancel: 'Forget it!'
```

Obviously you can also change to a different `lang.yml` file and use the same syntax.

Nested Forms
------------
Bootstrap Forms works with [Ryan Bates' nested_form](https://github.com/ryanb/nested_form) out of the box. Just add `nested_form` to you Gemfile and `bootstrap_forms` will automatically add a builder for you:

```haml
= bootstrap_nested_form_for @model do |f|

```

Contributing
------------
I'm pretty dam active on github. Fork and submit a pull request. Most of my pull requests are merged the same day. Make sure you:

 - **Squash** into a single commit (unless it makes sense to have multiple commits)
 - **Test/Spec** the changes
 - **Document** your changes

License & Authors
-----------------
- Author:: Seth Vargo (sethvargo@gmail.com)

```text
Copyright 2012-2013 Seth Vargo <sethvargo@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```