jQuery UI 除了現成元件,更可貴的是它提供了一套「外觀與結構分離」的建構規範。理解這套規範,你就能寫出與官方主題視覺一致的自有元件。
ui.core.css 與 ui.theme.css 貫穿整個 jQuery UI 介面,並可透過 ThemeRoller 產生自訂主題。分工原則很明確:
開發 widget 時必須遵循同樣的分工,這樣 ThemeRoller 換主題時,你的元件才會跟著一起變。
.ui-helper-hidden:套用 display:none。.ui-helper-hidden-accessible:以絕對定位把元素移到不可見處(保留給螢幕閱讀器)。.ui-helper-clearfix:清除浮動。.ui-helper-zfix:修正 iframe 覆蓋問題。.ui-state-default:預設狀態。.ui-state-hover:滑鼠移入。.ui-state-focus:取得焦點。.ui-state-active:啟用/選中狀態。.ui-state-highlight:需要提示性高亮時使用。.ui-state-error:錯誤狀態,通常用於承載錯誤訊息。.ui-state-error-text:錯誤文字本身的樣式。.ui-state-disabled:禁用狀態。.ui-priority-primary:一級按鈕,套用粗體。.ui-priority-secondary:二級按鈕,字體較細並帶輕度透明。Framework 內建一套通用圖標,用法為 class="ui-icon ui-icon-****"。
.ui-corner-tl / tr / bl / br:四個單角圓角。.ui-corner-top / bottom / left / right:成對圓角。.ui-corner-all:四角圓角。.ui-widget-overlay:遮罩層。.ui-widget-shadow:陰影。上述圓角皆基於 CSS3,IE 下不生效。
jQuery UI 的 widget 都繼承自 jquery.ui.widget.js,它提供 $.widget(String name, Options prototype) 這個工廠方法。開發時會用到的成員:
destroy():把 widget 從 DOM 上移除,含樣式、行為與結構。這幾乎是必寫的方法,否則元件無法安全銷毀。options:保存 widget 的設定。element:widget 作用的 DOM 物件。enable() / disable():其實只是修改 options.disabled。_create():建立 widget 時執行,絕大多數的結構與行為都在這裡產生。_init():在 _create() 之後執行,且每次重新初始化時都會再跑一次。_setOption():提供 options 各屬性的設定入口。若某個參數不需要特殊處理(驗證、型別轉換、設值時觸發副作用),通常不必覆寫。$(function () {
// _create() 與 _init() 都會執行(首次呼叫)
$("div").mywidget();
// widget 已實例化,此時只執行 _init()
$("div").mywidget();
// 銷毀 widget
$("div").mywidget("destroy");
// 因為已被銷毀,_create() 與 _init() 都會再執行一次
$("div").mywidget();
});
實務上的判斷標準:只做一次的初始化放 _create,需要可重複執行的重設邏輯放 _init。
需要對外拋事件時,用 factory 提供的 _trigger():
this._trigger(type, event, data);
// type:事件型別
// event:原生 event 物件
// data:要傳遞的資料
// 此 widget 只負責修飾 textbox,自身不含 CSS,完全採用 framework 樣式
(function ($) {
// ui 前綴 + widget 名稱
$.widget("ui.textboxdecorator", {
options: {},
_init: function () {
// 驗證是否為需要裝飾的元素
if (!(this.element.attr("tagName").toLowerCase() === "input"
|| this.element.attr("tagName").toLowerCase() === "textarea")) {
return;
}
if (!(this.element.attr("type").toLowerCase() === "text"
|| this.element.attr("type").toLowerCase() === "password")) {
if (this.element.attr("tagName").toLowerCase() === "input") return;
}
var e = this.element;
// ui-widget 為基礎樣式,ui-state-default 為預設狀態,ui-corner-all 為圓角
this.element.addClass("ui-widget ui-state-default ui-corner-all");
// 加上 hover 與 active 效果
this.element
.mouseover(function () { e.addClass("ui-state-hover"); })
.mouseout(function () { e.removeClass("ui-state-hover"); })
.mousedown(function () { e.addClass("ui-state-active"); })
.mouseup(function () { e.removeClass("ui-state-active"); });
},
// 銷毀時移除 widget 增加的樣式
destroy: function () {
this.element.removeClass(
"ui-widget ui-state-default ui-corner-all ui-state-hover ui-state-active"
);
}
});
})(jQuery);
需引用 jquery.js、jquery.ui.core.js、jquery.ui.widget.js,樣式則需 jquery.ui.core.css 與 jquery.ui.theme.css:
$("input").textboxdecorator();
第一,結構進 core、視覺進 theme,這是能換主題的前提。第二,destroy 一定要寫完整——建立時加上的每個 class、每個事件、每個 DOM 節點,都要能乾淨地移除。做到這兩點,你的 widget 就能和官方元件並肩使用,風格統一而毫無突兀。