jQuery DragTable 技术文档

1. 安装指南

在开始使用 jQuery DragTable 前，您需要确保已经具备了以下依赖项：

• jQuery
• jQuery UI（包括 Core、Widget、Mouse 和 Sortable 组件）

您可以从官方网站下载这些库，或者使用CDN链接将它们包含在您的页面中。

以下是一个基本的安装步骤：

1. 下载或通过CDN链接引入 jQuery 库。
2. 下载或通过CDN链接引入 jQuery UI 库。
3. 确保在 HTML 文档中，jQuery UI 库的引用位于 jQuery 库引用之后。
4. 下载 jQuery DragTable 插件。
5. 在您的 HTML 文档中引用 jQuery DragTable 插件。

<!-- 引入 jQuery -->
<script src="path/to/jquery.js"></script>
<!-- 引入 jQuery UI -->
<script src="path/to/jquery-ui.js"></script>
<!-- 引入 jQuery DragTable 插件 -->
<script src="path/to/jquery.dragtable.js"></script>

确保在引用 jQuery 和 jQuery UI 库之后引用 jQuery DragTable 插件。

2. 项目的使用说明

要使用 jQuery DragTable 插件，您需要对一个表格进行初始化。以下是一个简单的例子：

$(document).ready(function() {
    $("#yourTableId").dragtable();
});

这里 #yourTableId 是您希望应用拖动排序功能的表格的 ID。

3. 项目API使用文档

目前，jQuery DragTable 插件支持以下初始化选项：

• accept：一个选择器，用于指定哪些列可以拖动。
• axis：限制拖动的方向，可以是 'x' 或 'y'。
• containment：限制拖动区域的选择器。

以下是一个初始化插件并设置一些选项的例子：

$(document).ready(function() {
    $("#yourTableId").dragtable({
        accept: 'tr',
        axis: 'y',
        containment: 'parent'
    });
});

此外，以下是插件提供的一些方法和事件：

• destroy()：销毁插件实例。
• option(key, [value])：获取或设置插件选项。
• ('dragtablecreate')：当创建拖动表时触发。
• ('dragstart')：当开始拖动列时触发。
• ('drag')：当拖动列时触发。
• ('dragstop')：当停止拖动列时触发。

4. 项目安装方式

除了手动下载和引用 jQuery DragTable 插件外，您还可以使用 npm 或 Yarn 这样的包管理工具进行安装。

使用 npm 的安装命令如下：

npm install jquery-dragtable

使用 Yarn 的安装命令如下：

yarn add jquery-dragtable

安装完成后，您可以在项目中通过 require 或 import 语句引用 jQuery DragTable 插件。