Boxy是一個功能完整的jQuery彈出層(對話框)外掛,支援拖動、縮放、模態遮罩、Ajax加載、動畫補間等豐富特性,還能透過CSS自由定制外觀。下面從使用方式到API逐一說明。
要使用Boxy,把$(selector).boxy();放進document.ready裡即可。用具體的選擇器表達式替換這裡的"selector",例如"a[rel=boxy],form.with-confirmation"。這會給匹配到的元素附加相應行為:
手動模式用起來很簡單——只需創建一個Boxy新實例,傳入內部內容和任何附加的雜湊物件。預設情況下,對話框會立即顯示在視區中央、且可拖動。這些設定都能透過給構造函數傳入附加物件來覆蓋。
傳給構造函數的內容可以是任何對$()有效的參數——DOM元素、HTML片段或其他jQuery物件。無論傳入什麼,其display屬性都會被設為block,並插入名為boxy-content的class到對話框中。
一些代表性示例:
new Boxy("<p>內容……</p>", {title: "對話框"});new Boxy("<p>內容……</p>", {title: "對話框", draggable: false});new Boxy("<p>內容……</p>", {title: "對話框", closeable:false});new Boxy("<p>內容……</p>", {title: "對話框", fixed:false});new Boxy("<p>內容……</p>", {title: "對話框", modal:true});new Boxy("<p>內容……</p>", {behaviours: function(r) { $(r).hover(...); }});修改現有的對話框(先打開一個對話框,再觸發下面的操作):
someDialog.tween(400, 400);someDialog.tween(100, 100);someDialog.getTitle();someDialog.setTitle("新標題");請注意,標題欄(含關閉按鈕與拖動器)只有在指定了標題時才會出現。一旦創建了實例,你就能把它賦值給一個變數,隨後移動、縮放、顯示或隱藏它。
這幾個輔助方法能提示使用者從若干選項中做選擇,並完成可選的回調:
示例代碼:
<script type='text/javascript'>
$(function() {
$("#ask").click(function() {
Boxy.ask("你感覺怎麼樣?", ["好極了", "還好", "不太好"], function(val) {
alert("你選擇的是: " + val);
}, {title: "這是一個問題……"});
return false;
});
$("#alert").click(function() {
Boxy.alert("文件未找到", null, {title: "提示信息"});
return false;
});
$("#confirm").click(function() {
Boxy.confirm("請確認:", function() {
alert("已經確認!");
}, {title: "提示信息"});
return false;
});
});
</script>
Boxy.load(url, options):以一個URL加載內容並以Boxy對話框呈現。支援的選項有:type(HTTP方法,預設GET)、cache(true則連續通話時緩存內容,預設false)、filter(用於過濾遠程內容的jQuery表達式)。任何其他選項都會被傳給Boxy構造函數。
Boxy.get(element):返回包含該元素的實例,例如:<a href="#" onclick="Boxy.get(this).hide();">關閉對話框</a>
Boxy.ask(question, answers, callback, options):顯示模式化、不可關閉的對話框,讓使用者從選項中選擇。question是要顯示的問題,answers是可能的回答陣列,callback會收到選中的回答(依answers是陣列還是鍵值對,回調收到的是值或對應的鍵)。
Boxy.alert(message, callback, options):顯示模式化、不可關閉的提示消息。注意:它並不是用來取代瀏覽器原生window.alert()的,因為它無法在對話框可見時阻止程式執行。
Boxy.confirm(message, callback, options):顯示含確定與取消按鈕的模式化對話框,回調僅在使用者選「確定」時被調用。注意:它並不是用來取代原生window.confirm()的,同樣無法阻塞程式執行。
Boxy.linkedTo(ele):返回已透過actuator構造選項關聯到該DOM元素的boxy實例。
Boxy.isModalVisible():若當前有模式對話框可見則返回true,否則false。
new Boxy(element, options):構造函數,創建一個新的boxy對話框。element是對話框內容(任何對$()有效的參數),options是配置選項的雜湊。
estimateSize():在對話框不可見時估算其大小;若當前可見,請改用getSize()。
getSize():以陣列[width, height]返回對話框大小。
getContentSize():返回對話框內容區域的大小(預設不含標題欄)。
getPosition():以[x, y]陣列返回最頂層對話框的左上角坐標。
getCenter():以[x, y]陣列返回最頂層對話框的中心點坐標。
getInner():返回包裝對話框內部區域(含標題欄)的jQuery物件。
getContent():返回包裝內容區域(不含標題欄)的jQuery物件。
setContent(newContent):設置對話框內容,任何對$()有效的參數都可用,可鏈接。
moveTo(x, y):把對話框移到左上角為(x, y)的位置,可鏈接。
centerAt(x, y):把對話框中心移到坐標(x, y)處。
center(axis):把對話框移到視區中央,可選參數axis為"x"或"y",可鏈接。
resize(w, h, after):把對話框高寬重設為[w, h],完成後執行回調after(回調會收到Boxy實例),可鏈接。
tween(w, h, after):以動畫補間把高寬過渡到[w, h],完成後執行回調,可鏈接。
isVisible():對話框可見則返回true,否則false。
show():顯示對話框,可鏈接。
hide(after):隱藏對話框,after為可選回調,可鏈接。
toggle():切換對話框的顯隱狀態,可鏈接。
hideAndUnload(after):隱藏後立即卸載,卸載前先執行after回調,可鏈接。
unload():從DOM中刪除對話框並切斷其與執行機構的關聯。一旦卸載,對它的任何後續操作都是未定義的。
toTop():把當前對話框移到其他所有對話框之上,可鏈接。
getTitle():以HTML形式返回對話框標題。
setTitle(t):把標題設為t,可鏈接。
title:顯示在自動生成標題欄上的標題(預設null)。
closeable:是否在標題欄添加關閉驅動器,未指定標題時無效(預設true)。
closeText:標題欄關閉鏈接的文字(預設"[關閉]")。
draggable:對話框能否透過標題欄拖動,未指定標題時無效(預設true)。
clone:內部區域的元素與事件處理器是否在被替換前先複製(預設false)。
actuator:引發此對話框的DOM元素,兩者會建立關聯,稍後可用Boxy.linkedTo(element)檢索;對話框卸載時關聯會自動切斷(預設null)。
center:是否在螢幕中心顯示(預設true)。
fixed:是否用固定定位而非絕對定位,固定定位不受滾動條影響;IE6不支援固定定位,永遠表現為絕對定位(預設true)。
show:是否立即顯示,false則需手動調用dialog.show()(預設true)。
modal:是否設為模態,模態時背景變暗、阻止其他元素接收事件(預設false)。
x:對話框的x(left)坐標(預設50)。 y:對話框的y(top)坐標(預設50)。
unloadOnHide:true則對話框隱藏後會被卸載(從DOM刪除)(預設false)。
clickToFront:true則單擊對話框任意位置會讓它跑到頂部(預設false)。
behaviours:用來為對話框內容施加自定義行為的函數,每次調用setContent()時都會執行,並收到一個含內容區域的jQuery物件(預設function(r){})。
afterDrop:對話框放下時在Boxy上下文執行的回調(預設function(){})。
afterShow:對話框顯示時執行的回調,可用來讓表單文本框自動獲焦(預設function(){})。
afterHide:對話框隱藏時執行的回調(預設function(){})。
beforeUnload:對話框卸載前在Boxy上下文執行的回調(預設function(){})。
你可以透過CSS完全定制對話框外觀,以下是可能用到的選擇器:
.boxy-wrapper .title-bar:自動生成的標題欄div。
.boxy-wrapper .title-bar h2:標題欄的內容。
.boxy-wrapper .title-bar.dragging:拖拽時的標題欄。
.boxy-wrapper .title-bar .close:預設的關閉驅動器。
.boxy-inner:內部區域,含標題欄。
.boxy-content:內部區域,不含標題欄;這個class會自動添加到傳給Boxy構造函數的任何元素上。
.boxy-wrapper .question:由Boxy.ask()創建,含問題文字。
.boxy-wrapper .answers:由Boxy.ask()創建,含應答按鈕。
.close:任何帶此class的內容,其單擊事件都會關聯到關閉對話框上。
在線演示:https://demo.jb51.net/js/2011/jquery-plugin-boxy/page/jQuery-plugin-boxy.html
打包下載:https://xiazai.jb51.net/201102/yuanma/jquery-plugin-boxy.rar