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 ~> 1.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 2 methods `bootstrap_form_for` and `bootstrap_fields_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 ``` ### collection_radio_buttons See description above... ```haml = f.collection_radio_buttons :primary_category_id, Category.all, :id, :name ``` Uneditable Field ---------------- Bootstrap Forms adds another helper method that generates the necessary markup for uneditable fields: ```haml = f.uneditable_field :name ``` yields: ```html
Name | Description | Usage |
---|---|---|
help_inline | Add inline help text | = f.text_field :name, :help_inline => 'help me!' |
help_block | Add block help text (below) | = f.text_field :name, :help_block => 'help me!' |
error | Styles the field as error (red) | = f.text_field :name, :error => 'This is an error!' |
success | Styles the field as success (green) | = f.text_field :name, :success => 'This checked out OK' |
warning | Styles the field as warning (yellow) | = f.text_field :name, :warning => 'Take a look at this...' |
prepend | Adds special text to the front of the input | = f.text_field :name, :prepend => '@' |
append | Adds special text at the end of the input | = f.text_field :name, :append => '@' |