DIV CSS 佈局教程網

手寫輕量級彈出層插件 jquery.cvbox:從設計思路到完整實作
編輯:JQuery特效代碼     

jquery.boxy 這類彈出層插件功能確實強大,提示、確認、拖曳、縮放、異步載入應有盡有,代價則是體積龐大,而且其中大半功能在一般專案裡根本用不到。於是有了另一條路:抱著邊學邊做的態度,自己寫一個只保留常用能力、壓縮後控制在 6K 以內的輕量級彈出層。這也是第一次嘗試把常見操作沉澱成 jQuery 插件,命名為 jquey.cvbox.min.js(cv 取自 ChinaValue 的縮寫)。

動手前的六個步驟規劃

寫插件之前先把思路理清楚,後面寫程式就會順很多:

  1. 準備容器。頁面上需要一個用來承載內容的容器,以及一層遮罩背景。先讓它們存在就好,至於長什麼樣、出現在哪裡,後面再透過樣式調教。
  2. 預先定義常用物件。把遮罩層、彈出層容器、標題欄、內容區,以及視窗寬高、滾動高度等資訊先取出來放好,後續操作會省下大量重複查詢。
  3. 決定內容型態。內容可以是單純的一句提示(提示模式)、帶確認按鈕的詢問(確認模式)、一張圖片(小圖放大),或是一段 HTML(避免在 JS 裡硬寫標籤)。
  4. 定義關閉行為。點擊關閉鈕時要做的其實是隱藏並移除遮罩與彈出層,這個方法留給外部流程在完成後呼叫。
  5. 處理定位與滾動。設定遮罩透明度與覆蓋高度,決定彈出層是隨滾動置中還是固定在螢幕中央。
  6. 抽出可變參數並給預設值。用 $.extend 合併 defaults 與使用者傳入的 options,這是 jQuery 插件的標準做法。

核心程式碼

整個插件包在一個立即函式裡,掛到 $.fn 上,並先宣告一組預設參數:

(function($) {
$.fn.cvbox = function(options) {
    var self = $(this);
    var defaults = {
        titleBarText: "",        // 標題欄文字
        titleBarClose: "關閉",   // 關閉按鈕文字
        bgClickClose: false,     // 點遮罩是否關閉
        bgShow: true,            // 是否顯示遮罩
        bgOpacity: 0.2,          // 遮罩透明度
        confirmText: "",         // 有值時走確認框模式
        alertText: "",           // 有值時走提示框模式
        delayClose: 0,           // 幾毫秒後自動關閉,0 代表不自動關
        submitAfter: function() { $.noop(); }  // 按下確認後的回呼
    };
    var param = $.extend({}, defaults, options || {});

接著組出彈出層的 DOM 字串,包含遮罩、外框、標題欄(標題 + 關閉鈕 + 清除浮動)與內容區:

    var cvBoxElement = '<div id="cvBoxShade" class="cvBoxShade"></div>';
    cvBoxElement += '<div id="cvBoxBorder" class="cvBoxBorder">';
    cvBoxElement += '<div id="cvBoxTitleBar" class="cvBoxTitleBar">'
        + '<div class="cvBoxTitleBarText">' + param.titleBarText + '</div>'
        + '<div class="cvBoxTitleBarClose"><a href="javascript:void(0);" id="cvBoxTitleBarClose">'
        + param.titleBarClose + '</a></div><div class="cvBoxClear"></div></div>';
    cvBoxElement += '<div id="cvBoxBody" class="cvBoxBody"></div>';
    cvBoxElement += '</div>';

重複呼叫時不必重建節點,只要讓既有節點重新顯示即可;第一次才 append 到 body:

    if ($("#cvBoxBorder").size()) {
        $("#cvBoxBorder").show();
        param.bgShow ? $("#cvBoxShade").show() : $("#cvBoxShade").hide();
    } else {
        $("body").append(cvBoxElement);
    }

    var cbBg = $("#cvBoxShade");
    var cbBorder = $("#cvBoxBorder");
    var cbTitleBar = $("#cvBoxTitleBar");
    var cbBody = $("#cvBoxBody");
    var w, h, st, ph;

內容產生器會依參數自動分流到三種模式:

    var cb = {
        content: function() {
            var text;
            if (param.confirmText != "") {
                text = $('<div class="cvBoxBodyBtn">' + param.confirmText
                    + '<p><input type="button" id="cvBoxBtnSubmit" class="cvBoxBtnSubmit" value="確認" /> '
                    + '<input type="button" id="cvBoxBtnCancel" class="cvBoxBtnCancel" value="取消" /></p></div>');
            } else if (param.alertText != "") {
                text = $('<div class="cvBoxBodyBtn">' + param.alertText
                    + '<p><input type="button" id="cvBoxBtnSubmit" class="cvBoxBtnSubmit" value="確認" /></p></div>');
            } else {
                self.show();
                text = self;   // 直接搬使用者指定的元素進來
            }
            return text;
        },

要置中,就得先知道內容實際多大。這裡用一個技巧:把內容複製到一個離螢幕很遠的絕對定位容器裡量一次,量完立刻移除:

        hw: function(obj) {   // 取得任意元素的高與寬
            var hwSize = {};
            $('<div id="cbBox" style="position:absolute;left:-999px;"></div>')
                .appendTo("body").append(obj.clone());
            hwSize.w = $("#cbBox").width();
            hwSize.h = $("#cbBox").height();
            $("#cbBox").remove();
            return hwSize;
        },

        position: function() {  // 遮罩尺寸、透明度與彈出層位置
            w = $(window).width(); h = $(window).height();
            st = $(window).scrollTop(); ph = $(document).height();
            cbBg.width(w).height(ph).css("opacity", param.bgOpacity);

            var x_size = cb.hw(cb.content());
            var t = st + (h - x_size.h) / 2, l = (w - x_size.w) / 2;
            cbBorder.css({ width: x_size.w, top: t, left: l, zIndex: 9999 });
        },

        posfix: function() {    // 先進瀏覽器用 fixed,其餘靠 scroll 事件補算
            if (window.XMLHttpRequest) {
                cbBorder.css("position", "fixed");
            } else {
                $(window).scroll(function() { cb.position(); });
            }
        },

        center: function() {
            $(window).resize(function() { cb.position(); });
        },

        hide: function() {
            if (param.confirmText == "" && param.alertText == "") {
                cb.content().hide().appendTo($("body"));  // 歸還原元素,避免重複關閉後遺失
            }
            cbBorder.remove();
            cbBg.remove();
            return false;
        },

最後是顯示流程與事件綁定,把前面幾個方法依序串起來:

        show: function() {
            if (cbBody.html() == "") { cbBody.append(cb.content()); }
            cb.position();
            cb.center();
            if (param.titleBarText == "") { cb.barhide(); }
            if (!param.bgShow) { cb.bghide(); }
            if (param.bgClickClose) { cb.bgclick(); }
            if (param.delayClose > 0) { setTimeout(cb.hide, param.delayClose); }
        }
    };

    cb.show();

    $("#cvBoxBtnSubmit").bind("click", function() {
        if (param.confirmText != "") { param.submitAfter(); }
        cb.hide();
    });
    $("#cvBoxBtnCancel").bind("click", function() { cb.hide(); });
    $("#cvBoxTitleBarClose").bind("click", function() { cb.hide(); });
}
})(jQuery);

四種典型用法

1. 單純的提示框

$("#A1").click(function() {
    $(this).cvbox({
        titleBarText: "彈出提示框",
        alertText: "這裡放你要顯示的提示內容<br />换行用 br 標籤即可"
    });
});

2. 提示後自動關閉——加上 delayClose(毫秒):

$("#A2").click(function() {
    $(this).cvbox({
        titleBarText: "彈出提示框 1 秒後自動關閉",
        alertText: "內容同上",
        delayClose: 1000
    });
});

3. 確認框並接後續動作——用 confirmText 加上 submitAfter 回呼:

$("#A3").click(function() {
    $(this).cvbox({
        titleBarText: "彈出對話框",
        confirmText: "你確定要執行這個動作嗎?",
        submitAfter: doSomething
    });
});

function doSomething() { alert("已確認,繼續後續流程。"); }

4. 載入一段既有 HTML——把要顯示的區塊塞給它就好,內容甚至可以是 iframe:

<div class="A4Demo" style="display:none; width:550px; padding:10px;">
    這段內容平時用 display:none 藏起來,
    只是為了說明它是頁面裡既有的節點,而不是用 document.write 動態產生。
</div>

<script type="text/javascript">
$("#A4").click(function() {
    $(".A4Demo").cvbox({ titleBarText: "載入一段 HTML 內容" });
});
</script>

體積與後續規劃

未壓縮版本約 6K,壓縮後只剩 2K 出頭,在各式彈出層裡算是相當克制。目前版本只支援螢幕置中,下一步的規劃是把位置也抽成參數,讓彈出層能自由指定座標,而不必永遠卡在正中央。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved