jQuery UI API - ドラッグ可能ウィジェット(Draggable Widget)
所属カテゴリ
使用法
説明:マウスで要素を移動できるようにします。
バージョンで追加:1.0
依存:
注釈:選択した要素をマウスでドラッグできるようにします。ドラッグだけでなく、ドラッグ&ドロップを行う場合は、次を参照してください。jQuery UI ドロップ可能(Droppable)プラグインこれは、ドラッグ可能な要素にドロップ先を提供します。
クイックナビゲーション
| オプション | メソッド | イベント |
|---|---|---|
| オプション | 型 | 説明 | デフォルト値 |
|---|---|---|---|
| addClasses | Boolean | に設定するとfalse、次の追加を阻止しますui-draggableclass が追加されます。数百の要素に対して呼び出した場合.draggable()、この設定はパフォーマンスの最適化に役立ちます。コード例: 指定された
$( ".selector" ).draggable({ addClasses: false });
初期化後、取得または設定します // getter var addClasses = $( ".selector" ).draggable( "option", "addClasses" ); // setter $( ".selector" ).draggable( "option", "addClasses", false ); |
true |
| appendTo | jQuery、Element、Selector、または String | ドラッグ時に、draggable ヘルパー(helper)がどの要素に追加されるか。 複数の型をサポート:
コード例: 指定された
$( ".selector" ).draggable({ appendTo: "body" });
初期化後、取得または設定します // getter var appendTo = $( ".selector" ).draggable( "option", "appendTo" ); // setter $( ".selector" ).draggable( "option", "appendTo", "body" ); |
"parent" |
| axis | String | 水平軸 (x) または垂直軸 (y) にドラッグを制限します。可能な値:"x", "y"。コード例: 指定された
$( ".selector" ).draggable({ axis: "x" });
初期化後、取得または設定します // getter var axis = $( ".selector" ).draggable( "option", "axis" ); // setter $( ".selector" ).draggable( "option", "axis", "x" ); |
false |
| cancel | Selector | 指定された要素からドラッグが開始されるのを防ぎます。 コード例: 指定された
$( ".selector" ).draggable({ cancel: ".title" });
初期化後、取得または設定します // getter var cancel = $( ".selector" ).draggable( "option", "cancel" ); // setter $( ".selector" ).draggable( "option", "cancel", ".title" ); |
"input, textarea, button, select, option" |
| connectToSortable | Selector | draggable を指定された sortable に配置できるようにします。このオプションを使用すると、draggable を sortable リストに配置して、そのリストの一部にすることができます。注意:helperオプションは次のように設定する必要があります"clone"、より適切に機能させるためです。次のものを含める必要がありますソータブルウィジェット(Sortable Widget)。コード例: 指定された
$( ".selector" ).draggable({ connectToSortable: "#my-sortable" });
初期化後、取得または設定します // getter var connectToSortable = $( ".selector" ).draggable( "option", "connectToSortable" ); // setter $( ".selector" ).draggable( "option", "connectToSortable", "#my-sortable" ); |
false |
| containment | Selector、Element、String、または Array | 指定された要素または領域の境界内にドラッグを制限します。 複数の型をサポート:
コード例: 指定された
$( ".selector" ).draggable({ containment: "parent" });
初期化後、取得または設定します // getter var containment = $( ".selector" ).draggable( "option", "containment" ); // setter $( ".selector" ).draggable( "option", "containment", "parent" ); |
false |
| cursor | String | ドラッグ操作中の CSS カーソル。 コード例: 指定された
$( ".selector" ).draggable({ cursor: "crosshair" });
初期化後、取得または設定します // getter var cursor = $( ".selector" ).draggable( "option", "cursor" ); // setter $( ".selector" ).draggable( "option", "cursor", "crosshair" ); |
"auto" |
| cursorAt | Object | ドラッグヘルパー(helper)のマウスカーソルに対するオフセットを設定します。座標は、1つまたは2つのキーの組み合わせでハッシュとして指定できます:{ top, left, right, bottom }。コード例: 指定された
$( ".selector" ).draggable({ cursorAt: { left: 5 } });
初期化後、取得または設定します
// getter
var cursorAt = $( ".selector" ).draggable( "option", "cursorAt" );
// setter
$( ".selector" ).draggable( "option", "cursorAt", { left: 5 } );
|
false |
| delay | Number | マウスを押してからドラッグが始まるまでの時間(ミリ秒単位)。このオプションは、要素をクリックしたときに不要なドラッグが発生するのを防ぐことができます。 コード例: 指定された
$( ".selector" ).draggable({ delay: 300 });
初期化後、取得または設定します // getter var delay = $( ".selector" ).draggable( "option", "delay" ); // setter $( ".selector" ).draggable( "option", "delay", 300 ); |
0 |
| disabled | Boolean | に設定するとtrue、この draggable は無効になります。コード例: 指定された
$( ".selector" ).draggable({ disabled: true });
初期化後、取得または設定します // getter var disabled = $( ".selector" ).draggable( "option", "disabled" ); // setter $( ".selector" ).draggable( "option", "disabled", true ); |
false |
| distance | Number | マウスを押してからドラッグを開始するまでに移動しなければならない距離(ピクセル単位)。このオプションは、要素をクリックしたときに不要なドラッグが発生するのを防ぐことができます。 コード例: 指定された
$( ".selector" ).draggable({ distance: 10 });
初期化後、取得または設定します // getter var distance = $( ".selector" ).draggable( "option", "distance" ); // setter $( ".selector" ).draggable( "option", "distance", 10 ); |
1 |
| grid | Array | ドラッグヘルパー(helper)をグリッドに揃えます。x および y ピクセルごと。配列の形式は次のとおりです[ x, y ]。コード例: 指定された
$( ".selector" ).draggable({ grid: [ 50, 20 ] });
初期化後、取得または設定します // getter var grid = $( ".selector" ).draggable( "option", "grid" ); // setter $( ".selector" ).draggable( "option", "grid", [ 50, 20 ] ); |
false |
| handle | Selector または Element | このオプションを指定すると、マウスが指定された要素上で押されない限り、ドラッグの開始が制限されます。ドラッグ可能(draggable)要素の子孫要素のみがドラッグを許可されます。 コード例: 指定された
$( ".selector" ).draggable({ handle: "h2" });
初期化後、取得または設定します // getter var handle = $( ".selector" ).draggable( "option", "handle" ); // setter $( ".selector" ).draggable( "option", "handle", "h2" ); |
false |
| helper | String または Function() | ドラッグ表示にヘルパー要素を使用することができます。 複数の型をサポート:
コード例: 指定された
$( ".selector" ).draggable({ helper: "clone" });
初期化後、取得または設定します // getter var helper = $( ".selector" ).draggable( "option", "helper" ); // setter $( ".selector" ).draggable( "option", "helper", "clone" ); |
"original" |
| iframeFix | Boolean または Selector | ドラッグ中に iframes がマウス移動(mousemove)イベントをキャプチャするのを防ぎます。cursorAtオプションと組み合わせて使用する場合、またはマウスカーソルがヘルパー(helper)の上にない場合に役立ちます。複数の型をサポート:
コード例: 指定された
$( ".selector" ).draggable({ iframeFix: true });
初期化後、取得または設定します // getter var iframeFix = $( ".selector" ).draggable( "option", "iframeFix" ); // setter $( ".selector" ).draggable( "option", "iframeFix", true ); |
false |
| opacity | Number | ドラッグ中のヘルパー(helper)の不透明度。 コード例: 指定された
$( ".selector" ).draggable({ opacity: 0.35 });
初期化後、取得または設定します // getter var opacity = $( ".selector" ).draggable( "option", "opacity" ); // setter $( ".selector" ).draggable( "option", "opacity", 0.35 ); |
false |
| refreshPositions | Boolean | に設定するとtrue、マウス移動(mousemove)のたびにすべてのドロップ可能な位置が計算されます。注意:これは高度に動的な問題を解決しますが、パフォーマンスを著しく低下させます。コード例: 指定された
$( ".selector" ).draggable({ refreshPositions: true });
初期化後に // getter var refreshPositions = $( ".selector" ).draggable( "option", "refreshPositions" ); // setter $( ".selector" ).draggable( "option", "refreshPositions", true ); |
false |
| revert | Boolean または String または Function() | ドラッグが停止したときに、要素が開始位置に戻るかどうか。 複数のタイプをサポート:
コード例: 指定された
$( ".selector" ).draggable({ revert: true });
初期化後に // getter var revert = $( ".selector" ).draggable( "option", "revert" ); // setter $( ".selector" ).draggable( "option", "revert", true ); |
false |
| revertDuration | Number | 元に戻す(revert)アニメーションの時間(ミリ秒)。もしrevertオプションがfalseの場合は無視されます。コード例: 指定された
$( ".selector" ).draggable({ revertDuration: 200 });
初期化後に // getter var revertDuration = $( ".selector" ).draggable( "option", "revertDuration" ); // setter $( ".selector" ).draggable( "option", "revertDuration", 200 ); |
500 |
| scope | String | draggable と droppable の項目をグループ化するために使用されます。droppable のacceptオプションに加えて、droppable と同じscope値を持つ draggable は、その droppable に受け入れられます。コード例: 指定された
$( ".selector" ).draggable({ scope: "tasks" });
初期化後に // getter var scope = $( ".selector" ).draggable( "option", "scope" ); // setter $( ".selector" ).draggable( "option", "scope", "tasks" ); |
"default" |
| scroll | Boolean | もしtrueに設定されている場合、ドラッグ中にコンテナは自動的にスクロールします。コード例: 指定された
$( ".selector" ).draggable({ scroll: false });
初期化後に // getter var scroll = $( ".selector" ).draggable( "option", "scroll" ); // setter $( ".selector" ).draggable( "option", "scroll", false ); |
true |
| scrollSensitivity | Number | スクロールを開始するビューポートの端からの距離(ピクセル単位)。距離はポインター基準であり、draggable 基準ではありません。もしscrollオプションがfalseの場合は無視されます。コード例: 指定された
$( ".selector" ).draggable({ scrollSensitivity: 100 });
初期化後に // getter var scrollSensitivity = $( ".selector" ).draggable( "option", "scrollSensitivity" ); // setter $( ".selector" ).draggable( "option", "scrollSensitivity", 100 ); |
20 |
| scrollSpeed | Number | マウスポインターがscrollSensitivity距離内に入ると、ウィンドウがスクロールする速度。もしscrollオプションがfalseの場合は無視されます。コード例: 指定された
$( ".selector" ).draggable({ scrollSpeed: 100 });
初期化後に // getter var scrollSpeed = $( ".selector" ).draggable( "option", "scrollSpeed" ); // setter $( ".selector" ).draggable( "option", "scrollSpeed", 100 ); |
20 |
| snap | Boolean または Selector | 要素を他の要素にスナップするかどうか。 複数のタイプをサポート:
コード例: 指定された
$( ".selector" ).draggable({ snap: true });
初期化後に // getter var snap = $( ".selector" ).draggable( "option", "snap" ); // setter $( ".selector" ).draggable( "option", "snap", true ); |
false |
| snapMode | String | draggable がスナップする要素のどの端にスナップするかを決定します。もしsnapオプションがfalseの場合は無視されます。可能な値:"inner"、"outer"、"both"。コード例: 指定された
$( ".selector" ).draggable({ snapMode: "inner" });
初期化後に // getter var snapMode = $( ".selector" ).draggable( "option", "snapMode" ); // setter $( ".selector" ).draggable( "option", "snapMode", "inner" ); |
"both" |
| snapTolerance | Number | スナップが発生するスナップ要素の端からの距離(ピクセル単位)。もしsnapオプションがfalseの場合は無視されます。コード例: 指定された
$( ".selector" ).draggable({ snapTolerance: 30 });
初期化後に // getter var snapTolerance = $( ".selector" ).draggable( "option", "snapTolerance" ); // setter $( ".selector" ).draggable( "option", "snapTolerance", 30 ); |
20 |
| stack | Selector | セレクターに一致する要素グループの z-index を制御します。常に現在のドラッグ項目の前に表示され、ウィンドウマネージャーのようなものに役立ちます。 コード例: 指定された
$( ".selector" ).draggable({ stack: ".products" });
初期化後に // getter var stack = $( ".selector" ).draggable( "option", "stack" ); // setter $( ".selector" ).draggable( "option", "stack", ".products" ); |
false |
| zIndex | Number | ドラッグ中のヘルパー(helper)の z-index。 コード例: 指定された
$( ".selector" ).draggable({ zIndex: 100 });
初期化後に // getter var zIndex = $( ".selector" ).draggable( "option", "zIndex" ); // setter $( ".selector" ).draggable( "option", "zIndex", 100 ); |
false |
| メソッド | 戻り値 | 説明 |
|---|---|---|
| destroy() | jQuery (plugin only) | draggable 機能を完全に削除します。これにより、要素は初期化前の状態に戻ります。
コード例: destroy メソッドを呼び出します: $( ".selector" ).draggable( "destroy" ); |
| disable() | jQuery (plugin only) | draggable を無効にします。
コード例: disable メソッドを呼び出します: $( ".selector" ).draggable( "disable" ); |
| enable() | jQuery (plugin only) | draggable を有効にします。
コード例: enable メソッドを呼び出します: $( ".selector" ).draggable( "enable" ); |
| option( optionName ) | Object | 指定されたoptionNameに関連付けられた現在の値を取得します。
コード例: このメソッドを呼び出します: var isDisabled = $( ".selector" ).draggable( "option", "disabled" ); |
| option() | PlainObject | 現在の draggable オプションのハッシュを表すキーと値のペアを含むオブジェクトを取得します。
コード例: このメソッドを呼び出します: var options = $( ".selector" ).draggable( "option" ); |
| option( optionName, value ) | jQuery (plugin only) | 指定されたoptionNameに関連付けられた draggable オプションの値を設定します。
コード例: このメソッドを呼び出します: $( ".selector" ).draggable( "option", "disabled", true ); |
| option( options ) | jQuery (plugin only) | draggable に1つ以上のオプションを設定します。
コード例: このメソッドを呼び出します:
$( ".selector" ).draggable( "option", { disabled: true } );
|
| widget() | jQuery | draggable 要素を含むjQueryオブジェクトを返します。
コード例: widget メソッドを呼び出します: var widget = $( ".selector" ).draggable( "widget" ); |
| イベント | タイプ | 説明 |
|---|---|---|
| create( event, ui ) | dragcreate | draggable が作成されたときにトリガーされます。
注: コード例: 指定された create コールバックを持つ draggable を初期化:
$( ".selector" ).draggable({
create: function( event, ui ) {}
});
dragcreate イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dragcreate", function( event, ui ) {} );
|
| drag( event, ui ) | drag | ドラッグ中にマウスが移動したときにトリガーされます。
コード例: 指定された drag コールバックを持つ draggable を初期化:
$( ".selector" ).draggable({
drag: function( event, ui ) {}
});
drag イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "drag", function( event, ui ) {} );
|
| start( event, ui ) | dragstart | ドラッグ開始時にトリガーされます。
コード例: 指定した start コールバックを持つ draggable を初期化します:
$( ".selector" ).draggable({
start: function( event, ui ) {}
});
dragstart イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dragstart", function( event, ui ) {} );
|
| stop( event, ui ) | dragstop | ドラッグが停止したときにトリガーされます。
コード例: 指定した stop コールバックを持つ draggable を初期化します:
$( ".selector" ).draggable({
stop: function( event, ui ) {}
});
dragstop イベントにイベントリスナーをバインドします:
$( ".selector" ).on( "dragstop", function( event, ui ) {} );
|
例
シンプルな jQuery UI ドラッグ可能ウィジェット(Draggable Widget)。
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>可拖拽小部件(Draggable 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;
}
</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="draggable">请拖拽我!</div>
<script>
$( "#draggable" ).draggable();
</script>
</body>
</html>
その他の拡張