twitter-bootstrap-rails 3.2.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82ad6c5731f1ecdfde3cee21594dd12e08611dcb
-  data.tar.gz: b888d8740cf6fd54bef26a89661ad125cdb68d97
+  metadata.gz: 95c5367e90ff42aa6e3e6f34f994dfe7b5bf3385
+  data.tar.gz: 94de97bcb6dc03f1c2cfd67a4f0500816cf0ea79
 SHA512:
-  metadata.gz: 704e53996debd340259fd22ec6ce0afc7c05ff0113c4f05d921785026b1b5ec91279d726f050627461aa9df38121f0ecad07da1bf278b1c20f3e1798de976675
-  data.tar.gz: ab95adbd943737c5f3074cbc01a06a1cb221db3c0a76f4ad855c807874e67a30c62071498a55e368e91244b3b5985967312218da2baa6b79b99bc530f84a2fe6
+  metadata.gz: a00ee57e25ff5b706d2075b0226f101eb4932001ec4f8dc088e488c99ac3c9d3ff27e4a4e51308ea0c2f8b809fd76621abb05630719ce103f39a9f3dc8e864cc
+  data.tar.gz: 650348b073474697a89bd68085524cad957b364c146e91d4da876d1b579707c79636b96a2f803602a72926e6c79ad855a5454dfb6e29a8e8946f2b6567c765f7

data/README.md

@@ -1,5 +1,6 @@
-# Twitter Bootstrap for Rails 4, 3.x 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.
+# Twitter Bootstrap for Rails 5 and Rails 4 Asset Pipeline
+
+Bootstrap is a toolkit from Twitter designed to kickstart development of web apps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.
 
 twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails Asset Pipeline (Rails 4, 3.x versions are supported)
 
@@ -7,19 +8,21 @@ twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails Asset
 [![Dependency Status](https://gemnasium.com/seyhunak/twitter-bootstrap-rails.svg?travis)](https://gemnasium.com/seyhunak/twitter-bootstrap-rails?travis)
 [![Code Climate](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails/badges/gpa.svg)](https://codeclimate.com/github/seyhunak/twitter-bootstrap-rails?branch=master)
 [![Coverage Status](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)](https://coveralls.io/repos/seyhunak/twitter-bootstrap-rails/badge.png?branch=master)
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/seyhunak/twitter-bootstrap-rails/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+[![GitHub stars](https://img.shields.io/github/stars/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/network)
+[![GitHub issues](https://img.shields.io/github/issues/seyhunak/twitter-bootstrap-rails.svg)](https://github.com/seyhunak/twitter-bootstrap-rails/issues)
 
 ## Screencasts
 #### Installing twitter-bootstrap-rails, generators, usage and more
 <img width="180" height="35" src="http://oi49.tinypic.com/s5wn05.jpg"></img>
 
-Screencasts provided by <a href="http://railscasts.com">Railscasts</a> (Ryan Bates)
+Screencasts provided by <a href="http://railscasts.com">RailsCasts</a> (Ryan Bates)
 
 [Twitter Bootstrap Basics](http://railscasts.com/episodes/328-twitter-bootstrap-basics "Twitter Bootstrap Basics")
 in this episode you will learn how to include Bootstrap into Rails application with the twitter-bootstrap-rails gem.
 
 [More on Twitter Bootstrap](http://railscasts.com/episodes/329-more-on-twitter-bootstrap "More on Twitter Bootstrap")
-in this episode continues on the Bootstrap project showing how to display flash messages, add form validations with SimpleForm, customize layout with variables, and switch to using Sass.
+in this episode continues on the Bootstrap project showing how to display flash messages, add form validations with SimpleForm, customise layout with variables, and switch to using Sass.
 (Note: This episode is pro episode)
 
 ## Installing the Gem
@@ -28,7 +31,7 @@ The [Twitter Bootstrap Rails gem](http://rubygems.org/gems/twitter-bootstrap-rai
 
 The plain CSS way is how Bootstrap is provided on [the official website](http://twbs.github.io/bootstrap/).
 
-The [Less](http://lesscss.org/) way provides more customization options, like changing theme colors, and provides useful Less mixins for your code, but requires the
+The [Less](http://lesscss.org/) way provides more customisation options, like changing theme colors and provides useful Less mixins for your code, but requires the
 Less gem and the Ruby Racer Javascript runtime (not available on Microsoft Windows).
 
 ### Installing the Less stylesheets
@@ -123,7 +126,7 @@ You have to require Bootstrap LESS (bootstrap_and_overrides.css.less) in your ap
 
 To use individual components from bootstrap, your bootstrap_and_overrides.less could look like this:
 
-```css
+```less
 // Core variables and mixins
 @import "twitter/bootstrap/variables.less";
 @import "twitter/bootstrap/mixins.less";
@@ -180,7 +183,7 @@ 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:
 
 
-```css
+```less
 @link-color: #ff0000;
 ```
 
@@ -198,48 +201,26 @@ If this is the case, you **must** use @import instead of `*=` in your manifest f
 
 ### Icons
 
-By default, this gem overrides standard Bootstraps's Glyphicons with Font Awesome (http://fortawesome.github.com/Font-Awesome/).
+By default, this gem (when using less generator) won't enable standard Bootstraps's Glyphicons.
 
-This should appear inside _bootstrap_and_overrides *(based on you twitter-bootstrap-rails version)*
+If you would like to restore the default Glyphicons, inside the generated `bootstrap_and_overrides.css.less` uncomment these lines:
 
-**From 2.2.7**
-
-```css
-// Font Awesome
-@fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
-@fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
-@fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
-@fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
-@fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
-@import "fontawesome/font-awesome";
-```
-
-**Before 2.2.7**
+```less
+// Glyphicons are not required by default, uncomment the following lines to enable them.
+@glyphiconsEotPath: font-url("glyphicons-halflings-regular.eot");
+@glyphiconsEotPath_iefix: font-url("glyphicons-halflings-regular.eot?#iefix");
+@glyphiconsWoffPath: font-url("glyphicons-halflings-regular.woff");
+@glyphiconsTtfPath: font-url("glyphicons-halflings-regular.ttf");
+@glyphiconsSvgPath: font-url("glyphicons-halflings-regular.svg#glyphicons_halflingsregular");
 
-```css
-// Font Awesome
-@fontAwesomeEotPath: "/assets/fontawesome-webfont.eot";
-@fontAwesomeEotPath_iefix: "/assets/fontawesome-webfont.eot?#iefix";
-@fontAwesomeWoffPath: "/assets/fontawesome-webfont.woff";
-@fontAwesomeTtfPath: "/assets/fontawesome-webfont.ttf";
-@fontAwesomeSvgPath: "/assets/fontawesome-webfont.svg#fontawesomeregular";
-@import "fontawesome";
+@import "twitter/bootstrap/glyphicons.less";
 ```
 
-If you would like to restore the default Glyphicons, inside the _bootstrap_and_overrides.css.less_ remove the FontAwesome declaration and uncomment the line:
+This gem was used to bundle the excellent [Font-Awesome](http://fortawesome.github.io/Font-Awesome/) library.
+However that was another maintenance effort that is not worth to do here.
 
-```less
-// Font Awesome
-// @fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
-// @fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
-// @fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
-// @fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
-// @fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
-// @import "fontawesome/font-awesome";
-
-// Glyphicons
-@import "twitter/bootstrap/glyphicons.less";
-```
+For Rails projects that need it there is the [font-awesome-rails gem](https://github.com/bokmann/font-awesome-rails) that
+provides same functionality that this gems was used to provide and it also have some other interesting features (e.g. view helpers).
 
 ## Using JavaScript
 
@@ -285,7 +266,7 @@ jQuery ->
 You can create modals easily using the following example. The header, body, and footer all accept content_tag or plain html.
 The href of the button to launch the modal must match the id of the modal dialog. It also accepts a block for the header, body, and footer. If you are getting a complaint about the modal_helper unable to merge a hash it is due to this.
 
-````
+```erb
 <%= content_tag :a, "Modal", href: "#modal", class: 'btn', data: {toggle: 'modal'} %>
 
 <%= modal_dialog id: "modal",
@@ -293,13 +274,12 @@ The href of the button to launch the modal must match the id of the modal dialog
          body:   { content: 'This is the body' },
          footer: { content: content_tag(:button, 'Save', class: 'btn') } %>
 
-````
+```
 
 ### Navbar Helper
 It should let you write things like:
 
-````
-
+```erb
 <%= nav_bar fixed: :top, brand: "Fashionable Clicheizr 2.0", responsive: true do %>
     <%= menu_group do %>
         <%= menu_item "Home", root_path %>
@@ -327,101 +307,105 @@ It should let you write things like:
         <% end %>
     <% end %>
 <% end %>
-
-
-````
+```
 
 ### Navbar scaffolding
 
 In your view file (most likely application.html.erb) to get a basic navbar set up you need to do this:
 
-````
+```erb
 <%= nav_bar %>
-````
+```
 
 Which will render:
 
-    <div class="navbar">
-      <div class="container">
-      </div>
-    </div>
-
+```html
+<div class="navbar">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Fixed navbar
 
 If you want the navbar to stick to the top of the screen, pass in the option like this:
 
-````
+```erb
 <%= nav_bar fixed: :top  %>
-````
+```
 
 To render:
 
-    <div class="navbar navbar-fixed-top">
-      <div class="container">
-      </div>
-    </div>
+```html
+<div class="navbar navbar-fixed-top">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Static navbar
 
 If you want a full-width navbar that scrolls away with the page, pass in the option like this:
 
-````
+```erb
 <%= nav_bar static: :top  %>
-````
+```
 
 To render:
 
-    <div class="navbar navbar-static-top">
-      <div class="container">
-      </div>
-    </div>
-
+```html
+<div class="navbar navbar-static-top">
+  <div class="container">
+  </div>
+</div>
+```
 
 ### Brand name
 
 Add the name of your site on the left hand edge of the navbar. By default, it will link to root_url. Passing a brand_link option will set the url to whatever you want.
 
-````
+```erb
 <%= nav_bar brand: "We're sooo web 2.0alizr", brand_link: account_dashboard_path  %>
-````
+```
 
 Which will render:
 
-    <div class="navbar">
-      <div class="container">
-          <a class="navbar-brand" href="/accounts/dashboard">
-            We're sooo web 2.0alizr
-          </a>
-      </div>
-    </div>
-
+```html
+<div class="navbar">
+  <div class="container">
+      <a class="navbar-brand" href="/accounts/dashboard">
+        We're sooo web 2.0alizr
+      </a>
+  </div>
+</div>
+```
 
 ### Optional responsive variation
 
 If you want the responsive version of the navbar to work (One that shrinks down on mobile devices etc.), you need to pass this option:
 
-````
+```erb
 <%= nav_bar responsive: true %>
-````
-Which renders the html quite differently:
+```
 
+Which renders the html quite differently:
 
-    <div class="navbar">
-      <div class="container">
-        <!-- .navbar-toggle is used as the toggle for collapsed navbar content -->
-        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-          <span class="icon-bar"></span>
-        </button>
-        <!-- Everything in here gets hidden at 940px or less -->
-        <div class="navbar-collapse collapse">
-          <!-- menu items gets rendered here instead -->
-        </div>
-      </div>
+```html
+<div class="navbar">
+  <div class="container">
+    <!-- .navbar-toggle is used as the toggle for collapsed navbar content -->
+    <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+      <span class="icon-bar"></span>
+      <span class="icon-bar"></span>
+      <span class="icon-bar"></span>
+    </button>
+    <!-- Everything in here gets hidden at 940px or less -->
+    <div class="navbar-collapse collapse">
+      <!-- menu items gets rendered here instead -->
     </div>
-
+  </div>
+</div>
+```
 
 ### Nav links
 
@@ -437,8 +421,7 @@ menu_group only takes one argument - :pull - this moves the group left or right
 
 menu_item generates a link wrapped in an li tag. It takes two arguments and an options hash. The first argument is the name (the text that will appear in the menu), and the path (which defaults to "#" if left blank). The rest of the options are passed straight through to the link_to helper, so that you can add classes, ids, methods or data tags etc.
 
-````
-
+```erb
 <%= nav_bar fixed: :top, brand: "Ninety Ten" do %>
     <%= menu_group do %>
         <%= menu_item "Home", root_path %>
@@ -458,14 +441,13 @@ menu_item generates a link wrapped in an li tag. It takes two arguments and an o
         <% end %>
     <% end %>
 <% end %>
-
-````
+```
 
 ### Dropdown menus
 
 For multi-level list options, where it makes logical sense to group menu items, or simply to save space if you have a lot of pages, you can group menu items into drop down lists like this:
 
-````
+```erb
 <%= nav_bar do %>
     <%= menu_item "Home", root_path %>
 
@@ -479,15 +461,13 @@ For multi-level list options, where it makes logical sense to group menu items,
     <%= menu_item "About Us", about_us_path %>
     <%= menu_item "Contact", contact_path %>
 <% end %>
-
-````
+```
 
 ### Dividers
 
 Dividers are just vertical bars that visually separate logically disparate groups of menu items
 
-````
-
+```erb
 <%= nav_bar fixed: :bottom do %>
     <%= menu_item "Home", root_path %>
     <%= menu_item "About Us", about_us_path %>
@@ -499,8 +479,7 @@ Dividers are just vertical bars that visually separate logically disparate group
     <%= menu_item "Account Settings", edit_user_account_path(current_user, @account) %>
     <%= menu_item "Log Out", log_out_path %>
 <% end %>
-
-````
+```
 
 ### Forms in navbar
 
@@ -508,23 +487,23 @@ At the moment - this is just a how to...
 
 You need to add this class to the form itself (Different form builders do this in different ways - please check out the relevant docs)
 
-````css
+```css
 .navbar-form
-````
+```
 To pull the form left or right, add either of these classes:
-````css
+```css
 .pull-left
 .pull-right
-````
+```
 
 If you want the Bootstrap search box (I think it just rounds the corners), use:
-````css
+```css
 .navbar-search
-````
+```
 Instead of:
-````css
+```css
 .navbar-form
-````
+```
 
 To change the size of the form fields, use .span2 (or however many span widths you want) to the input itself.
 
@@ -532,7 +511,7 @@ To change the size of the form fields, use .span2 (or however many span widths y
 
 You can shift things to the left or the right across the nav bar. It's easiest to do this on grouped menu items:
 
-````
+```erb
 <%= nav_bar fixed: :bottom do %>
     <% menu_group do %>
         <%= menu_item "Home", root_path %>
@@ -545,24 +524,22 @@ You can shift things to the left or the right across the nav bar. It's easiest t
         <%= menu_item "Log Out", log_out_path %>
     <% end %>
 <% end %>
-
-````
+```
 
 ### Text in the navbar
 
 If you want to put regular plain text in the navbar anywhere, you do it like this:
 
-````
+```erb
 <%= nav_bar brand: "Apple" do %>
     <%= menu_text "We make shiny things" %>
     <%= menu_item "Home", root_path %>
     <%= menu_item "About Us", about_us_path %>
 <% end %>
+```
 
-````
 It also takes the :pull option to drag it to the left or right.
 
-
 ### Flash helper
 
 Add flash helper `<%= bootstrap_flash %>` to your layout (built-in with layout generator).
@@ -625,6 +602,8 @@ Glyph:
 <%= glyph(:pencil) %> <i class="icon-pencil"></i>
 
 <%= glyph(:pencil, {tag: :span}) %> <span class="icon-pencil"></span>
+
+<%= glyph(:pencil, {class: 'foo'}) %> <i class="icon-pencil foo"></i>
 ```
 
 ### I18n Internationalization Support
@@ -640,23 +619,19 @@ Please see CHANGELOG.md for more details
 ## Contributors & Patches & Forks
 Please see CONTRIBUTERS.md for contributors list
 
-
 ## About Me
-CTO / Senior Developer / Programmer
-@useful (Usefulideas) Istanbul / Turkey
-
+Senior Software Developer
+Istanbul / Turkey
 
 ### Contact me
 Seyhun Akyürek - seyhunak [at] gmail com
 
-
 ## Thanks
 Bootstrap and all twitter-bootstrap-rails contributors
 http://twbs.github.io/bootstrap
 
-
 ## License
-Copyright (c) 2014 Seyhun Akyürek
+Copyright (c) 2017 (since 2012) by Seyhun Akyürek
 
 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.