Twitter Bootstrap RTL(rbootstrap) for Rails 3.1 Asset Pipeline

Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.

rbootstrap project integrates Bootstrap CSS toolkit for Rails 3.1 Asset Pipeline (Rails 3.2 supported)

Screencasts

Installing twitter-bootstrap-rails, generators, usage and more

Screencasts provided by Railscasts (Ryan Bates)

Twitter Bootstrap Basics in this episode you will learn how to include Twitter Bootstrap into Rails application with the twitter-bootstrap-rails gem.

More on Twitter Bootstrap in this episode continues on the Twitter Bootstrap project showing how to display flash messages, add form validations with SimpleForm, customize layout with variables, and switch to using Sass. (Note: This episode is pro episode)

Example Application

An example application is available at toadkicker/teststrap. You can view it running on heroku here. Contributions welcome.

Installing Gem

The gem includes the source LESS and JS files. You'll need to choose a javascript runtime. ExecJS supports these runtimes:

therubyracer - Google V8 embedded within Ruby
therubyrhino - Mozilla Rhino embedded within JRuby
Node.js
Apple JavaScriptCore - Included with Mac OS X
Microsoft Windows Script Host (JScript)

Include the Twitter Bootstrap Rails gem in Gemfile to install it from RubyGems.org:

gem "therubyracer"
gem "less-rails" #Sprockets (what Rails 3.1 uses for its asset pipeline) supports LESS
gem "rbootstrap"

or you can install from latest build;

gem 'rbootstrap', :git => 'git://github.com/jnaqsh/twitter-bootstrap-rails.git'

You can run bundle from command line

bundle install

Installing to App (using Generators)

You can run following generators to get started with Twitter Bootstrap quickly.

Install (requires directives to Asset pipeline.)

Usage:

rails g bootstrap:install

Layout (generates Twitter Bootstrap compatible layout) - (Haml and Slim supported)

Usage:

rails g bootstrap:layout [LAYOUT_NAME] [*fixed or fluid]

Example:

rails g bootstrap:layout application fixed

Themed (generates Twitter Bootstrap compatible scaffold views.) - (Haml and Slim supported)

Usage:

rails g bootstrap:themed [RESOURCE_NAME]

Example:

rails g scaffold Post title:string description:text
rake db:migrate
rails g bootstrap:themed Posts

Notice the plural usage of the resource to generate bootstrap:themed.

Using with Less

Bootstrap was built with Preboot, an open-source pack of mixins and variables to be used in conjunction with Less, a CSS preprocessor for faster and easier web development.

Using stylesheets with Less

You have to require Bootstrap LESS (bootstrap_and_overrides.css.less) in your application.css

/*
 *= require bootstrap_and_overrides
 */

/* Your stylesheets goes here... */

To use individual components from bootstrap, your bootstrap_and_overrides.less could look like this:

@import "twitter/bootstrap/reset.less";
@import "twitter/bootstrap/variables.less";
@import "twitter/bootstrap/mixins.less";
@import "twitter/bootstrap/scaffolding.less";
@import "twitter/bootstrap/grid.less";
@import "twitter/bootstrap/layouts.less";
@import "twitter/bootstrap/type.less";
@import "twitter/bootstrap/forms.less";
@import "twitter/bootstrap/wells.less";
@import "twitter/bootstrap/component-animations.less";
@import "twitter/bootstrap/buttons.less";
@import "twitter/bootstrap/close.less";
@import "twitter/bootstrap/navs.less";
@import "twitter/bootstrap/navbar.less";
@import "twitter/bootstrap/labels-badges.less";
@import "twitter/bootstrap/hero-unit.less";
@import "twitter/bootstrap/utilities.less";
@import "twitter/bootstrap/responsive";

If you'd like to alter Bootstrap's own variables, or define your LESS styles inheriting Bootstrap's mixins, you can do so inside bootstrap_and_overrides.css.less:

@linkColor: #ff0000;

Using Javascripts

You have to require Bootstrap JS (bootstrap.js) in your application.js

//= require twitter/bootstrap

$(document).ready(function(){
  /* Your javascripts goes here... */
});

If you want to customize what is loaded, your application.js would look something like this

#= require jquery
#= require jquery_ujs
#= require twitter/bootstrap/bootstrap-transition
#= require twitter/bootstrap/bootstrap-alert
#= require twitter/bootstrap/bootstrap-modal
#= require twitter/bootstrap/bootstrap-button
#= require twitter/bootstrap/bootstrap-collapse

...and so on for each bootstrap js component.

Using Coffeescript (optionally)

Using Twitter Bootstrap with the CoffeeScript is easy. twitter-bootstrap-rails generates a "bootstrap.js.coffee" file for you to /app/assets/javascripts/ folder.

jQuery ->
  $("a[rel=popover]").popover()
  $(".tooltip").tooltip()
  $("a[rel=tooltip]").tooltip()

Using Helpers

Flash helper

Add flash helper <%= bootstrap_flash %> to your layout (built-in with layout generator)

Changelog

Version 0.0.5 deprecated
Asset files updated to latest and removed version numbers
Implemented Less::Rails Railtie to use with LESS
Fixed railtie to only initialize Less when installed
New branch for the static version of Bootstrap (w/o Less) - check static branch
Added path to support heroku deploy
Rake precompile issue fixed
Updated asset files to 1.4.0
Updated dependency less-rails (now requires 2.1.0)
Added generators
Fixed generators
Fixed class name conflicts from (bootstrap.js.coffee)
Fixed jquery-rails gem version dependency
Updated asset files
Added new generators (install, layout and themed)
Compability to Rails 3.2
Transitioning to 2.0
Released gem v.2.0rc0
Added Haml and Slim support
Added Responsive layout support
Fixes and release 2.0.0
Updated to v2.0.1, versioned v2.0.1.0
Released gem v.2.0.3
Released gem v.2.0.4
Released gem v.2.0.5
Added SimpleForm support
Added FontAwesome support
Released gem v.2.0.6
Released gem v.2.0.7
Released gem v.2.0.8
Released gem v.2.0.9 (Bootstrap 2.0.4 and FontAwesome 2.0 support)
Released gem v.2.1.0 (JRuby support)
Released gem v.2.1.1 (minor fixes)
Flash block message helper added
Released gem v.2.1.2 (minor fixes and updated to Twitter Bootstrap 2.1.0)
Released gem v.2.1.3 (minor fixes and updated to Twitter Bootstrap 2.1.1)
Released gem v.2.1.4 (minor fixes)
Released gem v.2.1.5 (minor fixes, install generator detects javascript template engine, updated to Twitter Bootstrap 2.2.1)
Released gem v.2.1.6 (minor fixes)

Contributors & Patches & Forks

Daniel Morris
Bradly Feeley
Guilherme Moreira
Alex Behar
Brandon Keene
Anthony Corcutt
Colin Warren
Giovanni Cappellotto
Masakuni Kato
Gudleik Rasch
Thomas Volkmar Worm
Thiago Almeida
Sébastien Grosjean
Nick DeSteffen
Christian Joudrey
Todd Baur

Future

Writing tests (not implemented yet)
Markup Helpers (alert, tabs, pagination, breadcrumbs etc.)

Thanks

Twitter Bootstrap and all twitter-bootstrap-rails contributors http://twitter.github.com/bootstrap

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.