Project

crumpet

0.0
No commit activity in last 3 years
No release in over 3 years
Simple breadcrumbs for Rails
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.14
~> 10.0
~> 3.0

Runtime

>= 3
 Project Readme

Crumpet

Build status

Simple breadcrumbs for Rails.

Installation

Add this line to your application's Gemfile:

gem 'crumpet'

And then execute:

$ bundle

Usage

Basic usage:

class ApplicationController
  crumbs do
    add_crumb "Home", root_path
  end
end

class WidgetsController < ApplicationController
  crumbs do
    add_crumb @widget.parent_widget.name, widget_path(@widget.parent_widget)
    add_crumb @widget.name, widget_path(@widget)
  end

  crumbs_for :edit do
    add_crumb 'Edit'
  end
end

Then in the view:

<%= render_crumbs %>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/blaknite/crumpet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.