選項卡(Tabs)大概是每個前端開發者都寫過的元件。與其每次重寫,不如把它包成一個可重複呼叫的 jQuery 插件。這個範例的好處是示範了幾個實用的插件設計手法:用 jQuery.fn 擴充方法、用自訂事件把「切換」這個動作解耦、以及用 data-tab 屬性取代 brittle 的索引比對。
結構很單純:一組 <ul id="tabs"> 當作標籤列,一個 <div id="tabContent"> 當作內容區,兩邊透過相同的 data-tab 值配對。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"https://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>jQuery 自定義選項卡插件</title>
<style>
body, ul { padding:0; margin:0; }
li { list-style:none; }
#tabs { zoom:1; }
#tabs:after { content:""; display:block; clear:both; }
#tabs li { float:left; padding:10px; color:#FF8900; background:#FFF; cursor:pointer; }
#tabs .active { background:#FF8900; color:#FFF; }
#tabContent { background:#FF8900; color:#FFF; padding:10px; clear:both; }
#tabContent div { display:none; }
#tabContent div.active { display:block; }
</style>
</head>
<body>
<ul id="tabs">
<li data-tab="users">Users</li>
<li data-tab="groups">Groups</li>
</ul>
<div id="tabContent">
<div data-tab="users">Users Content</div>
<div data-tab="groups">Groups Content</div>
</div>
樣式上有兩個關鍵:內容區的 div 預設 display:none,只有加上 .active 才顯示;而 #tabs:after 的 clearfix 則是為了讓浮動的 li 撐開父容器,避免後面的內容區被拉上來。
<script src="https://code.jquery.com/jquery-1.9.1.min.js"></script>
<script>
jQuery.fn.tabs = function (control) {
var element = $(this); // 標籤列
var control = $(control); // 內容區
// 點擊標籤時,觸發自訂事件並帶上該標籤的名稱
element.delegate('li', 'click', function () {
var tabName = $(this).attr('data-tab');
element.trigger('change.tabs', tabName);
});
// 監聽自訂事件:切換標籤的高亮狀態
element.bind('change.tabs', function (ev, tabName) {
element.find('li').removeClass('active');
element.find('>[data-tab=' + tabName + ']').addClass('active');
});
// 監聽自訂事件:切換內容區的顯示狀態
element.bind('change.tabs', function (ev, tabName) {
control.find('>[data-tab]').removeClass('active');
control.find('>[data-tab=' + tabName + ']').addClass('active');
});
// 預設啟用第一個選項卡
var firstName = element.find('li:first').attr('data-tab');
element.trigger('change.tabs', firstName);
return this; // 維持鏈式呼叫
};
jQuery(function ($) {
$('#tabs').tabs('#tabContent');
// 把目前選項卡同步到網址 hash,可分享、可書籤
$('#tabs').bind('change.tabs', function (ev, tabName) {
window.location.hash = tabName;
});
// 使用者用上一頁/下一頁或手動改 hash 時,同步切換選項卡
$(window).bind('hashchange', function () {
var tabName = window.location.hash.slice(1);
$('#tabs').trigger('change.tabs', tabName);
});
});
</script>
</body>
</html>
這份實作有三個值得學習的設計決定。
第一,用自訂事件取代直接操作。點擊時不直接改樣式,而是 trigger('change.tabs', tabName) 發一個事件;真正負責改畫面的邏輯則另外 bind 上去。這麼做的好處是,外部程式也能觸發同一個事件來切換選項卡——範例中的 hashchange 就是這樣復用的,一行都不用重複。
第二,用 data-tab 而非 index。以索引配對(第 0 個 li 對第 0 個 div)在標籤數量變動時很容易錯位;用語意化的名稱配對,可讀性與穩健性都更好。
第三,選擇器加上 >。control.find('>[data-tab=...]') 只找直接子元素,避免巢狀結構中同名屬性的元素被誤選。
另外提醒,範例中 window.loaction.hash 是原文的拼字錯誤,正確應為 window.location.hash,否則會拋出錯誤。若要在多個地方使用這個插件,也建議把樣式前綴加上頁面目錄或版本號,減少與既有 CSS 的衝突機會。