RailsDatatables 使用与技术文档

2024-12-23 01:27:25作者：胡易黎Nicole

1. 安装指南

在开始使用 RailsDatatables 前，请确保您已经将 jQuery.js 和 jQuery.dataTables.js 放置于 /public/javascripts/ 目录中，并在您的布局文件中引入它们。

2. 项目使用说明

RailsDatatables 为使用 DataTables jQuery 库提供了一个更简单、更符合 Rails 风格的接口。以下是如何在项目中使用它的说明。

设置表格

给表格添加 datatable 类，以便 JavaScript 知道哪些表格需要修改。注意：如果想要在单个页面上使用多个表格，需要在选项哈希中包含 :table_dom_id 来指定要修改的表格 ID。
在表格的表头周围添加 <thead> 标签（这些元素将与下面创建的列数组关联，允许排序）。
在表格行周围添加 <tbody> 标签（这些元素将被排序和分页）。

激活 DataTables

使用 <%= datatable() %> 方法，传入列信息、排序方式和其他设置（如 AJAX 数据源、是否启用搜索、搜索字段标签、处理中显示的图片等）。

<% columns = [{:type => 'html', :class => "first"}, {:type => 'html'}, {:type => 'html'}, {:type => nil, :class => "last"}] %>
<%= datatable(columns, {:sort_by => "[0, 'desc']", :processing => image_tag("spinner.gif") }) %>

表格示例

<table id='users' class='datatable'>
  <thead>
    <tr>
      <th>Name</th>
      <th>Account Level</th>
      <th>Email</th>
      <th>Actions</th>
    </tr>
  </thead>
  <tbody>
    <%- @users.each do |user| -%>
      <tr id="<%= dom_id(user) %>">
        <td><%= user.name %></td>
        <td><%= user.account.account_level.name %></td>
        <td><%= user.email %></td>
        <td><%= link_to "Edit", edit_system_user_path(user) %></td>
      </tr>
    <%- end -%>
  </tbody>
</table>

3. 项目API使用文档

以下是 RailsDatatables 支持的一些选项：

表格选项

:sort_by：数组，默认列编号（0 - n-1）和排序顺序。例如："[2, 'desc']"。默认为初始顺序。
:search：布尔值，是否显示搜索字段。默认为 true。
:search_label：字符串，搜索字段的标签。默认为 "Search"。
:processing：字符串，处理数据时显示的文本或图片。默认为 "Processing"。
:persist_state：布尔值，是否记住用户的表格排序和页面。默认为 true。
:additional_data：哈希，传递额外的数据，如过滤器值。默认为空。
:table_dom_id：字符串，要修改的表格的 ID。如果未传递，则查找类为 'datatable' 的表格。如果要在单个页面上使用多个 DataTables，此选项是必要的。
:per_page：每页显示的行数（从 display_length 更名而来）。
:append：在 dataTable() 调用末尾添加的函数。对于 Datatables 插件很有用。
:no_records_message：如果找不到记录，显示的消息，无论是加载时还是搜索后。
:auto_width：自动调整列宽。默认为 true。
:row_callback：在表中的每一行上运行的函数。插入到 "'fnRowCallback': function( nRow, aData, iDisplayIndex ) { }" 中。更多信息请参考 fnRowCallback 文档。

列选项

:class：字符串，要分配给表单元格的类。默认为无。
:type：字符串，列中的内容类型，对于非 AJAX 表格。'html' 会移除所有 HTML 并根据 inner value 字符串排序。默认为字符串。
:sortable：布尔值，是否允许此列排序。默认为 true。
:searchable：布尔值，是否允许此列被搜索，对于非 AJAX 表格。默认为 true。

AJAX 选项

当处理大型数据集时，在页面加载时加载所有内容是不合理的。使用 :ajax_source 来加载正在显示的记录，进行自定义搜索（数据库、Solr 等）。

:ajax_source：字符串，对于大型数据集，使用 AJAX 数据源来单独加载每个页面。对于小型数据集，只需加载整个集合，让 Datatable 进行排序。

在控制器上添加一个 datatable 方法以返回 JSON：

返回要显示的对象
返回对象的总数
添加一个方法来处理排序 - DataTables 返回正在排序的列（0 - n），所以您需要知道哪个列是哪个并按照它排序。

AJAX 示例

Datatable 视图示例 - `datatable.html.erb`

{"sEcho": <%= params[:sEcho] || -1 %>,
 "iTotalRecords": <%= @total_objects %>,
 "iTotalDisplayRecords": <%= @total_object %>,
 "aaData":[
<% @objects.each do |object| %>
  ['<%= link_to(object.user.name, user) %>',
   '<%= object.description || "-" %>',
   '<%= object.created_at %>'
  ],
<% end %>
]}

控制器示例 - 使用 will_paginate

def datatable
  @objects = current_objects(params)
  @total_objectss = total_objects(params)
  render :layout => false
end

private

def current_objects(params={})
  current_page = (params[:iDisplayStart].to_i/params[:iDisplayLength].to_i rescue 0)+1
  @current_objects = Object.paginate :page => current_page, 
                                     :include => [:user], 
                                     :order => "#{datatable_columns(params[:iSortCol_0])} #{params[:sSortDir_0] || "DESC"}", 
                                     :conditions => conditions,
                                     :per_page => params[:iDisplayLength]
end

def total_objects(params={})
  @total_objects = Object.count :include => [:user], :conditions => conditions
end

def datatable_columns(column_id)
  case column_id.to_i
  when 1
    return "objects.description"
  when 2
    return "objects.created_at"
  else
    return "users.name"
  end
end

def conditions
  conditions = []
  conditions << "(objects.description ILIKE '%#{params[:sSearch]}%' OR users.name ILIKE '%#{params[:sSearch]}%')" if(params[:sSearch])
  return conditions.join(" AND ")
end