回想到很久以前,JavaScript 为了实现前端拖拽排序的事情,都是一个不容易的事。自从有了 jQuery 和jQuery UI后,很多常见的功能直接使用起来已经非常方便了,不需要自己进行二次开发。
好,今天我们就使用sortable,完成加上服务器端(Rails)的逻辑,完成一个完整的拖拽排序功能。
在服务器端添加排序的字段(position),然后我们的 order 排序根据 position 进行排序。每当我们前端拖拽结束后,通过异步 Ajax 把排序的结果发送到服务器,服务器根据传送过来的内容,重新设置 position 信息。
gem 'acts_as_list'
gem 'jquery-ui-rails'
jquery-ui
中的 sortable 提供前端拖拽排序效果的功能,acts_as_list
则是一款服务器端排序功能的 gem,提供丰富的方法,当然如果仅仅是一个简单的排序功能,这里不使用acts_as_list
也是可行的。
我们先在application.js
引入jquery-ui
:
//= require jquery-ui/widgets/sortable
然后我们加入调用sortable
的方法:
document.addEventListener("turbolinks:load", function() {
$( "[data-behavior='sortable']" ).sortable();
})
这样一来,只要在需要排序的 dom 中,加入data-behavior='sortable'
就可以实现拖拽排序的效果了,参考:
<table class="table table-bordered table-hover">
<thead>
...
</thead>
<tbody data-behavior='sortable'>
...
</tbody>
</table>
首先我们根据acts_as_list
的文档,加入一个排序需要用到的字段:
rails g migration AddPositionToTodoItem position:integer
rails db:migrate
然后我们需要添加一个接口,用于处理排序信息:
// route.js
Rails.application.routes.draw do
resources :todo_items do
collection do
patch :sort
end
end
...
end
// controller
class TodoItemsController < ApplicationController
def index
@todo_items = TodoItems.order(:position)
end
def sort
end
end
现在服务器端的接口完成了,我们的目的就是当排序结束后,把数据打包发到这个接口中,为了方便操作,我把接口地址放在 Dom 里的data-url
属性中。
<tbody data-url="<%= sort_todo_items_path %>" data-behavior='sortable'>
...
</tbody>
并且每个拖拽的元素,我们把它的 ID 设置为model的名称_model的id
:
<tbody data-url="<%= sort_todo_items_path %>" data-behavior='sortable'>
<% @todo_items.each_with_index do |todo_item, index| %>
<tr id="<%= dom_id(todo_item) %>">
...
</tr>
<% end %>
</tbody>
然后我们在原来的sortable
中,添加 update 方法,处理异步事务:
$( "[data-behavior='sortable']" ).sortable({
update: function(e, ui) {
$.ajax({
url: $(this).data("url"),
type: "PATCH",
data: $(this).sortable('serialize')
})
}
});
通过上面的 JavaScript 代码,就可以实现,每天拖拽更新后,就会发送数据到对应的接口上,那发送过去的数据会是怎么样的呢?
当我们尝试操作一遍后,就会发现发送到服务器的数据格式如下:
Parameters: {"todo_item"=>["2", "1", "3"]}
这个就是todo_item
数据里,每个 id 的排序情况。所以我们可以根据这个排序信息,重新设置position
就可以达到我们想要的排序结果。
...
def sort
params[:todo_item].each_with_index do |id, index|
TodoItem.where(id: id).update_all(position: index + 1)
end
head :ok
end
...
好了,目前我们前后端的功能都完成了,赶快试试效果吧。