Tabs on Rails 使用与安装指南

本文档旨在帮助用户详细理解并使用 Tabs on Rails 项目，该项目是一个用于创建标签页和导航菜单的简单 Rails 插件。以下内容将涵盖安装指南、项目使用说明、项目API使用文档以及安装方式。

1. 安装指南

在开始使用 Tabs on Rails 之前，请确保您的项目满足以下要求：

• Ruby on Rails 版本为 4.2 或 5

对于较旧的 Ruby 或 Rails 版本，请查看 CHANGELOG。

安装步骤

1. 将以下代码添加到您的应用程序的 Gemfile 中：

   gem "tabs_on_rails"
   

2. 执行以下命令以安装依赖项：

   $ bundle
   

如果需要从 Git 仓库获取最新版本，可以使用 Bundler 和 :git 选项。

2. 项目使用说明

在模板中，使用 tabs_tag 辅助方法创建您的标签页。

<%= tabs_tag do |tab| %>
  <%= tab.home      '首页', root_path %>
  <%= tab.dashboard '仪表盘', dashboard_path %>
  <%= tab.account   '账户', account_path %>
<% end %>

以上代码将渲染以下 HTML：

<ul>
  <li><a href="/">首页</a></li>
  <li><a href="/dashboard">仪表盘</a></li>
  <li><a href="/account">账户</a></li>
</ul>

在控制器中，您可以使用 set_tab 方法标记当前标签页。

class DashboardController < ApplicationController
  set_tab :dashboard
end

现在，如果动作属于 DashboardController，模板将自动渲染以下 HTML 代码。

<ul>
  <li><a href="/">首页</a></li>
  <li class="custom"><span>仪表盘</span></li>
  <li><a href="/account">账户</a></li>
</ul>

如果需要在控制器或模板中访问当前标签页的值，可以使用 current_tab 辅助方法。

class DashboardController < ApplicationController
  set_tab :dashboard
end

在视图中：

<p>当前标签页的名称是 <%= current_tab %></p>

3. 项目API使用文档

Tabs on Rails 提供了以下辅助方法和选项来定制标签页的样式和行为：

• tabs_tag: 创建标签页集合。
• tab: 在 tabs_tag 块内创建单个标签页。
• set_tab: 在控制器中设置当前标签页。
• current_tab: 获取当前标签页的名称。

定制标签页

您可以通过传递一个选项哈希来定制标签页的样式和行为。

<%= tabs_tag do |tab| %>
  <%= tab.home      '首页', root_path, style: "padding: 10px" %>
  <%= tab.dashboard '仪表盘', dashboard_path %>
<% end %>

以上代码将渲染以下 HTML：

<ul>
  <li style="padding: 10px"><a href="/">首页</a></li>
  <li class="custom"><span>仪表盘</span></li>
  <li><a href="/account">账户</a></li>
</ul>

定制 open_tabs 和 close_tabs

open_tabs 和 close_tabs 方法可以通过 :open_tabs 和 :close_tabs 选项进行定制。

<%= tabs_tag open_tabs: { id: 'tabs', class: 'cool' } do |tab| %>
  <%= tab.home      '首页', root_path %>
  <%= tab.dashboard '仪表盘', dashboard_path %>
  <%= tab.account   '账户', account_path %>
<% end %>

以上代码将渲染以下 HTML：

<ul id="tabs" class="cool">
  <li><a href="/">首页</a></li>
  <li><a href="/dashboard">仪表盘</a></li>
  <li><a href="/account">账户</a></li>
</ul>

4. 项目安装方式

请参考上述安装指南。

通过本文档，您应该能够顺利地安装和使用 Tabs on Rails 项目，并在您的 Rails 应用程序中创建和管理标签页。如果您遇到任何问题或需要进一步的帮助，请参考项目的 GitHub Issues 页面。