jQuery UI API - ソータブルウィジェット(Sortable Widget)
所属カテゴリ
使用方法
説明:マウスを使用して、リストまたはグリッド内の要素の並び順を調整します。
追加されたバージョン:1.0
依存関係:
注:jQuery UI ソータブル(Sortable)プラグインは、選択された要素をマウスのドラッグで並べ替えることができます。
注:テーブルの行を並べ替えるには、tbodyソータブル(sortable)である必要があり、~ではなくtable。
クイックナビゲーション
| オプション | メソッド | イベント |
|---|---|---|
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| appendTo | jQuery または Element または Selector または String | ドラッグ中に、マウスで移動するヘルパーがどこに追加されるか(例:overlap/zIndex の問題を解決するため)。 複数の型をサポートします:
コード例: 初期化:指定された
$( ".selector" ).sortable({ appendTo: document.body });
初期化後に、取得または設定する // getter var appendTo = $( ".selector" ).sortable( "option", "appendTo" ); // setter $( ".selector" ).sortable( "option", "appendTo", document.body ); |
"parent" |
| axis | String | このオプションを定義すると、項目は水平または垂直方向にのみドラッグできます。可能な値:"x", "y"。コード例: 初期化:指定された
$( ".selector" ).sortable({ axis: "x" });
初期化後に、取得または設定する // getter var axis = $( ".selector" ).sortable( "option", "axis" ); // setter $( ".selector" ).sortable( "option", "axis", "x" ); |
false |
| cancel | Selector | 一致するセレクターの要素からソートが開始されるのを防ぎます。 コード例: 初期化:指定された
$( ".selector" ).sortable({ cancel: "a,button" });
初期化後に、取得または設定する // getter var cancel = $( ".selector" ).sortable( "option", "cancel" ); // setter $( ".selector" ).sortable( "option", "cancel", "a,button" ); |
"input, textarea, button, select, option" |
| connectWith | Selector | リスト内の項目を接続する他のソータブル(sortable)要素のセレクター。これは一方向の関係です。項目を双方向に接続したい場合は、両方のソータブル(sortable)要素に設定する必要がありますconnectWithオプション。コード例: 初期化:指定された
$( ".selector" ).sortable({ connectWith: "#shopping-cart" });
初期化後に、取得または設定する // getter var connectWith = $( ".selector" ).sortable( "option", "connectWith" ); // setter $( ".selector" ).sortable( "option", "connectWith", "#shopping-cart" ); |
false |
| containment | Element または Selector または String | ドラッグ中に、ソータブル(sortable)項目が制約される境界を定義します。 注:containment に指定される要素には、計算された幅と高さが必要です(明示的である必要はありません)。たとえば、 複数の型をサポートします:
コード例: 初期化:指定された
$( ".selector" ).sortable({ containment: "parent" });
初期化後に、取得または設定する // getter var containment = $( ".selector" ).sortable( "option", "containment" ); // setter $( ".selector" ).sortable( "option", "containment", "parent" ); |
false |
| cursor | String | ソート中に表示されるカーソルを定義します。 コード例: 初期化:指定された
$( ".selector" ).sortable({ cursor: "move" });
初期化後に、取得または設定する // getter var cursor = $( ".selector" ).sortable( "option", "cursor" ); // setter $( ".selector" ).sortable( "option", "cursor", "move" ); |
"auto" |
| cursorAt | Object | ソート要素またはヘルパー(helper)を移動して、カーソルが常に同じ位置からドラッグされるようにします。座標は、1つまたは2つのキーの組み合わせによるハッシュとして指定できます:{ top, left, right, bottom }。コード例: 初期化:指定された
$( ".selector" ).sortable({ cursorAt: { left: 5 } });
初期化後に、取得または設定する
// getter
var cursorAt = $( ".selector" ).sortable( "option", "cursorAt" );
// setter
$( ".selector" ).sortable( "option", "cursorAt", { left: 5 } );
|
false |
| delay | Integer | マウスが押されてからソートが始まるまでの時間(ミリ秒単位)。このオプションは、要素上でのクリック時に不要なドラッグが発生するのを防ぎます。 コード例: 初期化:指定された
$( ".selector" ).sortable({ delay: 150 });
初期化後に、取得または設定する // getter var delay = $( ".selector" ).sortable( "option", "delay" ); // setter $( ".selector" ).sortable( "option", "delay", 150 ); |
0 |
| disabled | Boolean | ~に設定されている場合、true、そのソータブル(sortable)は無効になります。コード例: 初期化:指定された
$( ".selector" ).sortable({ disabled: true });
初期化後に、取得または設定する // getter var disabled = $( ".selector" ).sortable( "option", "disabled" ); // setter $( ".selector" ).sortable( "option", "disabled", true ); |
false |
| distance | Number | マウスが押されてからソートが始まるまでに移動しなければならない距離(ピクセル単位)。このオプションを指定すると、マウスを指定距離以上ドラッグした場合にのみソートが開始されます。このオプションは、ハンドル内の要素をクリックできるようにするために使用できます。 コード例: 初期化:指定された
$( ".selector" ).sortable({ distance: 5 });
初期化後に、取得または設定する // getter var distance = $( ".selector" ).sortable( "option", "distance" ); // setter $( ".selector" ).sortable( "option", "distance", 5 ); |
1 |
| dropOnEmpty | Boolean | ~の場合、false、このソータブル(sortable)の項目は、接続された空のソータブル(sortable)に配置できません(参照:connectWithオプション)。コード例: 初期化:指定された
$( ".selector" ).sortable({ dropOnEmpty: false });
初期化後に、取得または設定する // getter var dropOnEmpty = $( ".selector" ).sortable( "option", "dropOnEmpty" ); // setter $( ".selector" ).sortable( "option", "dropOnEmpty", false ); |
true |
| forceHelperSize | Boolean | ~の場合、true、ヘルパー(helper)にサイズを強制します。コード例: 初期化:指定された
$( ".selector" ).sortable({ forceHelperSize: true });
初期化後に、取得または設定する // getter var forceHelperSize = $( ".selector" ).sortable( "option", "forceHelperSize" ); // setter $( ".selector" ).sortable( "option", "forceHelperSize", true ); |
false |
| forcePlaceholderSize | Boolean | ~の場合、true、プレースホルダー(placeholder)にサイズを強制します。コード例: 初期化:指定された
$( ".selector" ).sortable({ forcePlaceholderSize: true });
初期化後に、取得または設定する // getter var forcePlaceholderSize = $( ".selector" ).sortable( "option", "forcePlaceholderSize" ); // setter $( ".selector" ).sortable( "option", "forcePlaceholderSize", true ); |
false |
| grid | Array | ソート要素またはヘルパー(helper)を、x および y ピクセルごとのグリッドに整列します。配列の形式は次のとおりです:[ x, y ]。コード例: 初期化:指定された
$( ".selector" ).sortable({ grid: [ 20, 10 ] });
初期化後に、取得または設定する // getter var grid = $( ".selector" ).sortable( "option", "grid" ); // setter $( ".selector" ).sortable( "option", "grid", [ 20, 10 ] ); |
false |
| handle | Selector または Element | このオプションを指定すると、指定された要素上でのみソートを開始するように制限されます。 コード例: 初期化:指定された
$( ".selector" ).sortable({ handle: ".handle" });
初期化後に、取得または設定する // getter var handle = $( ".selector" ).sortable( "option", "handle" ); // setter $( ".selector" ).sortable( "option", "handle", ".handle" ); |
false |
| helper | String または Function() | ドラッグ表示に使用するヘルパー(helper)要素を許可します。 複数の型をサポートします:
コード例: 初期化:指定された
$( ".selector" ).sortable({ helper: "clone" });
初期化後に、取得または設定する // getter var helper = $( ".selector" ).sortable( "option", "helper" ); // setter $( ".selector" ).sortable( "option", "helper", "clone" ); |
"original" |
| items | Selector | 指定された要素内のどの項目をソータブル(sortable)にするかを指定します。 コード例: 初期化:指定された
$( ".selector" ).sortable({ items: "> li" });
初期化後に、取得または設定する // getter var items = $( ".selector" ).sortable( "option", "items" ); // setter $( ".selector" ).sortable( "option", "items", "> li" ); |
"> *" |
| opacity | Number | ソート中のヘルパー(helper)の不透明度。~から0.01 到 1。コード例: 初期化:指定された
$( ".selector" ).sortable({ opacity: 0.5 });
初期化後に、取得または設定する // getter var opacity = $( ".selector" ).sortable( "option", "opacity" ); // setter $( ".selector" ).sortable( "option", "opacity", 0.5 ); |
false |
| placeholder | String | 適用する class 名。それ以外の場合は白い空白。 コード例: 指定されたオプションで
$( ".selector" ).sortable({ placeholder: "sortable-placeholder" });
初期化後、取得または設定 // getter var placeholder = $( ".selector" ).sortable( "option", "placeholder" ); // setter $( ".selector" ).sortable( "option", "placeholder", "sortable-placeholder" ); |
false |
| revert | Boolean または Number | sortable 項目が滑らかなアニメーションを使用して新しい位置に戻るかどうか。 複数の型をサポート:
コード例: 指定されたオプションで
$( ".selector" ).sortable({ revert: true });
初期化後、取得または設定 // getter var revert = $( ".selector" ).sortable( "option", "revert" ); // setter $( ".selector" ).sortable( "option", "revert", true ); |
false |
| scroll | Boolean | に設定すると、true端に達するとページがスクロールします。コード例: 指定されたオプションで
$( ".selector" ).sortable({ scroll: false });
初期化後、取得または設定 // getter var scroll = $( ".selector" ).sortable( "option", "scroll" ); // setter $( ".selector" ).sortable( "option", "scroll", false ); |
true |
| scrollSensitivity | Number | マウスが端からどの距離でスクロールを開始するかを定義します。 コード例: 指定されたオプションで
$( ".selector" ).sortable({ scrollSensitivity: 10 });
初期化後、取得または設定 // getter var scrollSensitivity = $( ".selector" ).sortable( "option", "scrollSensitivity" ); // setter $( ".selector" ).sortable( "option", "scrollSensitivity", 10 ); |
20 |
| scrollSpeed | Number | マウスポインターがscrollSensitivityの距離内にあるときのページのスクロール速度。もしscrollオプションがfalseの場合は無視されます。コード例: 指定されたオプションで
$( ".selector" ).sortable({ scrollSpeed: 40 });
初期化後、取得または設定 // getter var scrollSpeed = $( ".selector" ).sortable( "option", "scrollSpeed" ); // setter $( ".selector" ).sortable( "option", "scrollSpeed", 40 ); |
20 |
| tolerance | String | 項目が移動されたときに別の項目の上に重なっているかどうかをテストするモードを指定します。可能な値:
コード例: 指定されたオプションで
$( ".selector" ).sortable({ tolerance: "pointer" });
初期化後、取得または設定 // getter var tolerance = $( ".selector" ).sortable( "option", "tolerance" ); // setter $( ".selector" ).sortable( "option", "tolerance", "pointer" ); |
"intersect" |
| zIndex | Integer | ソート中の要素/ヘルパーの Z-index。 コード例: 指定されたオプションで
$( ".selector" ).sortable({ zIndex: 9999 });
初期化後、取得または設定 // 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に関連付けられた現在の値を取得します。
コード例: このメソッドの呼び出し: var isDisabled = $( ".selector" ).sortable( "option", "disabled" ); |
| option() | PlainObject | 現在の draggable オプションハッシュを表すキー/値ペアを含むオブジェクトを取得します。
コード例: このメソッドの呼び出し: var options = $( ".selector" ).sortable( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | 指定されたoptionNameに関連付けられた sortable オプションの値を設定します。
コード例: このメソッドの呼び出し: $( ".selector" ).sortable( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | sortable に 1 つ以上のオプションを設定します。
コード例: このメソッドの呼び出し:
$( ".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 に追加できるハッシュが生成され、新しい項目の順序を簡単にサーバーへ送信できます。デフォルトでは、各項目の 注:シリアライズが空の文字列を返す場合は、
コード例: serialize メソッドの呼び出し:
var sorted = $( ".selector" ).sortable( "serialize", { key: "sort" } );
|
| toArray( options ) | Array | sortable の項目をシリアライズidして、文字列の配列にします。
コード例: toArray メソッドの呼び出し: var sortedIDs = $( ".selector" ).sortable( "toArray" ); |
| widget() | jQuery | sortable 要素を含むjQueryオブジェクトを返します。
コード例: widget メソッドの呼び出し: var widget = $( ".selector" ).sortable( "widget" ); |
| イベント | 型 | 説明 |
|---|---|---|
| activate( event, ui ) | sortactivate | 接続されたリストが使用されている場合にこのイベントがトリガーされ、ドラッグ開始時に各接続リストがそれを受け取ります。
コード例: 指定された activate コールバックを持つ sortable を初期化:
$( ".selector" ).sortable({
activate: function( event, ui ) {}
});
sortactivate イベントにイベントリスナーをバインド:
$( ".selector" ).on( "sortactivate", function( event, ui ) {} );
|
| beforeStop( event, ui ) | sortbeforestop | ソートが停止したときにこのイベントがトリガーされます。ただし、プレースホルダー/ヘルパーがまだ利用可能な場合は除きます。
コード例: 指定の beforeStop コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
beforeStop: function( event, ui ) {}
});
sortbeforestop イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortbeforestop", function( event, ui ) {} );
|
| change( event, ui ) | sortchange | ソート中にこのイベントが発生します。ただし、DOMの位置が変更された場合を除きます。
コード例: 指定の change コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
change: function( event, ui ) {}
});
sortchange イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortchange", function( event, ui ) {} );
|
| create( event, ui ) | sortcreate | droppable が作成されたときに発生します。
注: コード例: 指定の create コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
create: function( event, ui ) {}
});
sortcreate イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortcreate", function( event, ui ) {} );
|
| deactivate( event, ui ) | sortdeactivate | ソートが停止したときにこのイベントが発生します。このイベントは、可能なすべての接続リストに伝播します。
コード例: 指定の deactivate コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
deactivate: function( event, ui ) {}
});
sortdeactivate イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortdeactivate", function( event, ui ) {} );
|
| out( event, ui ) | sortout | ソータブル項目がソータブルリストから削除されたときにこのイベントが発生します。 注釈:ソータブル項目が取り消されたときにもこのイベントが発生します。
コード例: 指定の out コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
out: function( event, ui ) {}
});
sortout イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortout", function( event, ui ) {} );
|
| over( event, ui ) | sortover | ソータブル項目がソータブルリストに移動したときにこのイベントが発生します。
コード例: 指定の over コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
out: function( event, ui ) {}
});
sortover イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortout", function( event, ui ) {} );
|
| receive( event, ui ) | sortreceive | 接続されたソータブルリストから別のリストに項目が配置されたときにこのイベントが発生します。後者がイベントターゲットです。
コード例: 指定の receive コールバックを持つソータブルの初期化:
$( ".selector" ).sortable({
receive: function( event, ui ) {}
});
sortreceive イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortreceive", function( event, ui ) {} );
|
| remove( event, ui ) | sortremove | 接続されたソータブルリストから別のリストに項目が配置されたときにこのイベントが発生します。前者がイベントターゲットです。
コード例: 指定された remove コールバックを使用して sortable を初期化する:
$( ".selector" ).sortable({
remove: function( event, ui ) {}
});
sortremove イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortremove", function( event, ui ) {} );
|
| sort( event, ui ) | sort | ソート中にこのイベントがトリガーされます。
コード例: 指定された sort コールバックを使用して sortable を初期化する:
$( ".selector" ).sortable({
sort: function( event, ui ) {}
});
sort イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sort", function( event, ui ) {} );
|
| start( event, ui ) | sortstart | ソートの開始時にこのイベントがトリガーされます。
コード例: 指定された start コールバックを使用して sortable を初期化する:
$( ".selector" ).sortable({
start: function( event, ui ) {}
});
sortstart イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortstart", function( event, ui ) {} );
|
| stop( event, ui ) | sortstop | ソートが停止したときにこのイベントがトリガーされます。
コード例: 指定された stop コールバックを使用して sortable を初期化する:
$( ".selector" ).sortable({
stop: function( event, ui ) {}
});
sortstop イベントにイベントリスナーをバインドする:
$( ".selector" ).on( "sortstop", function( event, ui ) {} );
|
| update( event, ui ) | sortupdate | ユーザーがソートを停止し、DOM の位置が変更されたときにこのイベントがトリガーされます。
コード例: 指定された 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>
その他の拡張