jQuery UI 實例 - 拖動（Draggable） · W3School jQuery UI 教程

# jQuery UI 實例 - 拖動（Draggable）允許使用鼠標移動元素。如需了解更多有關 draggable 交互的細節，請查看 API 文檔 [可拖拽小部件（Draggable Widget）](api-draggable.html)。 ## 默認功能在任意的 DOM 元素上啟用 draggable 功能。通過鼠標點擊并在視區中拖動來移動 draggable 對象。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 默認功能</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable { width: 150px; height: 150px; padding: 0.5em; } </style> <script> $(function() { $( "#draggable" ).draggable(); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p>請拖動我！</p> </div> </body> </html> ``` ## 自動滾動當 draggable 移動到視區外時自動滾動文檔。設置 `scroll` 選項為 true 來啟用自動滾動，當滾動觸發時進行微調，滾動速度是通過 `scrollSensitivity` 和 `scrollSpeed` 選項設置的。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 自動滾動</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2, #draggable3 { width: 100px; height: 100px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } </style> <script> $(function() { $( "#draggable" ).draggable({ scroll: true }); $( "#draggable2" ).draggable({ scroll: true, scrollSensitivity: 100 }); $( "#draggable3" ).draggable({ scroll: true, scrollSpeed: 100 }); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p>Scroll 設置為 true，默認設置</p> </div> <div id="draggable2" class="ui-widget-content"> <p>scrollSensitivity 設置為 100</p> </div> <div id="draggable3" class="ui-widget-content"> <p>scrollSpeed 設置為 100</p> </div> <div style="height: 5000px; width: 1px;"></div> </body> </html> ``` ## 約束運動通過定義 draggable 區域的邊界來約束每個 draggable 的運動。設置 `axis` 選項來限制 draggable 的路徑為 x 軸或者 y 軸，或者使用 `containment` 選項來指定一個父級的 DOM 元素或者一個 jQuery 選擇器，比如 'document.'。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 約束運動</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> .draggable { width: 90px; height: 90px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } #draggable, #draggable2 { margin-bottom:20px; } #draggable { cursor: n-resize; } #draggable2 { cursor: e-resize; } #containment-wrapper { width: 95%; height:150px; border:2px solid #ccc; padding: 10px; } h3 { clear: left; } </style> <script> $(function() { $( "#draggable" ).draggable({ axis: "y" }); $( "#draggable2" ).draggable({ axis: "x" }); $( "#draggable3" ).draggable({ containment: "#containment-wrapper", scroll: false }); $( "#draggable5" ).draggable({ containment: "parent" }); }); </script> </head> <body> <h3>沿著軸約束運動：</h3> <div id="draggable" class="draggable ui-widget-content"> <p>只能垂直拖拽</p> </div> <div id="draggable2" class="draggable ui-widget-content"> <p>只能水平拖拽</p> </div> <h3>或者在另一個 DOM 元素中約束運動：</h3> <div id="containment-wrapper"> <div id="draggable3" class="draggable ui-widget-content"> <p>我被約束在盒子里</p> </div> <div class="draggable ui-widget-content"> <p id="draggable5" class="ui-widget-header">我被約束在父元素內</p> </div> </div> </body> </html> ``` ## 光標樣式當拖拽對象時定位光標。默認情況下，光標是出現在被拖拽對象的中間。使用 `cursorAt` 選項來指定相對于 draggable 的另一個位置（指定一個相對于 top、right、bottom、left 的像素值）。通過提供一個帶有有效的 CSS 光標值的 `cursor` 選項，來自定義光標的外觀。有效的 CSS 光標值包括：default、move、pointer、crosshair，等等。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 光標樣式</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2, #draggable3 { width: 100px; height: 100px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } </style> <script> $(function() { $( "#draggable" ).draggable({ cursor: "move", cursorAt: { top: 56, left: 56 } }); $( "#draggable2" ).draggable({ cursor: "crosshair", cursorAt: { top: -5, left: -5 } }); $( "#draggable3" ).draggable({ cursorAt: { bottom: 0 } }); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p>我總是在中間（相對于鼠標）</p> </div> <div id="draggable2" class="ui-widget-content"> <p>我的光標是在 left -5 和 top -5</p> </div> <div id="draggable3" class="ui-widget-content"> <p>我的光標位置只控制了 'bottom' 值</p> </div> </body> </html> ``` ## 延遲開始通過 `delay` 選項設置延遲開始拖拽的毫秒數。通過 `distance` 選項設置光標被按下且拖拽指定像素后才允許拖拽。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 延遲開始</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2 { width: 120px; height: 120px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } </style> <script> $(function() { $( "#draggable" ).draggable({ distance: 20 }); $( "#draggable2" ).draggable({ delay: 1000 }); $( ".ui-draggable" ).disableSelection(); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p>只有把我拖拽了 20 像素后，拖拽才開始</p> </div> <div id="draggable2" class="ui-widget-content"> <p>不管 distance 是多少，您都必須拖拽并等待 1000ms 后拖拽才開始</p> </div> </body> </html> ``` ## 事件 draggable 上的 `start`、`drag` 和 `stop` 事件。拖拽開始時觸發 `start` 事件，拖拽期間觸發 `drag` 事件，拖拽停止時觸發 `stop` 事件。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 事件</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable { width: 16em; padding: 0 1em; } #draggable ul li { margin: 1em 0; padding: 0.5em 0; } * html #draggable ul li { height: 1%; } #draggable ul li span.ui-icon { float: left; } #draggable ul li span.count { font-weight: bold; } </style> <script> $(function() { var $start_counter = $( "#event-start" ), $drag_counter = $( "#event-drag" ), $stop_counter = $( "#event-stop" ), counts = [ 0, 0, 0 ]; $( "#draggable" ).draggable({ start: function() { counts[ 0 ]++; updateCounterStatus( $start_counter, counts[ 0 ] ); }, drag: function() { counts[ 1 ]++; updateCounterStatus( $drag_counter, counts[ 1 ] ); }, stop: function() { counts[ 2 ]++; updateCounterStatus( $stop_counter, counts[ 2 ] ); } }); function updateCounterStatus( $event_counter, new_count ) { // 首先更新視覺狀態... if ( !$event_counter.hasClass( "ui-state-hover" ) ) { $event_counter.addClass( "ui-state-hover" ) .siblings().removeClass( "ui-state-hover" ); } // ...然后更新數字 $( "span.count", $event_counter ).text( new_count ); } }); </script> </head> <body> <div id="draggable" class="ui-widget ui-widget-content"> <p>請拖拽我，觸發一連串的事件。</p> <ul class="ui-helper-reset"> <li id="event-start" class="ui-state-default ui-corner-all"><span class="ui-icon ui-icon-play"></span>"start" 被調用 <span class="count">0</span>x</li> <li id="event-drag" class="ui-state-default ui-corner-all"><span class="ui-icon ui-icon-arrow-4"></span>"drag" 被調用 <span class="count">0</span>x</li> <li id="event-stop" class="ui-state-default ui-corner-all"><span class="ui-icon ui-icon-stop"></span>"stop" 被調用 <span class="count">0</span>x</li> </ul> </div> </body> </html> ``` ## Handles 只有當光標在 draggable 上指定部分時才允許拖拽。使用 `handle` 選項來指定用于拖拽對象的元素（或元素組）的 jQuery 選擇器。 Or prevent dragging when the cursor is over a specific element (or group of elements) within the draggable. Use the cancel option to specify a jQuery selector over which to "cancel" draggable functionality. 或者當光標在 draggable 內指定元素（或元素組）上時不允許拖拽。使用 `handle` 選項來指定取消拖拽功能的 jQuery 選擇器。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - Handles</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2 { width: 100px; height: 100px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } #draggable p { cursor: move; } </style> <script> $(function() { $( "#draggable" ).draggable({ handle: "p" }); $( "#draggable2" ).draggable({ cancel: "p.ui-widget-header" }); $( "div, p" ).disableSelection(); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p class="ui-widget-header">您只可以在這個范圍內拖拽我</p> </div> <div id="draggable2" class="ui-widget-content"> <p>您可以把我向四周拖拽…</p> <p class="ui-widget-header">…但是您不可以在這個范圍內拖拽我</p> </div> </body> </html> ``` ## 還原位置當帶有布爾值 `revert` 選項的 draggable 停止拖拽時，返回 draggable（或它的助手）到原始位置。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 還原位置</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2 { width: 100px; height: 100px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } </style> <script> $(function() { $( "#draggable" ).draggable({ revert: true }); $( "#draggable2" ).draggable({ revert: true, helper: "clone" }); }); </script> </head> <body> <div id="draggable" class="ui-widget-content"> <p>還原</p> </div> <div id="draggable2" class="ui-widget-content"> <p>還原助手</p> </div> </body> </html> ``` ## 對齊到元素或網格對齊 draggable 到 DOM 元素的內部或外部邊界。使用 `snap`、`snapMode`（inner, outer, both）和 `snapTolerance`（當調用對齊時，draggable 與元素之間的距離，以像素為單位）選項。或者對齊 draggable 到網格。通過 `grid` 選項設置網格單元的尺寸（以像素為單位的高度或寬度）。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 對齊到元素或網格</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> .draggable { width: 90px; height: 80px; padding: 5px; float: left; margin: 0 10px 10px 0; font-size: .9em; } .ui-widget-header p, .ui-widget-content p { margin: 0; } #snaptarget { height: 140px; } </style> <script> $(function() { $( "#draggable" ).draggable({ snap: true }); $( "#draggable2" ).draggable({ snap: ".ui-widget-header" }); $( "#draggable3" ).draggable({ snap: ".ui-widget-header", snapMode: "outer" }); $( "#draggable4" ).draggable({ grid: [ 20, 20 ] }); $( "#draggable5" ).draggable({ grid: [ 80, 80 ] }); }); </script> </head> <body> <div id="snaptarget" class="ui-widget-header"> <p>我是對齊目標</p> </div> <br style="clear:both"> <div id="draggable" class="draggable ui-widget-content"> <p>默認（snap: true），對齊到所有其他的 draggable 元素</p> </div> <div id="draggable2" class="draggable ui-widget-content"> <p>我只對齊到大盒子</p> </div> <div id="draggable3" class="draggable ui-widget-content"> <p>我只對齊到大盒子的外邊緣</p> </div> <div id="draggable4" class="draggable ui-widget-content"> <p>我對齊到一個 20 x 20 網格</p> </div> <div id="draggable5" class="draggable ui-widget-content"> <p>我對齊到一個 80 x 80 網格</p> </div> </body> </html> ``` ## 視覺反饋給用戶提供反饋，就像以助手方式拖拽對象一樣。`helper` 選項接受值 'original'（用光標移動 draggable 對象），'clone'（用光標移動 draggable 的副本），或者一個返回 DOM 元素的函數（該元素在拖拽期間顯示在光標附近）。通過 `opacity` 選項控制助手的透明度。為了區別哪一個 draggable 正在被拖拽，讓在運動中的 draggable 保持最前。如果正在拖拽，使用 `zIndex` 選項來設置助手的高度 z-index，或者使用 `stack` 選項來確保當停止拖拽時，最后一個被拖拽的項目總是出現在同組其他項目的上面。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） - 視覺反饋</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> #draggable, #draggable2, #draggable3, #set div { width: 90px; height: 90px; padding: 0.5em; float: left; margin: 0 10px 10px 0; } #draggable, #draggable2, #draggable3 { margin-bottom:20px; } #set { clear:both; float:left; width: 368px; height: 120px; } p { clear:both; margin:0; padding:1em 0; } </style> <script> $(function() { $( "#draggable" ).draggable({ helper: "original" }); $( "#draggable2" ).draggable({ opacity: 0.7, helper: "clone" }); $( "#draggable3" ).draggable({ cursor: "move", cursorAt: { top: -12, left: -20 }, helper: function( event ) { return $( "<div class='ui-widget-header'>I'm a custom helper</div>" ); } }); $( "#set div" ).draggable({ stack: "#set div" }); }); </script> </head> <body> <h3 class="docs">助手：</h3> <div id="draggable" class="ui-widget-content"> <p>原始的</p> </div> <div id="draggable2" class="ui-widget-content"> <p>半透明的克隆</p> </div> <div id="draggable3" class="ui-widget-content"> <p>自定義助手（與 cursorAt 結合）</p> </div> <h3 class="docs">堆疊：</h3> <div id="set"> <div class="ui-widget-content"> <p>我們是 draggables..</p> </div> <div class="ui-widget-content"> <p>..它的 z-index 是自動控制的..</p> </div> <div class="ui-widget-content"> <p>..帶有 stack 選項。</p> </div> </div> </body> </html> ``` ## jQuery UI Draggable + Sortable Draggable 與 Sortable 的無縫交互。 ``` <!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>jQuery UI 拖動（Draggable） + 排序（Sortable）</title> <link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css"> <script src="//code.jquery.com/jquery-1.9.1.js"></script> <script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script> <link rel="stylesheet" href="http://jqueryui.com/resources/demos/style.css"> <style> ul { list-style-type: none; margin: 0; padding: 0; margin-bottom: 10px; } li { margin: 5px; padding: 5px; width: 150px; } </style> <script> $(function() { $( "#sortable" ).sortable({ revert: true }); $( "#draggable" ).draggable({ connectToSortable: "#sortable", helper: "clone", revert: "invalid" }); $( "ul, li" ).disableSelection(); }); </script> </head> <body> <ul> <li id="draggable" class="ui-state-highlight">請拖拽我</li> </ul> <ul id="sortable"> <li class="ui-state-default">Item 1</li> <li class="ui-state-default">Item 2</li> <li class="ui-state-default">Item 3</li> <li class="ui-state-default">Item 4</li> <li class="ui-state-default">Item 5</li> </ul> </body> </html> ```