看別人的 HTML 時常會發現一些 data- 開頭的屬性,那是 HTML5 的自訂資料屬性。它能把額外資訊直接掛在標籤上,用 JS 讀取非常方便。雖然出自 HTML5,但因為 jQuery 早就把它包好了,所以連低版本 IE 都能正常使用。
<div id="widget" data-text="123456"></div>
$(function(){
var _widget= $("#widget").attr("data-text");
alert(_widget);//data-text="123456",所以印出 123456
})
HTML 部分:
<div id="widget" data-widget-config="{effect:'click'}">這裡是測試區域</div>
外掛本體:
;(function($){
$.fn.extend({
Test:function(config){
/**
* @param effect 效果
* config||{} 當有自訂屬性傳進來時不執行預設值
*/
// 設定預設值
config=$.extend({
effect:'click',
},config||{});
var effect=config.effect;
var _text=config._text;
if(effect=='click'){
$(this).click(function(){
alert('this click');
})
}else if(effect=='mouseover'){
$(this).mouseover(function(){
alert("this is mouseover");
})
}
}
})
})(jQuery)
呼叫部分(HTML 中的 data 屬性就是靠這裡生效):
$(function(){
var _widget= $("#widget").attr("data-widget-config");
// 把字串轉成 JSON 物件有兩種寫法
var widgetConfigJSON=eval("("+_widget+")");
// var widgetConfigJSON = (new Function("return " + _widget))();
$("#widget").Test(widgetConfigJSON);
// HTML 中 data-widget-config="{effect:'click'}",所以這裡會觸發點擊事件;
// 若改成 "{effect:'mouseover'}",則改為滑鼠移入時觸發
})
這個組合的價值在於:外掛的行為參數直接寫在 HTML 標籤上,同一支外掛套在不同元素時可以有不同設定,不必額外寫一堆初始化程式。
兩點提醒:一是 eval 會執行任意字串,若 data 內容來自使用者輸入就有 XSS 風險,建議改用 JSON.parse(注意標準 JSON 的鍵與字串值都必須用雙引號);二是 jQuery 的 .data() 方法會自動把 JSON 字串解析成物件,並把 "123" 轉為數字,通常比 .attr() 更方便,但要注意它有快取行為,執行期間改動屬性後 .data() 讀到的可能仍是舊值。