Crummy 项目使用教程

Crummy 项目使用教程

crummy Tasty breadcrumbs! Crummy is a simple and tasty way to add breadcrumbs to your Rails applications. 项目地址: https://gitcode.com/gh_mirrors/cr/crummy

1、项目介绍

Crummy 是一个用于在 Rails 应用程序中添加面包屑导航的简单且高效的工具。面包屑导航是一种用户界面元素，用于显示用户当前页面的路径，帮助用户更好地理解他们在网站中的位置，并方便他们快速导航到上级页面。Crummy 通过提供一个易于使用的 API，使得在 Rails 应用程序中实现面包屑导航变得非常简单。

2、项目快速启动

安装

首先，将 Crummy 添加到你的 Gemfile 中：

gem "crummy", "~> 1.8.0"

然后运行 bundle install 来安装 Crummy。

配置

在你的 Rails 应用程序中，你可以在控制器中使用 add_crumb 方法来添加面包屑。例如，在 ApplicationController 中添加一个基本的面包屑：

class ApplicationController < ActionController::Base
  add_crumb "Home", '/'
end

在其他控制器中，你可以继续添加更多的面包屑：

class BusinessController < ApplicationController
  add_crumb "Businesses", businesses_path
  add_crumb "Comments", businesses_comments_path, only: "comments"

  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

渲染面包屑

在视图中，使用 render_crumbs 方法来渲染面包屑：

<%= render_crumbs %>

3、应用案例和最佳实践

应用案例

假设你正在开发一个电子商务网站，用户可以在网站上浏览不同的商品类别和商品详情。通过使用 Crummy，你可以轻松地为用户提供面包屑导航，帮助他们快速回到上级页面。

例如，在商品详情页面中，你可以添加如下面包屑：

class ProductsController < ApplicationController
  add_crumb "Home", '/'
  add_crumb "Categories", categories_path
  add_crumb @category.name, category_path(@category)
  add_crumb @product.name, product_path(@product)
end

最佳实践

1. 保持简洁：面包屑导航应该简洁明了，避免添加过多的层级，以免影响用户体验。
2. 动态生成：根据用户的实际路径动态生成面包屑，确保用户能够准确地看到他们在网站中的位置。
3. 国际化支持：如果你的应用程序支持多语言，确保面包屑的文本能够根据用户的语言设置进行本地化。

4、典型生态项目

Crummy 作为一个专注于面包屑导航的工具，通常与其他 Rails 生态项目结合使用，以增强用户体验。以下是一些典型的生态项目：

1. Devise：用于用户认证，确保用户在登录后能够通过面包屑导航快速回到之前的页面。
2. ActiveAdmin：用于管理后台，通过面包屑导航帮助管理员快速定位到不同的管理页面。
3. SimpleForm：用于表单生成，结合面包屑导航，帮助用户在填写表单时快速回到上级页面。

通过结合这些生态项目，Crummy 能够为 Rails 应用程序提供更加完善的用户导航体验。

crummy Tasty breadcrumbs! Crummy is a simple and tasty way to add breadcrumbs to your Rails applications. 项目地址: https://gitcode.com/gh_mirrors/cr/crummy