Crumby

A simple breadcrumb plugin for rails

Installation

add to Gemfile

gem 'crumby'

Configuration

Crumby.configure do
  # configure the default renderer
  # renderer = Renderer::Haml
end

Requirements

Example

controller

you can add entries global by before_filter and in each methods/actions

class Addmin::BookController < ApplicationController
  before_filter { add_crumby "Dashboard", :root }
  before_filter { add_crumby "Admin", :admin_root }
  def index
    add_crumby [:admin, :books]
  end
  def show
    add_crumby [:admin, @book]
  end
end

layout

%html
  %head
    %title= crumby_title "The Admin App"
  %body
    #breadcrumb= crumby

add_crumby

add a new entry into breadcrumb trail

add_crumby :books
add_crumby @book
add_crumby [:admin, @book]
add_crumby "Books", :admin_books
add_crumby "Books", [:admin,:books]
add_crumby "Book", [:admin, @book]
add_crumby "Google", "http://google.de"

scopes

You can use scopes to have more than one breadcrumb :subcrumy is equal to “subcrumb”

add_crumby :books, scope: :subcrumb
add_crumby :books, scope: "subcrumb"
crumby :subcrumb
crumby "subcrumb"

History

Roadmap

Maintainers

Contributing to Crumby

Copyright © 2012 Marco Scholl. See LICENSE.txt for further details.