Skip to content
Tasty breadcrumbs! Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.
Pull request Compare This branch is 160 commits behind zachinglis:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
tasks
.gitignore
CHANGELOG
MIT-LICENSE
README.textile
Rakefile
VERSION
crummy.gemspec
init.rb

README.textile

Crummy

Introduction

Crummy is a simple and tasty way to add breadcrumbs to your Rails applications.

Install

Simply add the dependency to your Gemfile:

  
    gem "crummy", "~> 1.2"
  

Rails 2

In your terminal, write:

  
    gem install crummy
  

Example

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", :only => "comments") { |instance| instance.send :businesses_comments_path }
      before_filter :load_comment, :only => "show"
      add_crumb :comment, :only => "show"

      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 %>
  

Options for 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 &raquo; 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 breadcrumps.

Examples

 
  render_crumbs                        #=> <a href="/">Home</a> &raquo; <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

Notes

Todo

  • Port over rspecs from project to plugin (Fully tested in a project)
  • 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)

Credits

Copyright © 2008-2011 Zach Inglis, released under the MIT license

Something went wrong with that request. Please try again.