DIV CSS 佈局教程網

jQuery 外掛(Plugin)怎麼寫:從結構到參數化的完整教學
編輯:JQuery特效代碼     

同一段效果如果要在好幾個專案裡重複用,每次都複製貼上顯然不是好辦法。把它包成 jQuery 外掛,就能用一行 $('#xxx').myPlugin() 搞定,還能透過參數調整行為。這篇從一個實際的小需求出發,走完整個流程。

一、需求與原始寫法

假設有個分類選單,希望滑鼠移上去時該項目往右挪一點,移開再復位:

<ul id="catagory">
  <li><a href="#">jQuery</a></li>
  <li><a href="#">Asp.net</a></li>
  <li><a href="#">Sql Server</a></li>
  <li><a href="#">CSS</a></li>
</ul>
$(document).ready(function() {
    $("#catagory a").hover(function() {
        $(this).animate({ paddingLeft: "20px" }, { queue: false, duration: 500 });
    }, function() {
        $(this).animate({ paddingLeft: "0" }, { queue: true, duration: 500 });
    });
});

能用,但選擇器寫死了、位移距離寫死了、顏色也沒得改。要複用就得改程式碼,這正是外掛要解決的問題。

二、外掛的基本骨架

// 用匿名函式包住,避免汙染全域、也避免與其他程式碼衝突
(function($) {
    $.fn.extend({
        pluginname: function() {
            // 遍歷符合的每個元素
            return this.each(function() {
                // 在這裡寫處理邏輯
            });
        }
    });
})(jQuery);

三個重點:傳入 jQuery 是為了在閉包裡安全地使用 $,就算別人在外面把 $ 讓給了其他函式庫也不受影響;掛在 $.fn 上 才能成為 jQuery 物件的方法;必須 return this,否則就不能鏈寫。

三、加入可自訂參數

(function($) {
    $.fn.extend({
        pluginname: function(options) {
            var defaults = {
                padding: 20,
                mouseOverColor: '#000000',
                mouseOutColor: '#ffffff'
            };
            var options = $.extend(defaults, options);
            return this.each(function() {
                var o = options;
                alert(o.padding); // 就是這樣取值
            });
        }
    });
})(jQuery);

$.extend(defaults, options) 是參數化的關鍵:使用者傳什麼就覆蓋什麼,沒傳的維持預設值。這讓外掛「开箱可用,需要時再調」。

四、把需求做成真正的外掛

(function ($) {
    $.fn.extend({
        // 外掛名稱:paddingList
        paddingList: function (options) {
            var defaults = {
                animatePadding: 10,
                hoverColor: "Black"
            };
            var options = $.extend(defaults, options);

            return this.each(function () {
                var o = options;
                var obj = $(this);            // 本例是 ul 物件
                var items = $("li a", obj);   // 取出 ul 裡的所有 a

                items.hover(function () {
                    $(this).css("color", o.hoverColor);
                    // queue:false 表示不排入動畫佇列
                    $(this).animate({ paddingLeft: o.animatePadding },
                                    { queue: false, duration: 300 });
                }, function () {
                    $(this).css("color", "");
                    $(this).animate({ paddingLeft: "0" },
                                    { queue: true, duration: 300 });
                });
            });
        }
    });
})(jQuery);

五、呼叫方式

$(document).ready(function() {
    $("#catagory").paddingList({ animatePadding: 30, hoverColor: "Red" });
});

寫外掛時最容易踩的坑

一是忘記 return this,導致不能鏈寫;二是直接依賴全域 $,跟 Prototype 這類函式庫同場時會出問題;三是把外掛狀態存在 DOM 屬性上,元素一多就容易記憶體洩漏,這種情況改用 .data() 會安全得多;四是檔案命名,建議統一走 jquery.[外掛名].js 的規則,方便辨識與管理。

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