jQuery UI API - ドロッパブル・ウィジェット(Droppable Widget)
カテゴリ
使用方法
説明:ドラッガブル・ウィジェットのターゲットを作成します。
追加されたバージョン:1.0
依存関係:
注釈:jQuery UI の droppable(ドロッパブル)プラグインを使用すると、選択した要素をドロップ可能にします(つまり、ドラッグ後にドロップを受け入れます)。どの draggable が受け入れられるかを個別に指定できます。
クイックナビゲーション
| オプション | メソッド | イベント |
|---|---|---|
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| accept | セレクタまたは Function() | どのドラッガブル(draggable)要素が droppable に受け入れられるかを制御します。 複数の型をサポートします:
コード例: 指定された
$( ".selector" ).droppable({ accept: ".special" });
初期化後に、 // getter var accept = $( ".selector" ).droppable( "option", "accept" ); // setter $( ".selector" ).droppable( "option", "accept", ".special" ); |
"*" |
| activeClass | String | このオプションを指定すると、受け入れ可能な draggable がドラッグされたときに、クラスが droppable に追加されます。 コード例: 指定された
$( ".selector" ).droppable({ activeClass: "ui-state-highlight" });
初期化後に、 // getter var activeClass = $( ".selector" ).droppable( "option", "activeClass" ); // setter $( ".selector" ).droppable( "option", "activeClass", "ui-state-highlight" ); |
false |
| addClasses | Boolean | ~に設定するとfalse、ui-droppableクラスが追加されるのを防ぎます。これは、数百の要素に対して.droppable()を呼び出す際のパフォーマンス最適化に役立ちます。コード例: 指定された
$( ".selector" ).droppable({ addClasses: false });
初期化後に、 // getter var addClasses = $( ".selector" ).droppable( "option", "addClasses" ); // setter $( ".selector" ).droppable( "option", "addClasses", false ); |
true |
| disabled | Boolean | ~に設定するとtrue、その droppable は無効になります。コード例: 指定された
$( ".selector" ).droppable({ disabled: true });
初期化後に、 // getter var disabled = $( ".selector" ).droppable( "option", "disabled" ); // setter $( ".selector" ).droppable( "option", "disabled", true ); |
false |
| greedy | Boolean | デフォルトでは、要素がネストされた droppable 上にドロップされると、各 droppable がその要素を受け取ります。ただし、このオプションをtrueに設定すると、親要素の droppable はその要素を受け取れなくなります。dropイベントは通常どおり発生しますが、event.targetどの droppable が draggable 要素を受け取るかを確認するためにチェックされます。コード例: 指定された
$( ".selector" ).droppable({ greedy: true });
初期化後に、 // getter var greedy = $( ".selector" ).droppable( "option", "greedy" ); // setter $( ".selector" ).droppable( "option", "greedy", true ); |
false |
| hoverClass | String | このオプションを指定すると、受け入れ可能な draggable が droppable の上に重なったときに、クラスが droppable に追加されます。 コード例: 指定された
$( ".selector" ).droppable({ hoverClass: "drop-hover" });
初期化後に、 // getter var hoverClass = $( ".selector" ).droppable( "option", "hoverClass" ); // setter $( ".selector" ).droppable( "option", "hoverClass", "drop-hover" ); |
false |
| scope | String | 対応する draggable と droppable の項目をグループ化するために使用します。droppable のacceptオプションに加えて、droppable と同じscope値を持つ draggable は、その droppable に受け入れられます。コード例: 指定された
$( ".selector" ).droppable({ scope: "tasks" });
初期化後に、 // getter var scope = $( ".selector" ).droppable( "option", "scope" ); // setter $( ".selector" ).droppable( "option", "scope", "tasks" ); |
"default" |
| tolerance | String | draggable が droppable に重なっているかどうかをテストするモードを指定します。可能な値:
コード例: 指定された
$( ".selector" ).droppable({ tolerance: "fit" });
初期化後に、 // getter var tolerance = $( ".selector" ).droppable( "option", "tolerance" ); // setter $( ".selector" ).droppable( "option", "tolerance", "fit" ); |
"intersect" |
| メソッド | 戻り値 | 説明 |
|---|---|---|
| destroy() | jQuery (plugin only) | droppable 機能を完全に削除します。これにより、要素は初期化前の状態に戻ります。
コード例: destroy メソッドを呼び出します: $( ".selector" ).droppable( "destroy" ); |
| disable() | jQuery (plugin only) | droppable を無効にします。
コード例: disable メソッドを呼び出します: $( ".selector" ).droppable( "disable" ); |
| enable() | jQuery (plugin only) | droppable を有効にします。
コード例: enable メソッドを呼び出します: $( ".selector" ).droppable( "enable" ); |
| option( optionName ) | Object | 指定されたoptionNameに関連付けられた現在の値を取得します。
コード例: このメソッドを呼び出します: var isDisabled = $( ".selector" ).droppable( "option", "disabled" ); |
| option() | PlainObject | 現在の droppable オプションハッシュを表すキーと値のペアを含むオブジェクトを取得します。
コード例: このメソッドを呼び出します: var options = $( ".selector" ).droppable( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | 指定されたoptionNameに関連付けられた droppable オプションの値を設定します。
コード例: このメソッドを呼び出します: $( ".selector" ).droppable( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | droppable に 1 つ以上のオプションを設定します。
コード例: このメソッドを呼び出します:
$( ".selector" ).droppable( "option", { disabled: true } );
|
| widget() | jQuery | droppable 要素を含むjQueryオブジェクトを返します。
コード例: widget メソッドを呼び出します: var widget = $( ".selector" ).droppable( "widget" ); |
| イベント | 型 | 説明 |
|---|---|---|
| activate( event, ui ) | dropactivate | 受け入れ可能な draggable がドラッグを開始したときに発生します。droppable がドロップされたときに「ライトアップ」させたい場合、このオプションが役立ちます。
コード例: activate コールバックを指定して droppable を初期化:
$( ".selector" ).droppable({
activate: function( event, ui ) {}
});
dropactivate イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dropactivate", function( event, ui ) {} );
|
| create( event, ui ) | dropcreate | droppable が作成されたときに発生します。
注意: コード例: 指定した create コールバックを持つ droppable を初期化します:
$( ".selector" ).droppable({
create: function( event, ui ) {}
});
dropcreate イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dropcreate", function( event, ui ) {} );
|
| deactivate( event, ui ) | dropdeactivate | 受け入れ可能な draggable がドラッグを停止したときにトリガーされます。
コード例: 指定した deactivate コールバックを持つ droppable を初期化します:
$( ".selector" ).droppable({
deactivate: function( event, ui ) {}
});
dropdeactivate イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dropdeactivate", function( event, ui ) {} );
|
| drop( event, ui ) | drop | 受け入れ可能な draggable が droppable に配置されたときにトリガーされます(toleranceオプションに基づく)。
コード例: 指定した drop コールバックを持つ droppable を初期化します:
$( ".selector" ).droppable({
drop: function( event, ui ) {}
});
drop イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "drop", function( event, ui ) {} );
|
| out( event, ui ) | dropout | droppable が droppable からドラッグアウトされたときにトリガーされます(toleranceオプションに基づく)。
注意: コード例: 指定した out コールバックを持つ droppable を初期化します:
$( ".selector" ).droppable({
out: function( event, ui ) {}
});
dropout イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dropout", function( event, ui ) {} );
|
| over( event, ui ) | dropover | 受け入れ可能な draggable が droppable 上にドラッグされたときにトリガーされます(toleranceオプションに基づく)。
コード例: 指定した over コールバックを持つ droppable を初期化します:
$( ".selector" ).droppable({
over: function( event, ui ) {}
});
dropover イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dropover", function( event, ui ) {} );
|
例
draggable と droppable の要素のペア。
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>可放置小部件(Droppable Widget)演示</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
<style>
#draggable {
width: 100px;
height: 100px;
background: #ccc;
}
#droppable {
position: absolute;
left: 250px;
top: 0;
width: 125px;
height: 125px;
background: #999;
color: #fff;
padding: 10px;
}
</style>
<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>
<div id="droppable">请放置到这里!</div>
<div id="draggable">请拖拽我!</div>
<script>
$( "#draggable" ).draggable();
$( "#droppable" ).droppable({
drop: function() {
alert( "dropped" );
}
});
</script>
</body>
</html>
その他の拡張