WiceGrid 技术文档

1. 安装指南

首先，确保你的项目依赖了以下版本的 Rails：

# Rails 7 使用 importmap, HotWire, 和 dartsass-rails
gem 'wice_grid', '~> 7.1'

# Rails 5, 6, 和 7.0 没有 importmap (见下文)
gem 'wice_grid', '~> 6.1'

# Rails 4
gem 'wice_grid', '3.6.2'

接着，在你的 Gemfile 中添加以下内容：

gem "wice_grid"
gem 'font-awesome-sass', github: 'dima4p/font-awesome-sass'

如果项目使用了日期和时间过滤器，需要使用 jQuery Datepicker 或 Bootstrap Datepicker。对于 jQuery Datepicker，添加以下内容：

gem 'jquery-ui-rails', github: 'dima4p/jquery-ui-rails'

对于 Bootstrap Datepicker，添加：

gem 'bootstrap'

执行 bundle install 安装依赖。

运行以下生成器：

rails g wice_grid:install

这会添加一个配置文件：

• config/initializers/wice_grid_config.rb

编辑此文件以定义日期过滤器使用的日期选择器。

在 config/importmap.rb 文件中添加以下内容：

pin "jquery", to: "jquery3.min.js", preload: true
pin "wice_grid", to: "wice_grid.js", preload: true
pin "jquery-ui", to: "jquery-ui.js", preload: true

如果你使用 Bootstrap，还需要添加：

pin "bootstrap", to: "bootstrap.min.js", preload: true
pin "@popperjs/core", to: "popper.js", preload: true

在 app/assets/config/manifest.js 文件中添加：

//= link wice_grid.js
//= link jquery3.min.js
//= link jquery-ui.js
//= link bootstrap.min.js
//= link popper.js

确保在 app/javascript/application.js 中正确引入了所需的库：

import "jquery" // 首先导入
import "jquery-ui"
import "wice_grid"

或者，如果使用 Bootstrap Datepicker：

import "jquery" // 首先导入
import "bootstrap"
import "wice_grid"

在 app/assets/stylesheets/application.scss 中引入 WiceGrid 和 Font Awesome 的 CSS：

@import "wice_grid";
@import "font-awesome";
@import "bootstrap";

2. 项目的使用说明

WiceGrid 是一个用于创建表格的 Rails 插件，支持排序、分页、过滤、导出 CSV 等功能。下面是一个简单的示例：

控制器：

@tasks_grid = initialize_grid(Task)

也可以使用 ActiveRecord::Relation 实例作为第一个参数：

@tasks_grid = initialize_grid(Task.where(active: true))

视图：

<%= grid(@tasks_grid) do |g|

  g.column do |task|
    task.id
  end

  g.column do |task|
    task.title
  end

  g.column do |task|
    task.description
  end

  g.column do |task|
    task.archived? ? 'Yes' : 'No'
  end

  g.column do |task|
    link_to('Edit', edit_task_path(task))
  end
end -%>

g.column 块定义了表格的列，包括列名、排序、过滤和单元格内容。

3. 项目 API 使用文档

WiceGrid 的 API 主要集中在 grid 方法和 column 方法。以下是这些方法的基本使用：

• grid(grid_object, &block): 创建一个表格，grid_object 是通过 initialize_grid 方法初始化的对象，block 用于定义列。
• column(name: nil, attribute: nil, &block): 定义一个列。name 是列标题，attribute 是对应的数据表列名，block 用于定义单元格内容。

更多关于列的配置和过滤选项，请参考官方文档。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。简要步骤如下：

1. 添加 Gemfile 依赖。
2. 运行 bundle install。
3. 运行生成器 rails g wice_grid:install。
4. 编辑配置文件。
5. 添加 JavaScript 和 CSS 文件路径到相应文件中。