Helpers to generate a Twitter Bootstrap style navbar
This gem only provides a helper module with methods to generate HTML. It can be used by other gems to make these helpers available to a framework's rendering engine, e.g.:
In short: Unless you know what you're doing, do not use this gem directly in your app!
Only Bootstrap >= 2.1.0 is supported. It might work with earlier versions as well though.
BootstrapNavbar needs to know what version of Bootstrap it's dealing with since each version has small changes compared to the previous one.
BootstrapNavbar.configure do |config| config.bootstrap_version = '3.0.0' end
BootstrapNavbar has to be able to query for the current URL when rendering the navbar, e.g. to determine if a menu item is active or not. Since the way the current URL is determined varies depending on whether you use Rails, Sinatra, etc., this has to be set beforehand in some kind of initializer:
# For Rails >= 3.2 BootstrapNavbar.configure do |config| config.current_url_method = 'request.original_url' end
current_url_method should be set to a string which can be
If the framework or rendering engine that you use BootstrapNavbar with escapes HTML by default, you can instruct BootstrapNavbar to mark the returned HTML as html_safe by default by overriding
# For Rails module BootstrapNavbar::Helpers def prepare_html(html) html.html_safe end end
# For Rails ActionView::Base.send :include, BootstrapNavbar::Helpers
Since the navbar format changed quite a bit between Bootstrap 2.x and 3.x, generating them using this gem is quite different as well. Check out the Wiki pages for detailed instructions:
git checkout -b my-new-feature)
git commit -am 'Add some feature')
git push origin my-new-feature)