rails_admin

https://github.com/railsadminteam/rails_admin

Ruby

RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data

TabHelper#nav_link

Navigation link helper

Returns an `li` element with an 'active' class if the supplied
controller(s) and/or action(s) are currently active. The content of the
element is the value passed to the block.

options - The options hash used to determine if the element is "active" (default: {})
          :controller   - One or more controller names to check (optional).
          :action       - One or more action names to check (optional).
          :path         - A shorthand path, such as 'dashboard#index', to check (optional).
          :html_options - Extra options to be passed to the list element (optional).
block   - An optional block that will become the contents of the returned
          `li` element.

When both :controller and :action are specified, BOTH must match in order
to be marked as active. When only one is given, either can match.

Examples

  # Assuming we're on TreeController#show

  # Controller matches, but action doesn't
  nav_link(controller: [:tree, :refs], action: :edit) { "Hello" }
  # => '<li>Hello</li>'

  # Controller matches
  nav_link(controller: [:tree, :refs]) { "Hello" }
  # => '<li class="active">Hello</li>'

  # Several paths
  nav_link(path: ['tree#show', 'profile#show']) { "Hello" }
  # => '<li class="active">Hello</li>'

  # Shorthand path
  nav_link(path: 'tree#show') { "Hello" }
  # => '<li class="active">Hello</li>'

  # Supplying custom options for the list element
  nav_link(controller: :tree, html_options: {class: 'home'}) { "Hello" }
  # => '<li class="home active">Hello</li>'

Returns a list item element String

Source | Google | Stack overflow

Edit

git clone [email protected]:railsadminteam/rails_admin.git

cd rails_admin

open

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-TabHelper-nav_link-for-pr


# Commit to git

git add git commit -m "better docs for TabHelper#nav_link"


# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-TabHelper-nav_link-for-pr

hub pull-request


# Celebrate!