本文系統整理 jQuery UI Tabs 的屬性、事件與方法,方便開發時快速查閱。以下提到的 $('.selector') 皆為 tabs 的選擇器,範例中 .selector = #tabs。
ajaxOptions:當選項卡載入內容時額外附加的 ajax 選項,僅在啟用 ajax 時生效,預設為 null。可在其中設定 beforeSend、success 等回呼。
$('.selector').tabs({ ajaxOptions: { async: false } });//將非同步改為同步 //getter var ajaxOptions = $('.selector').tabs('option', 'ajaxOptions'); //setter $('.selector').tabs('option', 'ajaxOptions', { async: false });
cache:預設 false,也就是無快取。每次請求都會重新整理;設為 true 時,第一次請求後便不再重新抓取。
$('.selector').tabs({ cache: true }); //getter var cache = $('.selector').tabs('option', 'cache'); //setter $('.selector').tabs('option', 'cache', true);
collapsible:是否可折疊,預設 false。設為 true 後,再次點擊已選中的選項卡即可將內容收合,再點一次又展開。
$('.selector').tabs({ collapsible: true });
cookie:預設 null,需搭配 cookie 外掛,用來記住最後一次選中的選項卡。可用選項例如 { expires: 7, path: '/', domain: 'jquery.com', secure: true }。
$('.selector').tabs({ cookie: { expires: 30 } });
deselectable:預設 false,作用與 collapsible 類似。
disabled:設定哪些選項卡不可用,為一陣列,例如 [0,1,2] 代表第一、二、三個選項卡,預設為 []。
$('.selector').tabs({ disabled: [1, 2] });
event:切換選項卡的觸發事件,預設 'click'。
$('.selector').tabs({ event: 'mouseover' }); //滑鼠移過即切換
fx:切換時的動畫效果,預設 null(無動畫)。
idPrefix:使用 ajax 時為其加上唯一 id 的前綴,預設 'ui-tabs-'。
$('.selector').tabs({ idPrefix: 'ui-tabs-primary' });
selected:初始化時被選中的選項卡索引,預設 0(第一個)。
$('.selector').tabs({ selected: 3 });
spinner:遠端內容(ajax)載入時,顯示在選項卡標題上的 HTML 字串。
$('.selector').tabs({ spinner: 'Retrieving data...' });
panelTemplate、tabTemplate:分別用於自訂面板與標籤的 HTML 模板。
先看一下事件綁定的範例:
$('#example').bind('tabsselect', function(event, ui) { ui.tab // 被選中(點擊後)的選項卡元素 ui.panel // 包含被選中選項卡內容的元素 ui.index // 被選中選項卡的索引值(從 0 開始) });
常見事件包含:select(tabsselect,點擊時觸發)、load(tabsload,ajax 內容載入完成後觸發)、show(tabsshow,選項卡顯示後觸發)、add(tabsadd,新增後觸發)、remove(tabsremove,刪除後觸發)、enable(tabsenable,啟用時觸發)、disable(tabsdisable,停用時觸發)。
$('.selector').tabs({ select: function(event, ui) { ... } }); //初始化時綁定 $('.selector').bind('tabsselect', function(event, ui) { ... }); //初始化後綁定
.tabs( 'destroy' ) //銷毀 .tabs( 'enable' ) //啟用整個選項卡 .tabs( 'option' , optionName , [value] ) //設定屬性 .tabs( 'add' , url , label , [index] ) //新增 .tabs( 'remove' , index ) //刪除 .tabs( 'enable' , index ) //啟用某個標籤 .tabs( 'disable' , index ) //停用某個標籤 .tabs( 'select' , index ) //選取某個標籤,index 從 0 開始 .tabs( 'load' , index ) //重新載入 ajax 選項卡內容 .tabs( 'url' , index , url ) //變更即將載入的 url .tabs( 'abort' ) //中止所有 ajax 請求或動畫 .tabs('rotate',ms,[continue]) //自動輪播,第二參數為毫秒,設 0 或 null 停止;第三參數控制選取後是否繼續
1. 取得目前選中選項卡的索引:
var $tabs = $('#example').tabs(); var selected = $tabs.tabs('option', 'selected'); // => 0
2. 用其他元素觸發切換選項卡:
var $tabs = $('#example').tabs(); $('#my-text-link').click(function() { $tabs.tabs('select', 2); return false; });
3. 新增後立刻選中該選項卡:
var $tabs = $('#example').tabs({ add: function(event, ui) { $tabs.tabs('select', '#' + ui.panel.id); } });
4. 在新視窗開啟選項卡:
$('#example').tabs({ select: function(event, ui) { location.href = $.data(ui.tab, 'load.tabs'); return false; } });