Home

simple-navigation is a ruby gem for creating navigations (with multiple levels) for your Rails (Tested with versions 3.2 up to 5.2), Sinatra or Padrino applications. You can render your navigation as HTML list, link list or breadcrumbs.

To see the gem/plugin in action please visit the online demo.

Upgrade hint for v4.0.0

This release mainly consists of internal refactorings. However, there is a change in how to set HTML attributes of generated list items and links. To set HTML attributes, use the following options in your navigation.rb file:

primary.item :books, 'Books', books_path, html: {class: 'my-li-class'}, link_html: {class: 'my-link-class'}

Please change your config files accordingly.

Table of contents

• About - what is it and how does it work?
• Installation - how to install the gem in your rails app
• Configuration - how to configure your navigation and determine the active navigation item
• Rendering - how to render your navigation in the views
• Styling - how to style your navigation
• Twitter Bootstrap Integration - how to use simple-navigation with Bootstrap
• Dynamic Navigation Items - how to provide the navigation items dynamically
• Demonstration - a live demonstration of simple-navigation
• FAQ - frequently asked questions
• Help - how to get help
• Who is using it? - A list of sites that are using simple-navigation
• Upcoming Features

Ruby/Rails Compliance

The simple-navigation gem is tested against the following versions of Ruby:

• 2.3.3

and the following versions of Rails:

• last stable 3.2
• last stable 4.1
• last stable 4.2
• last stable 5.2

Credits

We would like to thank the whole community for the feedback and inspiration. Special thanks goes to the following contributors for providing patches, enhancements, ideas and support.

• Simon Courtois
• Markus Schirp
• Jack Dempsey
• Richard Hulse
• Gernot Kogler
• Florian Hanke

Please also check out the complete list of contributors.