首页
/ Crummy 面包屑导航技术文档

Crummy 面包屑导航技术文档

2024-12-23 12:02:09作者:瞿蔚英Wynne

本文档将详细介绍如何在 Rails 应用中安装、使用和配置 Crummy 插件,以添加面包屑导航功能。

1. 安装指南

在 Rails 应用的 Gemfile 文件中添加以下依赖项:

gem "crummy", "~> 1.8.0"

然后执行以下命令安装该 gem:

bundle install

2. 项目的使用说明

Crummy 插件允许您在 Rails 控制器和视图中添加和管理面包屑导航。

控制器中使用

在控制器中,您可以使用 add_crumb 方法添加面包屑:

class ApplicationController
  add_crumb "首页", '/'
end

class BusinessController < ApplicationController
  add_crumb("业务", lambda { |instance| instance.businesses_path })
  add_crumb("评论", only: "comments", lambda { |instance| instance.businesses_comments_path })
  before_action :load_comment, only: "show"
  add_crumb :评论, only: "show"

  # 为嵌套路由添加面包屑
  add_crumb(:文档) { [:account, :document] }

  def show
    add_crumb @business.display_name, @business
  end

  def load_comment
    @comment = Comment.find(params[:id])
  end
end

视图中渲染

在视图中,使用 render_crumbs 方法渲染面包屑:

<%= render_crumbs %>

面包屑链接 HTML 选项

您可以通过 link_html_options 方法设置面包屑链接的 HTML 选项:

add_crumb "首页", '/', link_html_options: {title: "我的链接标题"}

使用 HTML 代替文本

您可以在第一个参数中使用 HTML 代替文本。如果 HTML 中包含 <a> 标签,该标签将不会被用作包装器:

add_crumb "<a class='glyphicons shield' href='/support'><i></i>支持</a>".html_safe, "", {}

3. 项目 API 使用文档

以下是 render_crumbs 方法的可用选项:

  • format: 输出格式,可以是 :html:html_list:xml。默认为 :html
  • separator: 分隔符文本。默认为 &raquo;(对于 :html)和 <crumb>(对于 :xml)。
  • links: 是否渲染链接。默认为 true
  • microdata: 是否渲染 Richsnipet。默认为 false
  • last_crumb_linked: 是否链接最后一个面包屑。默认为 true
  • skip_if_blank: 如果没有面包屑,输出为空。默认为 false

以下是一些示例:

render_crumbs                     # => <a href="/">首页</a> &raquo; <a href="/businesses">业务</a>
render_crumbs separator: ' | '    # => <a href="/">首页</a> | <a href="/businesses">业务</a>
render_crumbs format: :xml        # => <crumb href="/">首页</crumb><crumb href="/businesses">业务</crumb>
render_crumbs format: :html_list  # => <ol class="" id=""><li class=""><a href="/">首页</a></li><li class=""><a href="/businesses">业务</a></li></ol>

4. 项目安装方式

请参考上述“安装指南”部分。

以上是 Crummy 面包屑导航插件的技术文档,希望对您在使用该插件时有所帮助。

登录后查看全文
热门项目推荐