JQuery UI提供的API極大簡化了拖拽功能的開發。只需要分別在拖拽源(source)和目標(target)上調用draggable和droppable兩個函數即可。
拖拽原理
首先要明確幾個概念。
ource:拖拽源,要拖動的元素。
taerget:拖放目標,能夠放入source的容器。
拖拽的動作分解如下:
1. drag start:在拖拽源(source)上按下鼠標並開始移動
2. drag move: 移動過程中
3. drag enter: 移動進入目標(target)容器
4. drag leave: 移出目標(target)容器
5. drop: 在目標(target)容器上釋放鼠標
6. drag end: 結束
在html5之前,頁面元素不直接支持拖拽事件。所以都是通過監聽鼠標事件並記錄拖拽狀態的方式來實現拖拽功能。
最簡單的例子
最簡單的拖拽是不改變元素所在的容器,而只改變其位置。例子如下:
. 代碼如下:
<html>
<head></head>
<body>
<div id="container">
<div id="dragsource">
<p>拽我!</p>
</div>
</div><!-- End container -->
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$( "#dragsource" ).draggable();
})
</script>
</body>
</html>
拖動到另一個容器
更常見的場景是將元素拖動到另一個容器中。這就需要在drop目標(target)容器上應用droppable函數。讓我們在上一個例子的基礎上,增加一個div作為容器,並應用droppable函數:
. 代碼如下:
<html>
<head></head>
<body>
<div id="container">
<div id="dragsource">
<p>拽我!</p>
</div>
</div><!-- End container -->
<div id="droppalbe" style="width: 300px;height:300px;background-color:gray">
<p>Drop here</p>
</div>
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$( "#dragsource" ).draggable();
$( "#droppable" ).droppable();
})
</script>
</body>
</html>
事件監聽和回顯(Feedback)
運行上一個例子,你可能會產生疑惑,真的放到目標容器上了嗎?用戶也會產生同樣的疑惑。所以,可以監聽拖動過程中發生的一些事件,並用可見的方式讓用戶知道。這就叫做回顯(Feedback)。
對於源(source),可以監聽的事件包括:
create: 在source上應用draggable函數時觸發
start:開始拖動時觸發
drap:拖動過程中觸發
stop:釋放時觸發
對於目標(target),可以監聽的事件包括:
create: 在target上應用droppable函數時觸發
activate:如果當前拖動的source可以drop到本target,則觸發
deactivate:如果可以drop到本target的拖拽停止,則觸發
over:source被拖動到target上面
out:source被拖動離開target
drop:source被釋放到target
事件處理函數都是通過draggable和droppable函數的參數傳遞,在這些事件處理函數中就可以進行Feedback。看一下實際的例子:
. 代碼如下:
<html>
<head>
</head>
<body>
<div id="dragsource">
<p id="targetMsg">:-|</p>
</div>
<div id="droppable" style="background-color:gray;height:300">
<p>Can drop! </p>
</div>
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$( "#dragsource" ).draggable({
start: function(event,ui) {
$(this).find("p").html(":-S");
},
stop:function(event,ui){
$(this).find("p").html(":-|");
}
});
$( "#droppable" ).droppable({
activate: function(event,ui) {
$(this).find("p").html( "Drop here !" );
},
over: function(event,ui) {
$( this ).find( "p" ).html( "Oh, Yeah!" );
},
out: function(event,ui) {
$( this ).find( "p" ).html( "Don't leave me!" );
},
drop: function( event, ui ) {
$( this ).find( "p" ).html( "I've got it!" );
}
});
})
</script>
</body>
</html>
復制拖動
前面的例子都是移動元素,另一種常見的場景是復制拖動。比如visio中的從畫板中拖動元素到畫布。這是通過draggable函數的helper參數設定的。
helper可以指定為“original”, "clone",其中"original"是默認值,即拖動自身,而clone表示創建自身的一個克隆用於拖拽。helper還可以指定為函數,該函數返回一個自定義的DOM元素用於拖拽。
當不是拖動自身的時候,需要在target上指定drop事件函數,在該函數中將特定的元素添加到target容器上,否則drop的時候什麼事情都不會發生。
簡單復制的例子如下:
. 代碼如下:
<html>
<head></head>
<body>
<div id="dragsource">
<p>拽我!</p>
</div>
<div id="container" style="background-color:gray;height:300">
</div><!-- End container -->
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$( "#dragsource" ).draggable({
helper:"clone"
});
$("#container").droppable({
drop:function(event,ui){
$(this).append($("<p style='position:absolute;left:"+
ui.offset.left+";top:"+ui.offset.top+"'>clone</p>"));
}
});
})
</script>
</body>
</html>
拖動控制
到目前位置,所有的例子中都可以對source隨意拖動。在實際應用中經常需要對拖動行為進行控制。下面給出幾個例子。
拖動方向
默認拖動方向為x,y兩個方向。通過draggable的axis參數可以限制只能水平或豎直拖動。如下:
. 代碼如下:
<html>
<head></head>
<body>
<div id="dragX">
<p>--</p>
</div>
<div id="dragY">
<p>|</p>
</div>
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$("#dragX").draggable({axis:"x"});
$("#dragY").draggable({axis:"y"});
});
</script>
</body>
</html>
拖動范圍
除了方向之外,還可以通過containment參數約束拖動的范圍。該參數接受Selector, Element, String, Array類型。其中String可以為parent,document,window,Array是指定一個矩形區域(regin)的四元數組:[x1,y1,x2,y2]。下面的例子分別指定了parent和regin作為范圍限制:
. 代碼如下:
<html>
<head></head>
<body>
<div id="container" style="background-color:gray;height:300">
<div id="draggable1" style="background-color:red;height:20;width:100">
<p>in parent</p>
</div>
<div id="draggable2" style="background-color:green;height:20;width:100">
<p>in regin</p>
</div>
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$("#draggable1" ).draggable({containment: "parent" });
$("#draggable2").draggable({containment: [20,20,300,200] });
});
</script>
</body>
</html>
拖動吸附
還可以在拖動的時候吸附到其他元素或網格。使用snap參數指定要吸附到的元素,使用grid參數指定吸附到網格,如下:
. 代碼如下:
<html>
<head>
<style>
.draggable {background-color:green; width: 90px; height: 80px; padding: 5px; float: left; margin: 0 10px 10px 0; font-size: .9em; }
</style>
</head>
<body>
<div id="container" style="background-color:gray;height:300">
<div id="draggable1" class="draggable">
<p>吸附到其他可拖拽元素</p>
</div>
<div id="draggable2" class="draggable">
<p>吸附到容器</p>
</div>
<div id="draggable3" class="draggable">
<p>吸附到網格(30x30)</p>
</div>
</div><!--container-->
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$("#draggable1").draggable({ snap: true });
$("#draggable2").draggable({ snap: "#container"});
$("#draggable3").draggable({grid: [30,30]});
});
</script>
</body>
</html>
拖動把手(handle)
默認是整個元素都可以拖動,也可以指定元素的某個子元素作為拖動的handle,如:
. 代碼如下:
<div id="draggable">
<p>handle</p>
</div>
……
<script>
$("#draggable").draggable({handle:"p"});
</script>
Drop限制
默認的droppable指定元素能夠接受所有的drop, 但是可以通過accept參數限定只能接受某些元素的drop。accept參數的類型為一個符合jquery selector的字符串。例如:
$(".selector").droppable({ accept: '.special' })
表示只接受具有special 樣式的元素。
增強用戶體驗
前面是實現拖拽的功能,JQueryUI還有一些參數可以增強用戶體驗。比如,cursor參數可以指定鼠標指針的形狀,cursorAt指定鼠標指針在source的相對位置,revert可以指定當drop失敗時source“飄”回原來的位置。一個組合的例子如下:
. 代碼如下:
<html>
<head>
<style>
.draggable {background-color:green; width: 90px; height: 80px; padding: 5px; float: left; margin: 0 10px 10px 0; font-size: .9em; }
.droppable { width: 300px; height: 300px; background-color:red}
</style>
</head>
<body>
<div id="draggable2" class="draggable">
<p>I revert when I'm not dropped</p>
</div>
<div id="droppable" class="droppable">
<p>Drop me here</p>
</div>
<script type="text/javascript" src="js/jquery-1.7.min.js"></script>
<script type="text/javascript" src="js/jquery-ui-1.8.16.custom.min.js"></script>
<script>
$(function() {
$( "#draggable2" ).draggable({ revert: "invalid",cursor: "move", cursorAt: { top: 56, left: 56 } });
$( "#droppable" ).droppable({
activeClass: "ui-state-hover",
hoverClass: "ui-state-active",
drop: function( event, ui ) {
$( this )
.addClass( "ui-state-highlight" )
.find( "p" )
.html( "Dropped!" );
}
});
});
</script>
</body>
</html>
小結
JQuery UI提供了強大的拖拽功能和良好的用戶體驗,同時又非常容易使用。本文介紹了常用的各種用法。更多的參數還可以參考官方網站的Draggable 和 Droppable 。