jquery插件制作 -- 1.我們的第一個插件:txtHover


  該系列文章是我閱讀<jQuery Plugin Development Beginner's Guide>后的總結,有興趣的朋友可以去讀原版的書籍。

  

  定義插件的結構骨架:

  書中最開始使用的結構骨架如下:

jQuery.fn.fluginmane=function(){
  return this.each(function(){
    //code...
  })
}

  這種結構不是很理想,特別書中提到,為了防止沖突例子不使用$,而使用jQuery。在這里,我們使用匿名函數的方式實現插件的結構骨架,這樣就可以防止可能的沖突。也希望大家好好了解下匿名函數相關的知識。

(function($){
  $.fn.fluginname=function(){
    return this.each(function(){
      //code...
    });
  }
})(jQuery);

注意點:

  1.為了統一和規范,我們的插件文件都將以jquery.fluginname.js的形式命名(fluginname代表你插件的名字)。

  2.我們使用到的函數都需要是私有的,不能被外部訪問到,這樣可保證插件不會受到外部的影響和干擾(匿名函數已經保證了這點)。

  3.允許用戶使用options控制插件的行為。

  4.默認的options允許外部訪問,這樣用戶就可以用最少的代碼實現自定義化。

  5.this.each()會遍歷所有符合要求的對象,他本身是個jquery對象,插件最后返回該對象。其實通過這種方式就實現了javascript的鏈式模式。

 

我們的第一個插件:txtHover

 

  1.代碼實現:

(function($){
  $.fn.txtHover=function(){
    return this.each(function(){
      $(this).text('text changed!');
    });
  }
})(jQuery);

  2.如何使用:

  創建一個html文件,添加jquery和插件的引用,代碼如下:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title></title>
    <script type="text/javascript" src="Scripts/jquery-1.4.1.min.js"></script>
    <script type="text/javascript" src="Scripts/jquery.txtHover.js"></script>
    <script type="text/javascript">
        $(document).ready(function () {
            $('#test').txtHover();
        });
    </script>
</head>
<body>
    <div id="test">
        this is test.</div>
</body>
</html>

 

添加hover事件:

(function ($) {
    $.fn.txtHover = function () {
        return this.each(function () {
            var temp = $(this).text();
            $(this).hover(function () {
                $(this).text('text changed!');
            }, function () {
                $(this).text(temp);
            });
        });
    }
})(jQuery);

  第一個版本,當頁面加載完畢之后,div的內容就被修改了,這樣的設計沒多大用處。我們最常用到的是,當鼠標移到到文字上面的時候產生一些變化。改進的插件添加了hover事件。首先我們把div的原始值保存在變量temp里面,當鼠標移動到div上面的時候,文字被替換,鼠標移出時,將文字替換回來。

 

添加自定義選項

   為了方便用戶更加靈活的使用,我們需要添加自定義的功能,插件代碼修改:

(function ($) {
    $.fn.txtHover = function (options) {
        var defaults = { txt: 'text changed!' };
        var opt = $.extend(defaults, options);

        return this.each(function () {
            var self = $(this);
            var temp = self.text();
            self.hover(function () {
                self.text(opt.txt);
            }, function () {
                self.text(temp);
            });
        });
    }
})(jQuery);

  插件定義了一個變量defaults,設置了默認的文字信息。我們使用$.extend()(不了解這個函數的朋友可以去查閱資料)方法擴展了一個新變量opt,如果用戶傳入的options變量包含txt,則opt就使用用戶傳入的,否則就使用系統默認的。我們在系統中定義了 var self = $(this),來代替this對象。this在javascript中是個很惱人的對象,在不同函數上下文中所代表的對象會不同,將this傳給一個另外的變量會避免程序出現一些錯誤。不熟悉的朋友很有必要好好掌握該知識點。

  用戶在html頁面上調用插件的時候,可以自定義鼠標移到div上面時候的文字內容了。

$(document).ready(function () {
  $('#test').txtHover({ txt: 'test' });
});

  好了,今天的例子到此為止。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM