BreadcrumbsOnRails 使用教程

BreadcrumbsOnRails 使用教程

breadcrumbs_on_railsA simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.项目地址:https://gitcode.com/gh_mirrors/br/breadcrumbs_on_rails

项目介绍

BreadcrumbsOnRails 是一个简单的 Ruby on Rails 插件，用于创建和管理 Rails 项目的面包屑导航。它提供了一系列辅助方法，帮助开发者轻松地在 Rails 应用中创建和管理面包屑导航。

项目快速启动

安装

首先，将以下代码添加到你的 Rails 应用的 Gemfile 中：

gem "breadcrumbs_on_rails"

然后执行以下命令安装依赖：

bundle install

使用

在控制器中，使用 add_breadcrumb 方法来添加面包屑元素。add_breadcrumb 需要两个参数：面包屑的名称和目标路径。

class MyController < ApplicationController
  add_breadcrumb "home", :root_path
  add_breadcrumb "my", :my_path

  def index
    add_breadcrumb "index", index_path
  end
end

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

<%= render_breadcrumbs %>

应用案例和最佳实践

应用案例

假设你正在开发一个电子商务网站，你可以在以下页面中使用面包屑导航：

• 首页：home
• 分类页面：category
• 产品页面：product

class ProductsController < ApplicationController
  add_breadcrumb "home", :root_path
  add_breadcrumb "category", :category_path

  def show
    @product = Product.find(params[:id])
    add_breadcrumb @product.name, product_path(@product)
  end
end

最佳实践

1. 保持简洁：不要在面包屑导航中添加过多的元素，保持导航的简洁性。
2. 使用有意义的名称：确保每个面包屑元素的名称都是有意义的，便于用户理解。
3. 动态生成：根据当前页面的内容动态生成面包屑导航，提高用户体验。

典型生态项目

BreadcrumbsOnRails 可以与其他 Rails 插件和库结合使用，例如：

• JSON-LD 插件：用于生成 JSON-LD 格式的面包屑导航数据，提高 SEO 效果。
• ActiveAdmin：在管理后台中使用面包屑导航，提高管理效率。

JSON-LD 插件

安装 JSON-LD 插件：

gem 'breadcrumbs_on_rails-json_ld'

然后在视图中使用以下代码生成 JSON-LD 格式的面包屑导航数据：

<script type="application/ld+json">
  <%= render_breadcrumbs builder: BreadcrumbsOnRails::JsonLd::Builder %>
</script>

通过以上步骤，你可以在 Rails 项目中轻松实现面包屑导航，并结合其他插件和库，提高项目的可用性和 SEO 效果。

breadcrumbs_on_railsA simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.项目地址:https://gitcode.com/gh_mirrors/br/breadcrumbs_on_rails