Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
Simply add the dependency to your Gemfile:
gem "crummy", "~> 1.3.5"
In your terminal, write:
gem install crummy
In your controllers you may add_crumb either like a before_filter or within a method (It is also available to views).
class ApplicationController
add_crumb "Home", '/'
end
class BusinessController < ApplicationController
add_crumb("Businesses") { |instance| instance.send :businesses_path }
add_crumb("Comments", : "comments") { |instance| instance.send :businesses_comments_path }
before_filter :load_comment, : "show"
add_crumb :comment, : "show"
# Example for nested routes:
add_crumb(:document) { [:account, :document] }
def show
add_crumb @business.display_name, @business
end
def load_comment
@comment = Comment.find(params[:id])
end
end
Then in your view:
<%= render_crumbs %>
render_crumbs renders the list of crumbs as either html or xml
It takes 3 options
The output format. Can either be :xml or :html or :html_list. Defaults to :html
:format => (:html|:html_list|:xml)
The separator text. It does not assume you want spaces on either side so you must specify. Defaults to » for :html and <crumb> for :xml
:separator => string
Render links in the output. Defaults to true
:links => boolean
:skip_if_blank => true
With this option, output will be blank if there are no breadcrumbs.
render_crumbs #=> <a href="/">Home</a> » <a href="/businesses">Businesses</a>
render_crumbs :separator => ' | ' #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
render_crumbs :format => :xml #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
render_crumbs :format => :html_list #=> <ul class="" id=""><li class=""><a href="/">Home</a></li><li class=""><a href="/">Businesses</a></li></ul>
A crumb with a nil argument for the link will output an unlinked crumb.
With :format => :html_list you can specify additional params: :active_li_class, :li_class, :ul_class, :ul_id
Test library is at Crummy Test
- Accept collections of models as a single argument
- Accept instances of models as a single argument
- Allow for variables in names. (The workaround is to do your own before_filter for that currently)
- Make a crumbs? type method
- Zach Inglis of London Made
- Rein Henrichs
- Les Hill
- Sandro Turriate
- Przemysław Kowalczyk – feature ideas
- Sharad Jain
- Max Riveiro
- Kamil K. Lemański
- Brian Cobb
- Kir Shatrov
- sugilog
- Trond Arve Nordheim
Copyright © 2008-2011 Zach Inglis, released under the MIT license