jQuery UI API - 可排序小部件（Sortable Widget）

所屬類別

交互（Interactions）

用法

描述：使用滑鼠調整列表中或者網格中元素的排序。

版本新增：1.0

依賴：

注釋：jQuery UI 可排序（Sortable）插件讓被選元素通過滑鼠拖拽進行排序。

注釋：為了排序表格行，tbody 必須是可排序的（sortable），而不是 table。

快速導航

選項 方法 事件

選項 類型 描述 默認值
appendTo jQuery 或 Element 或 Selector 或 String 當拖拽時，通過滑鼠移動的助手被追加到哪里（例如，解決 overlap/zIndex 問題）。

支持多個類型：

  • jQuery：一個 jQuery 對象，包含助手（helper）要追加到的元素。
  • Element：要追加助手（helper）的元素。
  • Selector：一個選擇器，指定哪個元素要追加助手（helper）。
  • String：字串 "parent" 將促使助手（helper）成為 sortable 專案的同級。

代碼實例：

初始化帶有指定 appendTo 選項的 sortable：

$( ".selector" ).sortable({ appendTo: document.body });
    

在初始化後，獲取或設置 appendTo 選項：

// getter
var appendTo = $( ".selector" ).sortable( "option", "appendTo" );

// setter
$( ".selector" ).sortable( "option", "appendTo", document.body );
    
 "parent"
axis String 如果定義了該選項，專案只能在水準或垂直方向上被拖拽。可能的值："x", "y"。

代碼實例：

初始化帶有指定 axis 選項的 sortable：

$( ".selector" ).sortable({ axis: "x" });
    

在初始化後，獲取或設置 axis 選項：

// getter
var axis = $( ".selector" ).sortable( "option", "axis" );

// setter
$( ".selector" ).sortable( "option", "axis", "x" );
    
 false
cancel Selector 防止從匹配選擇器的元素上開始排序。

代碼實例：

初始化帶有指定 cancel 選項的 sortable：

$( ".selector" ).sortable({ cancel: "a,button" });
    

在初始化後，獲取或設置 cancel 選項：

// getter
var cancel = $( ".selector" ).sortable( "option", "cancel" );

// setter
$( ".selector" ).sortable( "option", "cancel", "a,button" );
    
 "input, textarea, button, select, option"
connectWith Selector 列表中的專案需被連接的其他 sortable 元素的選擇器。這是一個單向關係，如果您想要專案被雙向連接，必須在兩個 sortable 元素上都設置 connectWith 選項。

代碼實例：

初始化帶有指定 connectWith 選項的 sortable：

$( ".selector" ).sortable({ connectWith: "#shopping-cart" });
    

在初始化後，獲取或設置 connectWith 選項：

// getter
var connectWith = $( ".selector" ).sortable( "option", "connectWith" );

// setter
$( ".selector" ).sortable( "option", "connectWith", "#shopping-cart" );
    
 false
containment Element 或 Selector 或 String 定義拖拽時，sortable 專案被約束的邊界。

注釋：為 containment 指定的元素必須有一個已計算的寬度和高度（儘管它不需要顯式）。例如，如果您有 float: left sortable 子元素，並指定了 containment: "parent"，請確保在 sortable/parent 容器上有 float: left ，否則它將有 height: 0，導致未定義的行為。

支持多個類型：

  • Element：一個要作為容器使用的元素。
  • Selector：一個選擇器，指定一個要作為容器使用的元素。
  • String：一個字串，標識一個要作為容器使用的元素。可能的值："parent"、"document"、"window"。

代碼實例：

初始化帶有指定 containment 選項的 sortable：

$( ".selector" ).sortable({ containment: "parent" });
    

在初始化後，獲取或設置 containment 選項：

// getter
var containment = $( ".selector" ).sortable( "option", "containment" );

// setter
$( ".selector" ).sortable( "option", "containment", "parent" );
    
 false
cursor String 定義當排序時被顯示的游標。

代碼實例：

初始化帶有指定 cursor 選項的 sortable：

$( ".selector" ).sortable({ cursor: "move" });
    

在初始化後，獲取或設置 cursor 選項：

// getter
var cursor = $( ".selector" ).sortable( "option", "cursor" );

// setter
$( ".selector" ).sortable( "option", "cursor", "move" );
    
 "auto"
cursorAt Object 移動排序元素或助手（helper），這樣游標總是出現，以便從相同的位置進行拖拽。座標可通過一個或兩個鍵的組合成一個哈希給出：{ top, left, right, bottom }。

代碼實例：

初始化帶有指定 cursorAt 選項的 sortable：

$( ".selector" ).sortable({ cursorAt: { left: 5 } });
    

在初始化後，獲取或設置 cursorAt 選項：

// getter
var cursorAt = $( ".selector" ).sortable( "option", "cursorAt" );

// setter
$( ".selector" ).sortable( "option", "cursorAt", { left: 5 } );
    
 false
delay Integer 滑鼠按下後直到排序開始的時間，以毫秒計。該選項可以防止點擊在某個元素上時不必要的拖拽。

代碼實例：

初始化帶有指定 delay 選項的 sortable：

$( ".selector" ).sortable({ delay: 150 });
    

在初始化後，獲取或設置 delay 選項：

// getter
var delay = $( ".selector" ).sortable( "option", "delay" );

// setter
$( ".selector" ).sortable( "option", "delay", 150 );
    
 0
disabled Boolean 如果設置為 true，則禁用該 sortable。

代碼實例：

初始化帶有指定 disabled 選項的 sortable：

$( ".selector" ).sortable({ disabled: true });
    

在初始化後，獲取或設置 disabled 選項：

// getter
var disabled = $( ".selector" ).sortable( "option", "disabled" );

// setter
$( ".selector" ).sortable( "option", "disabled", true );
    
 false
distance Number 滑鼠按下後排序開始前必須移動的距離，以像素計。如果指定了該選項，排序只有在滑鼠拖拽超出指定距離時才會開始。該選項可以用於允許在一個手柄內的元素上點擊。

代碼實例：

初始化帶有指定 distance 選項的 sortable：

$( ".selector" ).sortable({ distance: 5 });
    

在初始化後，獲取或設置 distance 選項：

// getter
var distance = $( ".selector" ).sortable( "option", "distance" );

// setter
$( ".selector" ).sortable( "option", "distance", 5 );
    
 1
dropOnEmpty Boolean 如果為 false，從該 sortable 的專案不能被放置在空連接的 sortable 上（請查看 connectWith 選項）。

代碼實例：

初始化帶有指定 dropOnEmpty 選項的 sortable：

$( ".selector" ).sortable({ dropOnEmpty: false });
    

在初始化後，獲取或設置 dropOnEmpty 選項：

// getter
var dropOnEmpty = $( ".selector" ).sortable( "option", "dropOnEmpty" );

// setter
$( ".selector" ).sortable( "option", "dropOnEmpty", false );
    
 true
forceHelperSize Boolean 如果為 true，強制助手（helper）有一個尺寸。

代碼實例：

初始化帶有指定 forceHelperSize 選項的 sortable：

$( ".selector" ).sortable({ forceHelperSize: true });
    

在初始化後，獲取或設置 forceHelperSize 選項：

// getter
var forceHelperSize = $( ".selector" ).sortable( "option", "forceHelperSize" );

// setter
$( ".selector" ).sortable( "option", "forceHelperSize", true );
    
 false
forcePlaceholderSize Boolean 如果為 true，強制占位符（placeholder）有一個尺寸。

代碼實例：

初始化帶有指定 forcePlaceholderSize 選項的 sortable：

$( ".selector" ).sortable({ forcePlaceholderSize: true });
    

在初始化後，獲取或設置 forcePlaceholderSize 選項：

// getter
var forcePlaceholderSize = $( ".selector" ).sortable( "option", "forcePlaceholderSize" );

// setter
$( ".selector" ).sortable( "option", "forcePlaceholderSize", true );
    
 false
grid Array 對齊排序元素或助手（helper）到網格，每個 x 和 y 像素。數組形式必須是 [ x, y ]。

代碼實例：

初始化帶有指定 grid 選項的 sortable：

$( ".selector" ).sortable({ grid: [ 20, 10 ] });
    

在初始化後，獲取或設置 grid 選項：

// getter
var grid = $( ".selector" ).sortable( "option", "grid" );

// setter
$( ".selector" ).sortable( "option", "grid", [ 20, 10 ] );
    
 false
handle Selector 或 Element 如果指定了該選項，則限制在指定的元素上開始排序。

代碼實例：

初始化帶有指定 handle 選項的 sortable：

$( ".selector" ).sortable({ handle: ".handle" });
    

在初始化後，獲取或設置 handle 選項：

// getter
var handle = $( ".selector" ).sortable( "option", "handle" );

// setter
$( ".selector" ).sortable( "option", "handle", ".handle" );
    
 false
helper String 或 Function() 允許一個 helper 元素用於拖拽顯示。

支持多個類型：

  • String：如果設置為 "clone"，元素將被克隆，且克隆將被拖拽。
  • Function：一個函數，將返回拖拽時要使用的 DOMElement。函數接收事件，且元素正被排序。

代碼實例：

初始化帶有指定 helper 選項的 sortable：

$( ".selector" ).sortable({ helper: "clone" });
    

在初始化後，獲取或設置 helper 選項：

// getter
var helper = $( ".selector" ).sortable( "option", "helper" );

// setter
$( ".selector" ).sortable( "option", "helper", "clone" );
    
 "original"
items Selector 指定元素內的哪一個專案應是 sortable。

代碼實例：

初始化帶有指定 items 選項的 sortable：

$( ".selector" ).sortable({ items: "> li" });
    

在初始化後，獲取或設置 items 選項：

// getter
var items = $( ".selector" ).sortable( "option", "items" );

// setter
$( ".selector" ).sortable( "option", "items", "> li" );
    
 "> *"
opacity Number 當排序時助手（helper）的不透明度。從 0.01 到 1。

代碼實例：

初始化帶有指定 opacity 選項的 sortable：

$( ".selector" ).sortable({ opacity: 0.5 });
    

在初始化後，獲取或設置 opacity 選項：

// getter
var opacity = $( ".selector" ).sortable( "option", "opacity" );

// setter
$( ".selector" ).sortable( "option", "opacity", 0.5 );
    
 false
placeholder String 要應用的 class 名稱，否則為白色空白。

代碼實例：

初始化帶有指定 placeholder 選項的 sortable：

$( ".selector" ).sortable({ placeholder: "sortable-placeholder" });
    

在初始化後，獲取或設置 placeholder 選項：

// getter
var placeholder = $( ".selector" ).sortable( "option", "placeholder" );

// setter
$( ".selector" ).sortable( "option", "placeholder", "sortable-placeholder" );
    
 false
revert Boolean 或 Number sortable 專案是否使用一個流暢的動畫還原到它的新位置。

支持多個類型：

  • Boolean：當設置為 true，該專案將會使用動畫，動畫使用默認的持續時間。
  • Number：動畫的持續時間，以毫秒計。

代碼實例：

初始化帶有指定 revert 選項的 sortable：

$( ".selector" ).sortable({ revert: true });
    

在初始化後，獲取或設置 revert 選項：

// getter
var revert = $( ".selector" ).sortable( "option", "revert" );

// setter
$( ".selector" ).sortable( "option", "revert", true );
    
 false
scroll Boolean 如果設置為 true，當到達邊緣時頁面會滾動。

代碼實例：

初始化帶有指定 scroll 選項的 sortable：

$( ".selector" ).sortable({ scroll: false });
    

在初始化後，獲取或設置 scroll 選項：

// getter
var scroll = $( ".selector" ).sortable( "option", "scroll" );

// setter
$( ".selector" ).sortable( "option", "scroll", false );
    
 true
scrollSensitivity Number 定義滑鼠距離邊緣多少距離時開始滾動。

代碼實例：

初始化帶有指定 scrollSensitivity 選項的 sortable：

$( ".selector" ).sortable({ scrollSensitivity: 10 });
    

在初始化後，獲取或設置 scrollSensitivity 選項：

// getter
var scrollSensitivity = $( ".selector" ).sortable( "option", "scrollSensitivity" );

// setter
$( ".selector" ).sortable( "option", "scrollSensitivity", 10 );
    
 20
scrollSpeed Number 當滑鼠指針獲取到在 scrollSensitivity 距離內時，窗體滾動的速度。如果 scroll 選項是 false 則忽略。

代碼實例：

初始化帶有指定 scrollSpeed 選項的 sortable：

$( ".selector" ).sortable({ scrollSpeed: 40 });
    

在初始化後，獲取或設置 scrollSpeed 選項：

// getter
var scrollSpeed = $( ".selector" ).sortable( "option", "scrollSpeed" );

// setter
$( ".selector" ).sortable( "option", "scrollSpeed", 40 );
    
 20
tolerance String 指定用於測試專案被移動時是否覆蓋在另一個專案上的模式。可能的值：
  • "intersect"：專案至少 50% 重疊在其他專案上。
  • "pointer"：滑鼠指針重疊在其他專案上。

代碼實例：

初始化帶有指定 tolerance 選項的 sortable：

$( ".selector" ).sortable({ tolerance: "pointer" });
    

在初始化後，獲取或設置 tolerance 選項：

// getter
var tolerance = $( ".selector" ).sortable( "option", "tolerance" );

// setter
$( ".selector" ).sortable( "option", "tolerance", "pointer" );
    
 "intersect"
zIndex Integer 當被排序時，元素/助手（helper）的 Z-index。

代碼實例：

初始化帶有指定 zIndex 選項的 sortable：

$( ".selector" ).sortable({ zIndex: 9999 });
    

在初始化後，獲取或設置 zIndex 選項：

// getter
var zIndex = $( ".selector" ).sortable( "option", "zIndex" );

// setter
$( ".selector" ).sortable( "option", "zIndex", 9999 );
    
 1000

方法 返回 描述
cancel() jQuery (plugin only) 當前排序開始時，取消一個在當前 sortable 中的改變，且恢復到之前的狀態。在 stop 和 receive 回調函數中非常有用。
  • 該方法不接受任何參數。

代碼實例：

調用 cancel 方法：

$( ".selector" ).sortable( "cancel" );
    
destroy() jQuery (plugin only) 完全移除 sortable 功能。這會把元素返回到它的預初始化狀態。
  • 該方法不接受任何參數。

代碼實例：

調用 destroy 方法：

$( ".selector" ).sortable( "destroy" );
    
disable() jQuery (plugin only) 禁用 sortable。
  • 該方法不接受任何參數。

代碼實例：

調用 disable 方法：

$( ".selector" ).sortable( "disable" );
    
enable() jQuery (plugin only) 啟用 sortable。
  • 該方法不接受任何參數。

代碼實例：

調用 enable 方法：

$( ".selector" ).sortable( "enable" );
    
option( optionName ) Object 獲取當前與指定的 optionName 關聯的值。
  • optionName
    類型：String
    描述：要獲取的選項的名稱。

代碼實例：

調用該方法：

var isDisabled = $( ".selector" ).sortable( "option", "disabled" );
    
option() PlainObject 獲取一個包含鍵/值對的對象，鍵/值對表示當前 draggable 選項哈希。
  • 該方法不接受任何參數。

代碼實例：

調用該方法：

var options = $( ".selector" ).sortable( "option" );
    
option( optionName, value ) jQuery (plugin only) 設置與指定的 optionName 關聯的 sortable 選項的值。
  • optionName
    類型：String
    描述：要設置的選項的名稱。
  • value
    類型：Object
    描述：要為選項設置的值。

代碼實例：

調用該方法：

$( ".selector" ).sortable( "option", "disabled", true );
    
option( options ) jQuery (plugin only) 為 sortable 設置一個或多個選項。
  • options
    類型：Object
    描述：要設置的 option-value 對。

代碼實例：

調用該方法：

$( ".selector" ).sortable( "option", { disabled: true } );
    
refresh() jQuery (plugin only) 刷新 sortable 專案。觸發所有 sortable 專案重新加載，導致新的專案被認可。
  • 該方法不接受任何參數。

代碼實例：

調用 refresh 方法：

$( ".selector" ).sortable( "refresh" );
    
refreshPositions() jQuery (plugin only) 刷新 sortable 專案的緩存位置。調用該方法刷新所有 sortable 的已緩存的專案位置。
  • 該方法不接受任何參數。

代碼實例：

調用 refreshPositions 方法：

$( ".selector" ).sortable( "refreshPositions" );
    
serialize( options ) String 序列化 sortable 的專案 id 為一個 form/ajax 可提交的字串。調用該方法會產生一個可被追加到任何 url 中的哈希，以便簡單地把一個新的專案順序提交回伺服器。

默認情況下，它通過每個專案的 id 進行工作，id 格式為 "setname_number"，且它會產生一個形如 "setname[]=number&setname[]=number" 的哈希。

注釋：如果序列化返回一個空的字串，請確認 id 屬性包含一個下劃線（_）。形式必須是 "set_number"。例如，一個 id 屬性為 "foo_1"、"foo_5"、"foo_2" 的 3 元素列表將序列化為 "foo[]=1&foo[]=5&foo[]=2"。您可以使用下劃線（_）、等號（=）或連字元（-）來分隔集合和數字。例如，"foo=1"、"foo-1"、"foo_1" 所有都序列化為 "foo[]=1"。

  • options
    類型：Object
    要自定義序列化的選項。
    • key（默認值：屬性中分隔符前面的部分）
      類型：String
      描述：把 part1[] 替換為指定的值。
    • attribute（默認值："id"）
      類型：String
      描述：值要使用的屬性名稱。
    • expression（默認值：/(.+)[-=_](.+)/）
      類型：RegExp
      描述：用於把屬性值分隔為鍵和值兩部分的正則運算式。

代碼實例：

調用 serialize 方法：

var sorted = $( ".selector" ).sortable( "serialize", { key: "sort" } );
    
toArray( options ) Array 序列化 sortable 的專案 id 為一個字串的數組。
  • options
    類型：Object
    要自定義序列化的選項。
    • attribute（默認值："id"）
      類型：String
      描述：值要使用的屬性名稱。

代碼實例：

調用 toArray 方法：

var sortedIDs = $( ".selector" ).sortable( "toArray" );
    
widget() jQuery 返回一個包含 sortable 元素的 jQuery 對象。
  • 該方法不接受任何參數。

代碼實例：

調用 widget 方法：

var widget = $( ".selector" ).sortable( "widget" );
    

事件 類型 描述
activate( event, ui ) sortactivate 當使用被連接列表時觸發該事件，每個被連接列表在拖拽開始時接收它。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 activate 回調的 sortable：

$( ".selector" ).sortable({
activate: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortactivate 事件：

$( ".selector" ).on( "sortactivate", function( event, ui ) {} );
    
beforeStop( event, ui ) sortbeforestop 當排序停止時觸發該事件，除了當占位符（placeholder）/助手（helper）仍然可用時。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 beforeStop 回調的 sortable：

$( ".selector" ).sortable({
beforeStop: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortbeforestop 事件：

$( ".selector" ).on( "sortbeforestop", function( event, ui ) {} );
    
change( event, ui ) sortchange 在排序期間觸發該事件，除了當 DOM 位置改變時。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 change 回調的 sortable：

$( ".selector" ).sortable({
change: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortchange 事件：

$( ".selector" ).on( "sortchange", function( event, ui ) {} );
    
create( event, ui ) sortcreate 當 droppable 被創建時觸發。
  • event
    類型：Event
  • ui
    類型：Object

注意：ui 對象是空的，這裏包含它是為了與其他事件保持一致性。

代碼實例：

初始化帶有指定 create 回調的 sortable：

$( ".selector" ).sortable({
create: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortcreate 事件：

$( ".selector" ).on( "sortcreate", function( event, ui ) {} );
    
deactivate( event, ui ) sortdeactivate 當排序停止時觸發該事件，該事件傳播到所有可能的連接列表。。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 deactivate 回調的 sortable：

$( ".selector" ).sortable({
deactivate: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortdeactivate 事件：

$( ".selector" ).on( "sortdeactivate", function( event, ui ) {} );
    
out( event, ui ) sortout 當一個 sortable 專案從一個 sortable 列表移除時觸發該事件。

注釋：當一個 sortable 專案被撤銷時也會觸發該事件。

  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 out 回調的 sortable：

$( ".selector" ).sortable({
out: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortout 事件：

$( ".selector" ).on( "sortout", function( event, ui ) {} );
    
over( event, ui ) sortover 當一個 sortable 專案移動到一個 sortable 列表時觸發該事件。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 over 回調的 sortable：

$( ".selector" ).sortable({
out: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortover 事件：

$( ".selector" ).on( "sortout", function( event, ui ) {} );
    
receive( event, ui ) sortreceive 當來自一個連接的 sortable 列表的一個專案被放置到另一個列表時觸發該事件。後者是事件目標。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 receive 回調的 sortable：

$( ".selector" ).sortable({
receive: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortreceive 事件：

$( ".selector" ).on( "sortreceive", function( event, ui ) {} );
    
remove( event, ui ) sortremove 當來自一個連接的 sortable 列表的一個專案被放置到另一個列表時觸發該事件。前者是事件目標。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 remove 回調的 sortable：

$( ".selector" ).sortable({
remove: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortremove 事件：

$( ".selector" ).on( "sortremove", function( event, ui ) {} );
    
sort( event, ui ) sort 在排序期間觸發該事件。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 sort 回調的 sortable：

$( ".selector" ).sortable({
sort: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sort 事件：

$( ".selector" ).on( "sort", function( event, ui ) {} );
    
start( event, ui ) sortstart 當排序開始時觸發該事件。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 start 回調的 sortable：

$( ".selector" ).sortable({
start: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortstart 事件：

$( ".selector" ).on( "sortstart", function( event, ui ) {} );
    
stop( event, ui ) sortstop 當排序停止時觸發該事件。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 stop 回調的 sortable：

$( ".selector" ).sortable({
stop: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortstop 事件：

$( ".selector" ).on( "sortstop", function( event, ui ) {} );
    
update( event, ui ) sortupdate 當用戶停止排序且 DOM 位置改變時觸發該事件。
  • event
    類型：Event
  • ui
    類型：Object
    • helper
      類型：jQuery
      描述：jQuery 對象，表示被排序的助手（helper）。
    • item
      類型：jQuery
      描述：jQuery 對象，表示當前被拖拽的元素。
    • offset
      類型：Object
      描述：助手（helper）的當前的絕對位置，表示為 { top, left }。
    • position
      類型：Object
      描述：助手（helper）的當前位置，表示為 { top, left }。
    • originalPosition
      類型：Object
      描述：元素的原始位置，表示為 { top, left }。
    • sender
      類型：jQuery
      描述：如果從一個 sortable 移動到另一個 sortable，專案來自的那個 sortable。
    • placeholder
      類型：jQuery
      描述：jQuery 對象，表示被作為占位符使用的元素。

代碼實例：

初始化帶有指定 update 回調的 sortable：

$( ".selector" ).sortable({
update: function( event, ui ) {}
});
    

綁定一個事件監聽器到 sortupdate 事件：

$( ".selector" ).on( "sortupdate", function( event, ui ) {} );
    

實例

一個簡單的 jQuery UI 可排序小部件（Sortable Widget）。

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>可排序小部件（Sortable Widget）演示</title>
  <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
  <script src="//code.jquery.com/jquery-1.10.2.js"></script>
  <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>

<ul id="sortable">
  <li>Item 1</li>
  <li>Item 2</li>
  <li>Item 3</li>
  <li>Item 4</li>
  <li>Item 5</li>
</ul>

<script>$("#sortable").sortable();</script>

</body>
</html>