jQuery的插件开发

2012-03-13 10:21 臭小子1983 阅读(216) 评论(0) 编辑收藏举报

一、插件的种类

　　插件分为3类：

　　1、封装对象方法的插件：

　　　　95%以上的插件都是通过这种方法来

　　2、封装全局函数的插件：

　　　　可以将独立的函数加到jquery命名空间下，如：$.trim()

　　3、选择器插件：

二、插件的基本要点

　　1、插件文件名的写法：jquery.插件名.js，以免与其它插件冲突

　　2、所有对象方法都应该加到jquery.fn对象上，所有全局函数都应该加到jquery本身

　　3、插件内部this指向当前的选择器获取到的jquery对象

　　4、可以通过$.each()来遍历所有元素

　　5、所有的方法可属性都要以“;”分号作为结尾，甚至可以在头部加上一个，避免压缩时候出现问题

　　6、插件应该返回一个jquery对象，以保证插件可以链式操作

　　7、在插件内部使用$作为jquery对象的别名

三、插件中的闭包

　　利用闭包的特性可以避免影响内部全局空间

1 <script>
2     (function($){
3         // 这里写代码
4     })(jQuery)
5 </script>

四、插件的机制

　　jquery提供两种扩展功能，jquery.fn.extend()和jquery.extend()方法

　　extend()除了扩展jquery之外还可以扩展

也用于设置插件的默认参数

1 <script>
2     function foo(opt){
3         var options = $.extend({
4             name: "bar",
5             length: 5,
6             dataType: "xml"
7         }, opt);
8     }
9 </script>

五、编写插件

　　1、采用扩展第一类的编写方法：jquery.fn.extend()

 1 <div class="box">click me!</div>
 2 
 3 <script src="../../../js/jquery-1.7.2.min.js"></script>
 4 <script>
 5     ;(function($){
 6         $.fn.extend({
 7             getColor: function(value){
 8                 console.log(value);
 9             }
10         })
11     })(jQuery);
12 
13     $(".box").getColor("getColor方法已经是jquery的插件了");
14 </script>

　　2、封装全局函数

　　　　全局函数就直接扩展到jquery下

 1 <script>
 2     ;(function($){
 3         $.extend({
 4             clearLeftTrim: function(str){　　　　　　// 清除字符串前置空格
 5                 return str.replace(/^\s+/g, "");
 6             }
 7         })
 8     })(jQuery);
 9 
10     // 调用
11     var sVal = "后面是否有空格" + $.clearLeftTrim("   ddfsdfsdfsdf");
12     console.log(sVal);
13 </script>

------------------------------------------------------------------------------------------------

一、分为两个插件机制

1、$.extend(object)：扩展于jQuery本身，用来在jquery上增加新函数.

 1 jquery: 
 3 $.extend({
 4     min: function(a, b){ return a < b ? a:b },
 5     max: function(a, b){ return a > b ? a:b }    
 6 })
 7 
 8 
 9 html:
10 $("#testbuttn").click(function(){
11     $('#div').html($.min(2,3) + "，" + $.max(4,5))    
12 })

2、$.fn.extend(object)：制作新插件.

 1 jquery.center.js
 2 
 3 创建方法一：
 4 
 5 $.fn.center = function () {
 6     alert('a');
 7     $(this).css("left", ( $(window).width() - $(this).width() ) / 2+$(window).scrollLeft() + "px");
 8     $(this).css("top", ( $(window).height() - $(this).height() ) / 2+$(window).scrollTop() + "px");
 9     return $(this);
10 }
11 
12 
13 创建方法二：
14 $.fn.extend({
15     center: function(){
16         $(this).css("left", ( $(window).width() - $(this).width() ) / 2+$(window).scrollLeft() + "px");
17         $(this).css("top", ( $(window).height() - $(this).height() ) / 2+$(window).scrollTop() + "px");
18         return $(this);    
19     }        
20 })
21 
22 
23 
24 html:
25 $(function(){     
26     $("#testbutton").center();
27 });

一、jquery.form插件

1、ajaxForm

增加所有需要的事件监听器，为AJAX提交表单做好准备。ajaxForm不能提交表单。在document的ready函数中，使用ajaxForm来为AJAX提交表单进行准备。ajaxForm接受0个或1个参数。这个单个的参数既可以是一个回调函数，也可以是一个Options对象。
可链接（Chainable）：可以。

实例：

$('#myFormId').ajaxForm();

2、ajaxSubmit

马上由AJAX来提交表单。大多数情况下，都是调用ajaxSubmit来对用户提交表单进行响应。ajaxSubmit接受0个或1个参数。这个单个的参数既可以是一个回调函数，也可以是一个Options对象。
可链接（Chainable）：可以。

实例：
// 绑定表单提交事件处理器
$('#myFormId').submit(function() {
    // 提交表单
    $(this).ajaxSubmit();
    // 为了防止普通浏览器进行表单提交和产生页面导航（防止页面刷新？）返回false
    return false;
});

3、formSerialize

将表单串行化（或序列化）成一个查询字符串。这个方法将返回以下格式的字符串：name1=value1&name2=value2。
可链接（Chainable）：不能，这个方法返回一个字符串。

实例：
var queryString = $('#myFormId').formSerialize();

// 现在可以使用$.get、$.post、$.ajax等来提交数据
$.post('myscript.php', queryString);

4、fieldSerialize

将表单的字段元素串行化（或序列化）成一个查询字符串。当只有部分表单字段需要进行串行化（或序列化）时，这个就方便了。这个方法将返回以下格式的字符串：name1=value1&name2=value2。
可链接（Chainable）：不能，这个方法返回一个字符串。

实例：
var queryString = $('#myFormId .specialFields').fieldSerialize();

5、fieldValue

返回匹配插入数组中的表单元素值。从0.91版起，该方法将总是以数组的形式返回数据。如果元素值被判定可能无效，则数组为空，否则它将包含一个或多于一个的元素值。
可链接（Chainable）：不能，该方法返回数组。

实例：
// 取得密码输入值
var value = $('#myFormId :password').fieldValue();
alert('The password is: ' + value[0]);

6、resetForm

通过调用表单元素原有的DOM方法，将表单恢复到初始状态。
可链接（Chainable）：可以。

实例：
$('#myFormId').resetForm();

7、clearForm

清除表单元素。该方法将所有的文本（text）输入字段、密码（password）输入字段和文本区域（textarea）字段置空，清除任何select元素中的选定，以及将所有的单选（radio）按钮和多选（checkbox）按钮重置为非选定状态。
可链接（Chainable）：可以。

$('#myFormId').clearForm();

8、clearFields

清除字段元素。只有部分表单元素需要清除时才方便使用。
可链接（Chainable）：可以。

$('#myFormId .specialFields').clearFields();

9、Options对象

ajaxForm和ajaxSubmit都支持众多的选项参数，这些选项参数可以使用一个Options对象来提供。Options只是一个JavaScript对象，它包含了如下一些属性与值的集合：

1）target

指明页面中由服务器响应进行更新的元素。元素的值可能被指定为一个jQuery选择器字符串，一个jQuery对象，或者一个DOM元素。
默认值：null。

2）url

指定提交表单数据的URL。
默认值：表单的action属性值

3）type

指定提交表单数据的方法（method）：“GET”或“POST”。
默认值：表单的method属性值（如果没有找到默认为“GET”）。

4）beforeSubmit

表单提交前被调用的回调函数。“beforeSubmit”回调函数作为一个钩子（hook），被提供来运行预提交逻辑或者校验表单数据。如果“beforeSubmit”回调函数返回false，那么表单将不被提交。“beforeSubmit”回调函数带三个调用参数：数组形式的表单数据，jQuery表单对象，以及传入ajaxForm/ajaxSubmit中的Options对象。表单数组接受以下方式的数据：

[ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]

默认值：null

5）success

表单成功提交后调用的回调函数。如果提供“success”回调函数，当从服务器返回响应后它被调用。然后由dataType选项值决定传回responseText还是responseXML的值。
默认值：null

6）dataType

期望返回的数据类型。null、“xml”、“script”或者“json”其中之一。dataType提供一种方法，它规定了怎样处理服务器的响应。这个被直接地反映到jQuery.httpData方法中去。下面的值被支持：

'xml'：如果dataType == 'xml'，将把服务器响应作为XML来对待。同时，如果“success”回调方法被指定，将传回responseXML值。

'json'：如果dataType == 'json'，服务器响应将被求值，并传递到“success”回调方法，如果它被指定的话。

'script'：如果dataType == 'script'，服务器响应将求值成纯文本。

默认值：null（服务器返回responseText值）

7）semantic

Boolean flag indicating whether data must be submitted in strict semantic order (slower). Note that the normal form serialization is done in semantic order with the exception of input elements of type="image". You should only set the semantic option to true if your server has strict semantic requirements and your form contains an input element of type="image".
布尔标志，表示数据是否必须严格按照语义顺序（slower？）来进行提交。注意：一般来说，表单已经按照语义顺序来进行了串行化（或序列化），除了type="image"的input元素。如果你的服务器有严格的语义要求，以及表单中包含有一个type="image"的input元素，就应该将semantic设置为true。（译注：这一段由于无法理解，翻译出来可能语不达意，但请达人指正。）
默认值：false

8）resetForm

布尔标志，表示如果表单提交成功是否进行重置。
Default value: null

9）clearForm

布尔标志，表示如果表单提交成功是否清除表单数据。
默认值：null

实例：

// 准备好Options对象
var options = {
    target:     '#divToUpdate',
    url:        'comment.php',
    success: function() {
      alert('Thanks for your comment!');
    } };

   // 将options传给ajaxForm
$('#myForm').ajaxForm(options);

注意：Options对象还可以用来将值传递给jQuery的$.ajax方法。如果你熟悉$.ajax所支持的options，你可以利用它们来将Options对象传递给ajaxForm和ajaxSubmit。

二、jquery.cookie cookie操作插件

jquery.cookie中的操作：

jquery.cookie.js是一个基于jquery的插件，点击下载！

1、创建一个会话cookie：

$.cookie(‘cookieName’,'cookieValue’);

注：当没有指明cookie时间时，所创建的cookie有效期默认到用户浏览器关闭止，故被称为会话cookie。

2、创建一个持久cookie：

$.cookie(‘cookieName’,'cookieValue’，｛expires：7｝);

注：当指明时间时，故称为持久cookie，并且有效时间为天。

3、创建一个持久并带有效路径的cookie：

$.cookie(‘cookieName’,'cookieValue’，｛expires：7，path：’/'｝);

注：如果不设置有效路径，在默认情况下，只能在cookie设置当前页面读取该cookie，cookie的路径用于设置能够读取cookie的顶级目录。

4、创建一个持久并带有效路径和域名的cookie：

$.cookie(‘cookieName’,'cookieValue’，｛expires：7，path：’/'，domain: ‘chuhoo.com’，secure: false，raw:false｝);

注：domain：创建cookie所在网页所拥有的域名；secure：默认是false，如果为true，cookie的传输协议需为https；raw：默认为false，读取和写入时候自动进行编码和解码（使用encodeURIComponent编码，使用decodeURIComponent解码），关闭这个功能，请设置为true。

5、获取cookie：

$.cookie(‘cookieName’); //如果存在则返回cookieValue，否则返回null。

6、删除cookie：

$.cookie(‘cookieName’,null);

注：如果想删除一个带有效路径的cookie，如下：$.cookie(‘cookieName’,null,{path:’/'});

jQuery.cookie = function(name, value, options) {
    if (typeof value != 'undefined') { // name and value given, set cookie
        options = options || {};
        if (value === null) {
            value = '';
            options.expires = -1;
        }
        var expires = '';
        if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
            var date;
            if (typeof options.expires == 'number') {
                date = new Date();
                date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
            } else {
                date = options.expires;
            }
            expires = '; expires=' + date.toUTCString(); // use expires attribute, max-age is not supported by IE
        }
        var path = options.path ? '; path=' + options.path : '';
        var domain = options.domain ? '; domain=' + options.domain : '';
        var secure = options.secure ? '; secure' : '';
        document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
    } else { // only name given, get cookie
        var cookieValue = null;
        if (document.cookie && document.cookie != '') {
            var cookies = document.cookie.split(';');
            for (var i = 0; i < cookies.length; i++) {
                var cookie = jQuery.trim(cookies[i]);
                // Does this cookie string begin with the name we want?
                if (cookie.substring(0, name.length + 1) == (name + '=')) {
                    cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
                    break;
                }
            }
        }
        return cookieValue;
    }
};

刷新页面返回顶部

臭小子1983