NavHighlighter

Tools for highlighting the active item in a nav element.

Usage

In your controllers, call #nav_highlight to specify the name of the nav item that should be highlighted when views from that particular controller are rendered. The name of the nav item to be highlighted will be inferred from the name of the controller, e.g., AuthorsController would map to a nav item named :authors. (This can be configured when calling #nav_highlight.)

class AuthorsController < ApplicationController
  nav_highlight
end

class BooksController < ApplicationController
  nav_highlight
end

class HomeController < ApplicationController
end

Finally, when you render your nav element, use the #nav_item helper. Pass the name of the item using the :name keyword argument. If no name is passed, the nav item will be unnamed. If the nav is rendered from a controller that doesn't call #nav_highlight, the unnamed item will be highlighted. (Item names should be unique within a nav element. This also goes for unnamed items.)

<nav>
  <ul>
    <%= nav_item name: :authors do %>
      <%= link_to 'Authors', :authors %>
    <% end %>
    <%= nav_item name: :books do %>
      <%= link_to 'Books', :books %>
    <% end %>
    <%= nav_item do %>
      <%= link_to 'Misc', root_path
    <% end %>
  </ul>
</nav>

The first nav item will be highlighted when viewing an action in the BooksController, and the second item will be highlighted when viewing an action in the AuthorsController. When viewing an action in a controller which does not call #nav_highlight, the third item will be highlighted by default as it is unnamed.

Custom Configuration

By default, the highlighted nav item will received the CSS class "active". This can be configured by calling NavHighlighter.configure, say, from an initializer.

NavHighlighter.configure do |config|
  # Use "highlight" instead of "active".
  config.highlight_class = 'highlight'
end

Installation

Add this line to your application's Gemfile:

gem 'nav_highlighter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nav_highlighter

Make #nav_highlight available to your controller(s) by extending NavHighlighter::NavHighlighting. To make it available to all controllers, extend it from ApplicationController.

class ApplicationController
  extend NavHighlighter::NavHighlighting
end

Contributing

Contribution directions go here.

License