https://github.com/blaknite/crumpet
Simple breadcrumbs for Rails
https://github.com/blaknite/crumpet
breadcrumbs rails
Last synced: 3 months ago
JSON representation
Simple breadcrumbs for Rails
- Host: GitHub
- URL: https://github.com/blaknite/crumpet
- Owner: blaknite
- License: mit
- Created: 2017-05-10T01:01:32.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T01:01:13.000Z (9 months ago)
- Last Synced: 2024-12-20T15:50:00.347Z (6 months ago)
- Topics: breadcrumbs, rails
- Language: Ruby
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Crumpet
[](https://buildkite.com/blaknite/crumpet)
Simple breadcrumbs for Rails.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'crumpet'
```
And then execute:
$ bundle
## Usage
Basic usage:
```ruby
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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).