# SimpleNavigationRenderers [![Build Status](https://travis-ci.org/ShPakvel/simple_navigation_renderers.png?branch=master)](https://travis-ci.org/ShPakvel/simple_navigation_renderers) This gem adds several [Simple Navigation](https://github.com/andi/simple-navigation) renderers. For now, it is include renderers for: * [Bootstrap 2 navigation](http://getbootstrap.com/components/#navbar) * [Bootstrap 3 navigation](http://getbootstrap.com/2.3.2/components.html#navbar) With these renderers you will be able create **any bootstrap navigation elements**, such as: **submenus**, **dividers**, **headers**. As well as add **icons** to menu elements, such as: gliphicons, font-awesome icons, even custom icons. Also you have **split** option for main menu containing submenu. ## Installation Add this line to your application's Gemfile: ```ruby gem 'simple_navigation_renderers' ``` and then execute: ```console $ bundle ``` Or install it yourself as: ```console $ gem install simple_navigation_renderers ``` ## Usage ### Simply set up renderer and you are done!! There are two ways to say that you want to use any of renderers. 1. You can specify it in you view as a parameter to `render_navigation`: ```erb ... <%= render_navigation( expand_all: true, renderer: :bootstrap3 ) %> ... ``` 2. Or you can set it in the very navigation configuration file (e.g. `config/navigation.rb`): ```ruby SimpleNavigation::Configuration.run do |navigation| navigation.renderer = SimpleNavigationRenderers::Bootstrap2 # navigation itself goes here... end ``` ### Explicit example of using all features I think you already using `simple-navigation` gem and know how to define navigation items. If not, you can always look at the [configuration instructions](https://github.com/andi/simple-navigation/wiki/Configuration) on the Simple Navigation wiki or read comments and examples in the generated by default `config/navigation.rb` file. In addition to standard options you can use ones specific for Bootstrap renderers. Lets look at the example: ```ruby SimpleNavigation::Configuration.run do |navigation| navigation.renderer = SimpleNavigationRenderers::Bootstrap3 navigation.items do |primary| primary.item :news, {icon: "fa fa-fw fa-bullhorn", text: "News"}, news_index_path, highlights_on: :subpath primary.item :concerts, "Concerts", concerts_path, highlights_on: :subpath primary.item :video, "Video", videos_path, highlights_on: :subpath primary.item :info, {icon: "fa fa-fw fa-book", title: "Info"}, info_index_path, divider: true, split: true, highlights_on: :subpath do |info_nav| info_nav.item :main_info_page, "Main info page", info_path(:main_info_page) info_nav.item :about_info_page, "About", info_path(:about_info_page) info_nav.item :misc_info_pages, "Misc.", divider: true do |misc_page| misc_page.item :header_misc_pages, "Misc. Pages", header: true Info.all.each do |info_page| misc_page.item :"#{info_page.permalink}", info_page.title, info_path(info_page) end end info_nav.item :contact_info_page, "Contact", info_path(:contact_info_page), divider: true end end end ``` #### Features Specific options used in the example: * `:split` - Use it to split first level item link with caret. If you add `split: true` option to item, then caret itself will toggle first level submenu and link will have standard behaviour, instead of toggle submenu. You can use `:split` only with first level items, for the rest it will not do anything. * `:divider` - Use it to add Bootstrap divider before item. if you add `divider: true` option to first level item, then it will first create addition li-tag with `divider-vertical` Bootstrap 2 class and after that create li-tag for item itself. (You can add `divider-vertical` class to Bootstrap 3 - see below) For the second level item and deeper it will create li-tag with class `divider` (the same in Bootstrap 2 and 3) * `:header` - Use it to add Bootstrap menu header. If you add `header: true` option to item, then all parameters, except `:name` and `:divider` option, will be ignored. You can use `:header` only with submenus, for the first level items it will not do anything. * `:name hash` - Use it in place of `:name` if you want. Hash can have three keys: `:text`, `:icon` and `:title`, which is only recognized. You can use it together or separatly, but at least one of `:text` and `:icon` parameters should be provided. For example: * `{text: "News", icon: "fa fa-fw fa-bullhorn"}` will create Font Awesome icon and add text after it (name of the item) * `{icon: "glyphicon glyphicon-book", title: "Info"}` will create Bootstrap icon with title without any text after it #### Notes 1. Bootstrap 3 has only one level submenu. If you want to use nested submenus as in example above, import `bootstrap2_dropdown_submenu.css.scss` file into your Sass file (e.g. `application.css.scss`) as following: ```scss @import "bootstrap2_dropdown_submenu"; ``` 2. Bootstrap 3 has not `divider-vertical` class. If you want to use it as in example above, import `bootstrap2_navbar_divider_vertical.css.scss` file: ```scss @import "bootstrap2_navbar_divider_vertical"; ``` 3. You may also want to include following file which changes some first level submenu style: ```scss @import "simple_navigation_bootstrap_overrides"; ``` or you can add them all together: ```scss @import "simple_navigation_bootstrap"; ``` #### Result of the example Thus, above example will produce something like following code: ```html ``` ## Test Just run following commands: ```console $ bundle $ rake ``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request