DIV CSS 佈局教程網

從零打造你的第一個 jQuery 插件:類級與物件級完整教學
編輯:JQuery特效代碼     

因為工作上有需求,這幾天認真研究了一下 jQuery 插件開發,經過一天的奮戰,終於完成了人生第一個自製插件。對我這種看到 CSS 就頭痛的人來說,八小時裡大概有五小時都在跟樣式搏鬥——我的 CSS 程度,用「文盲」形容還客氣了。廢話少說,進入正題。

一、兩種插件類型

jQuery 插件開發分兩類:類級別與物件級別。

類級別可以理解為「擴充 jQuery 這個類本身」,最典型的就是 $.post(...)、$.ajax(...) 這種直接挂在 $ 上的方法。

物件級別則是「擴充 jQuery 物件(也就是選擇器傳回的那個集合)」,例如 $("#Me").somePlugin(...)。日常所說的「寫一個插件」,九成指的是後者。

二、最簡骨架

類級別寫法


<script type="text/javascript">
jQuery.msg = function () {
alert("123");
};
</script>
<script type="text/javascript">
$(function () {
$.msg();
});
</script>

格式:jQuery.插件名稱 = function(){...};,呼叫:$.插件名稱();

物件級別寫法


(function($) {
$.fn.pluginName = function() {
// 這裡是程式碼區
};
})(jQuery);

格式:$.fn.插件名稱 = function(){...};——比類級別多了一個 fn,別小看這兩個字母。$.fn 就是 jQuery.prototype 的別名,掛在它上面的方法,所有 jQuery 物件都能呼叫。呼叫方式:$("#Me").插件名稱();

為什麼要包一層閉包


(function($){
// 你的程式碼
})(jQuery);

這是把 jQuery 當參數傳進匿名函式的閉包寫法。好處有兩個:一是函式內部的 $ 保證就是 jQuery,即使別人在頁面其他地方用 jQuery.noConflict() 把 $ 還給了其他函式庫(如 Prototype),你的插件也不受影響;二是內部變數天然形成作用域,不會污染全域。

三、實作一個 Tabs 面板插件

HTML 結構


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<title></title>
<script src="jquery-1.6.2.min.js" type="text/javascript"></script>
<script src="jquery.tabs.js" type="text/javascript"></script>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
$(function () {
$("#mytabs").tabs();
});
</script>
</head>
<body>
<div id="mytabs">
<ul>
<li><a href="#tabs1">選項1</a></li>
<li><a href="#tabs2">選項2</a></li>
<li><a href="#tabs3">選項3</a></li>
</ul>
<div id="tabs1">11111</div>
<div id="tabs2">22222</div>
<div id="tabs3">33333</div>
</div>
</body>
</html>

結構刻意維持最常見的形式:一個容器,內含一組 ul 當標籤列,以及若干 div 當面板,標籤的 href="#面板id" 就是兩者的關聯。

插件原始碼


/*
tabs 面板插件,版本 1.0
用法:$("#myDiv").tabs({switchingMode:"click"});
參數 switchingMode:面板切換模式,"mouseover" 則滑過即切換,預設 click。
*/
; (function ($) {
$.fn.tabs = function (options) {
var defualts = { switchingMode: "click" };
var opts = $.extend({}, defualts, options);
var obj = $(this);
var clickIndex = 0;
obj.addClass("tabsDiv");
$("ul li:first", obj).addClass("tabsSeletedLi");
$("ul li", obj).not(":first").addClass("tabsUnSeletedLi");
$("div", obj).not(":first").hide();
$("ul li", obj).bind(opts.switchingMode, function () {
if (clickIndex != $("ul li", obj).index($(this))) {
clickIndex = $("ul li", obj).index($(this));
$(".tabsSeletedLi", obj).removeClass("tabsSeletedLi").addClass("tabsUnSeletedLi");
$(this).removeClass("tabsUnSeletedLi").addClass("tabsSeletedLi");
var divid = $("a", $(this)).attr("href").substr(1);
$("div", obj).hide();
$("#" + divid, obj).show();
};
});
};
})(jQuery);

幾個值得學的細節:

  • $.extend({}, defaults, options) 是插件接受參數的標準做法——複製一份空物件當基底,先鋪預設值,再用使用者傳入的 options 覆蓋,這樣才不會改到 defaults 本身。
  • $("ul li", obj) 這種「選擇器 + 上下文」的寫法,把搜尋範圍鎖在插件容器內,是撰寫插件時的鐵則。少了 obj,同一頁有兩組 tabs 就會互相打架。
  • clickIndex 記住目前索引,點到同一個標籤時直接跳過,避免不必要的重繪。
  • .attr("href").substr(1) 把 #tabs1 削成 tabs1,再去對應面板 id,讓 HTML 結構自帶關聯資訊,不必另外設定。

樣式


body{background-color: black;}
.tabsDiv{width: 500px;height: 350px;margin-top: 0px;margin-left: 0px;}
.tabsDiv ul{width: 500px;height: 20px;list-style: none;background-color: black;margin-bottom: 0px;margin: 0px;padding: 0px;}
.tabsDiv div{width: 500px;height: 330px;background-color: white;}
.tabsSeletedLi{width: 100px;height: 20px;background-color: white;float: left;text-align: center;}
.tabsSeletedLi a{width: 100px;height: 20px;color: black;}
.tabsUnSeletedLi{width: 100px;height: 20px;background-color: black;float: left;text-align: center;}
.tabsUnSeletedLi a{width: 100px;height: 20px;color: white;}

樣式刻意寫成最樸素的黑白配色,方便依專案需要替換。

四、寫插件時我學到的幾件事

記得回傳 this。上面的範例少了這一步,嚴格來說不算完整的插件。加上 return this; 才能保住鏈式呼叫,讓 $("#a").tabs().css(...) 這種寫法成立。這是 jQuery 插件約定俗成的禮貌。

用 each 逐一處理集合成員。目前程式用 $(this) 直接操作,若選擇器命中多個元素就會出錯。標準寫法是 return this.each(function(){ ... }),在每個元素上分別初始化。

避免用 $ 開頭命名全域變數,並善用 data() 保存狀態。把 clickIndex 之類的狀態用 $(element).data('tabsIndex', n) 存起來,多實例之間才不會互相干擾。

API 用新的,別用 bind。範例中的 .bind() 在 jQuery 3 已移除,請改用 .on();事件委派則用 .on(event, selector, handler) 取代舊的 delegate。

原文:https://www.cnblogs.com/JohnStart/archive/2011/08/24/jQueryPlugin.html

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