jQuery UI API - ソータブルウィジェット(Sortable Widget)

所属カテゴリ

インタラクション(Interactions)

使用方法

説明:マウスを使用して、リストまたはグリッド内の要素の並び順を調整します。

追加されたバージョン:1.0

依存関係:

注:jQuery UI ソータブル(Sortable)プラグインは、選択された要素をマウスのドラッグで並べ替えることができます。

注:テーブルの行を並べ替えるには、tbodyソータブル(sortable)である必要があり、~ではなくtable。

クイックナビゲーション

オプション メソッド イベント

オプション 型 説明 デフォルト値
appendTo jQuery または Element または Selector または String ドラッグ中に、マウスで移動するヘルパーがどこに追加されるか(例:overlap/zIndex の問題を解決するため)。

複数の型をサポートします:

  • jQuery:ヘルパー(helper)を追加する要素を含む jQuery オブジェクト。
  • 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 を指定した場合、containment: "parent"、ソータブル(sortable)/親コンテナに~があることを確認してください。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)を移動して、カーソルが常に同じ位置からドラッグされるようにします。座標は、1つまたは2つのキーの組み合わせによるハッシュとして指定できます:{ 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 名。それ以外の場合は白い空白。

コード例:

指定されたオプションでplaceholdersortable を初期化:

$( ".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:アニメーションの継続時間(ミリ秒単位)。

コード例:

指定されたオプションでrevertsortable を初期化:

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

初期化後、取得または設定revertオプション:

// getter
var revert = $( ".selector" ).sortable( "option", "revert" );
 
// setter
$( ".selector" ).sortable( "option", "revert", true );
    
false
scroll Boolean に設定すると、true端に達するとページがスクロールします。

コード例:

指定されたオプションでscrollsortable を初期化:

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

初期化後、取得または設定scrollオプション:

// getter
var scroll = $( ".selector" ).sortable( "option", "scroll" );
 
// setter
$( ".selector" ).sortable( "option", "scroll", false );
    
true
scrollSensitivity Number マウスが端からどの距離でスクロールを開始するかを定義します。

コード例:

指定されたオプションでscrollSensitivitysortable を初期化:

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

初期化後、取得または設定scrollSensitivityオプション:

// getter
var scrollSensitivity = $( ".selector" ).sortable( "option", "scrollSensitivity" );
 
// setter
$( ".selector" ).sortable( "option", "scrollSensitivity", 10 );
    
20
scrollSpeed Number マウスポインターがscrollSensitivityの距離内にあるときのページのスクロール速度。もしscrollオプションがfalseの場合は無視されます。

コード例:

指定されたオプションでscrollSpeedsortable を初期化:

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

初期化後、取得または設定scrollSpeedオプション:

// getter
var scrollSpeed = $( ".selector" ).sortable( "option", "scrollSpeed" );
 
// setter
$( ".selector" ).sortable( "option", "scrollSpeed", 40 );
    
20
tolerance String 項目が移動されたときに別の項目の上に重なっているかどうかをテストするモードを指定します。可能な値:
  • "intersect":項目が他の項目に少なくとも 50% 重なっている。
  • "pointer":マウスポインターが他の項目に重なっている。

コード例:

指定されたオプションでtolerancesortable を初期化:

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

初期化後、取得または設定toleranceオプション:

// getter
var tolerance = $( ".selector" ).sortable( "option", "tolerance" );
 
// setter
$( ".selector" ).sortable( "option", "tolerance", "pointer" );
    
"intersect"
zIndex Integer ソート中の要素/ヘルパーの Z-index。

コード例:

指定されたオプションでzIndexsortable を初期化:

$( ".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 に 1 つ以上のオプションを設定します。
  • options
    型:Object
    説明:設定するオプションと値のペア。

コード例:

このメソッドの呼び出し:

$( ".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
      説明:属性値をキーと値の 2 つの部分に分割するための正規表現。

コード例:

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 オブジェクト。
    • item
      型:jQuery
      説明:現在ドラッグされている要素を表す jQuery オブジェクト。
    • offset
      型:Object
      説明:ヘルパーの現在の絶対位置。{ top, left }。
    • position
      型:Object
      説明:ヘルパーの現在位置。{ 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 ソートが停止したときにこのイベントがトリガーされます。ただし、プレースホルダー/ヘルパーがまだ利用可能な場合は除きます。
  • event
    型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の beforeStop コールバックを持つソータブルの初期化:

$( ".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オブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の change コールバックを持つソータブルの初期化:

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

sortchange イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortchange", function( event, ui ) {} );
    
create( event, ui ) sortcreate droppable が作成されたときに発生します。
  • event
    类型:Event
  • ui
    类型:Object

注:uiオブジェクトは空です。他のイベントとの一貫性を保つために含まれています。

コード例:

指定の create コールバックを持つソータブルの初期化:

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

sortcreate イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortcreate", function( event, ui ) {} );
    
deactivate( event, ui ) sortdeactivate ソートが停止したときにこのイベントが発生します。このイベントは、可能なすべての接続リストに伝播します。
  • event
    类型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の deactivate コールバックを持つソータブルの初期化:

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

sortdeactivate イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortdeactivate", function( event, ui ) {} );
    
out( event, ui ) sortout ソータブル項目がソータブルリストから削除されたときにこのイベントが発生します。

注釈:ソータブル項目が取り消されたときにもこのイベントが発生します。

  • event
    类型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の out コールバックを持つソータブルの初期化:

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

sortout イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortout", function( event, ui ) {} );
    
over( event, ui ) sortover ソータブル項目がソータブルリストに移動したときにこのイベントが発生します。
  • event
    类型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の over コールバックを持つソータブルの初期化:

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

sortover イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortout", function( event, ui ) {} );
    
receive( event, ui ) sortreceive 接続されたソータブルリストから別のリストに項目が配置されたときにこのイベントが発生します。後者がイベントターゲットです。
  • event
    类型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ top, left }。
    • position
      类型:Object
      説明:ヘルパーの現在位置。次のように表されます。{ top, left }。
    • originalPosition
      类型:Object
      描述:要素の元の位置。次のように表されます。{ top, left }。
    • sender
      类型:jQuery
      描述:あるソータブルから別のソータブルへ移動する場合、項目が由来するソータブル。
    • placeholder
      类型:jQuery
      描述:jQueryオブジェクト。プレースホルダーとして使用されている要素を表します。

コード例:

指定の receive コールバックを持つソータブルの初期化:

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

sortreceive イベントにイベントリスナーをバインドする:

$( ".selector" ).on( "sortreceive", function( event, ui ) {} );
    
remove( event, ui ) sortremove 接続されたソータブルリストから別のリストに項目が配置されたときにこのイベントが発生します。前者がイベントターゲットです。
  • event
    类型:Event
  • ui
    类型:Object
    • helper
      类型:jQuery
      描述:jQueryオブジェクト。並べ替えられているヘルパーを表します。
    • item
      类型:jQuery
      説明:jQueryオブジェクト。現在ドラッグされている要素を表します。
    • offset
      类型:Object
      説明:ヘルパーの現在の絶対位置。次のように表されます。{ 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
      説明:ソートされるヘルパー(helper)を表す jQuery オブジェクト。
    • 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
      説明:ソートされるヘルパー(helper)を表す jQuery オブジェクト。
    • 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
      説明:ソートされるヘルパー(helper)を表す jQuery オブジェクト。
    • 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
      説明:ソートされるヘルパー(helper)を表す jQuery オブジェクト。
    • 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>

その他の拡張