Loaf 项目技术文档

1. 安装指南

在您的 Rails 项目中添加 Loaf Gem：

gem "loaf"

执行以下命令安装 Gem：

$ bundle

或者直接安装：

gem install loaf

然后运行生成器：

rails generate loaf:install

2. 项目使用说明

Loaf 允许您在控制器和视图中添加面包屑导航。

控制器中使用

在控制器中使用 breadcrumb 方法添加面包屑。

class Blog::CategoriesController < ApplicationController

  breadcrumb "文章分类", :blog_categories_path, only: [:show]

  def show
    breadcrumb @category.title, blog_category_path(@category)
  end
end

视图中使用

在视图中使用 breadcrumb_trail 渲染面包屑导航。

<% breadcrumb_trail do |crumb| %>
  ...
<% end %>

3. 项目API使用文档

3.1 breadcrumb

breadcrumb 方法用于创建面包屑。

breadcrumb "名称", "路径"

路径可以使用 Rails 的约定，也可以是动态的。

3.1.1 控制器内使用

可以在控制器内设置面包屑，它们会被继承，并在每个面包屑路径中作为第一个元素。

class ApplicationController < ActionController::Base
  breadcrumb "首页", :root_path
end

3.1.2 视图内使用

在视图中也可以使用 breadcrumb 辅助方法。

<% breadcrumb @category.title, blog_category_path(@category) %>

3.1.3 match 选项

使用 :match 选项定义面包屑的匹配条件。

breadcrumb "新文章", new_post_path, match: :exact

3.2 breadcrumb_trail

breadcrumb_trail 视图辅助方法用于显示面包屑。

可以使用块来迭代每个面包屑：

<% breadcrumb_trail do |crumb| %>
  ...
<% end %>

也可以返回一个枚举器，用于访问所有面包屑。

4. 项目安装方式

请参考安装指南部分，安装 Loaf Gem 并运行生成器。

以上就是关于 Loaf 项目的技术文档，帮助您更好地了解和使用该项目。