Crumbs

Adds a handy crumbs variable available in your views in rails.

Install

Put this line in your Gemfile:

gem 'crumbs'

Then bundle:

$ bundle

Generate the initialization and definition files:

rails g crumbs:install

The defaults configuration values are:

Crumbs.configure do |config|
  config.show_last = false
end

In your config/crumbs.rb file add crumbs referencing the controller and action with the dsl:

Crumbs.define do
  controller :site do
    action :index, 'Home'
  end
end

To translate names you can use the t method (keys starting with dot are prepended with 'crumbs.'):

Crumbs.define do
  controller :site do
    action :index, t('.home')
  end
end

If you don't like to prepend the namespace of the controller:

Crumbs.define do
  namespace :admin do
    controller :products do
      action :index, 'Products'
    end
  end
end

You can use a block for dynamic names, will receive the corresponding url parameters:

Crumbs.define do
  controller :products do
    action :show do |params|
      Product.find(params[:id]).name
    end
  end
end

To disable crumbs for any controller or action:

class Api::BaseController < ApplicationController
  skip_before_action :set_crumbs
end

In your views would be available a crumbs variable:

<% @crumbs.each do |crumb| %>
  &gt; <%= link_to crumb[:name], crumb[:path] %>
<% end %>

If you want to show the last crumb, change the default in your config/initializers/crumbs.rb:

Crumbs.configure do |config|
  config.crumbs.show_last = true
end

This gem is maintained and funded by mmontossi.

It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.