Low commit activity in last 3 years
A long-lived project that still receives updates
Breadcrumbs is a simple plugin that adds a `breadcrumbs` object to controllers and views.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies
 Project Readme

Breadcrumbs

ruby-tests Gem Gem

Breadcrumbs is a simple plugin that adds a breadcrumbs object to controllers and views.

Instalation

Just run gem install breadcrumbs. Or add gem "breadcrumbs" to your Gemfile.

Usage

On your controller (optional):

class ApplicationController < ActionController::Base
  before_filter :add_initial_breadcrumbs

  private
  def add_initial_breadcrumbs
    breadcrumbs.add "Home", root_path
  end
end

class ThingsController < ApplicationController
  def index
    breadcrumbs.add "Things", things_path
  end
end

You don't need to provide an URL; in that case, a span will be generated instead of a link:

breadcrumbs.add "Some page"

You can set additional HTML attributes if you need to:

breadcrumbs.add "Home", root_path, id: "home", title: "Go to the home page"

On your view (possibly application.html.erb):

<%= breadcrumbs.render %>

You can render as ordered list.

<%= breadcrumbs.render(format: :ordered_list) %>

You can render as inline links.

<%= breadcrumbs.render(format: :inline) %>

You can set your own separator:

<p>
  You are here: <%= breadcrumbs.render(format: :inline, separator: "|") %>
</p>

You can also define your own formatter. Just create a class that implements a render instance method and you're good to go.

class Breadcrumbs::Render::Dl
  def render
    # return breadcrumbs wrapped in a <dl> tag
  end
end

To use your new format, just provide the :format option.

breadcrumbs.render(format: :dl)

I18n

Breadcrumbs is integrated with I18n. You can set translations like:

en:
  breadcrumbs:
    home: "Home"

And then you just call

breadcrumbs.add :home

In fact, you can provide any scope you want.

breadcrumbs.add :"titles.home"

If you don't want to translate a label, just pass the option :i18n as false.

breadcrumbs.add :home, nil, i18n: false

Maintainer

Contributors

Contributing

For more details about how to contribute, please read https://github.com/fnando/breadcrumbs/blob/main/CONTRIBUTING.md.

License

The gem is available as open source under the terms of the MIT License. A copy of the license can be found at https://github.com/fnando/breadcrumbs/blob/main/LICENSE.md.

Code of Conduct

Everyone interacting in the breadcrumbs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.