DIV CSS 佈局教程網

用 HTML5 data-* 屬性輕鬆初始化 JS 組件
編輯:關於JavaScript     

前言:近來使用 Bootstrap 組件時發現一個易用性上的痛點——很多簡單組件的初始化,都得在 JS 裡寫上一大堆重複的初始化代碼。舉例來說,只是一個單純的 select 標籤,因為要從後端抓資料填進 option,就必須靠 JS 來初始化,結果頁面初始化時滿屏都是幾乎一模一樣的代碼,看著實在惱人。

於是便聯想到 bootstrap table 裡的 data 屬性:如果能直接在 HTML 裡用 data-* 的方式來初始化簡單組件,那該有多爽快。我們先來看看 bootstrap table 的官方文檔:

可以看到,bootstrap table 幾乎所有屬性與事件都能用 data-* 的方式來設定,相當方便。那麼,data-* 究竟是從哪裡來的呢?

一、初探 jQuery data()

查了一圈資料後發現,data-* 的來源是 jQuery 與 HTML5。先來看看 jQuery 的 API:

作用很直觀,就是替元素加上某些屬性與數據,或是把值取出來。接著看看 data() 方法與 HTML5 data-* 屬性的結合用法:

是不是很方便?透過 HTML5 的 data-* 設定的值,可以用 jQuery 的 data() 方法讀取。這裡的規則是:

1)所有 data 屬性都必須以「data-」開頭;

2)屬性之間用「-」分隔;

3)在 jQuery 裡取值時,去掉「data」與「-」即可。

有了這個基礎,我們就知道該如何在標籤上設定屬性,並在 JS 中讀取對應的值了。下面就結合先前封裝 combobox 的例子來說明。

二、以 jQuery data() 實現 data-* 初始化組件

還記得先前的 JS 組件系列中封裝過一個簡單的 combobox,可以透過 url 從後端取資料。這次我們仍舊在這個組件上動手腳,實現直接在 select 標籤上用 data-* 屬性來初始化下拉框。

1、JS 組件封裝代碼

 (function ($) { //1.定義jquery的擴展方法combobox $.fn.combobox = function (options, param) { if (typeof options == 'string') { return $.fn.combobox.methods[options](this, param); } //2.將調用時候傳過來的參數和default參數合並 options = $.extend({}, $.fn.combobox.defaults, options || {}); //3.添加默認值 var target = $(this); target.attr('valuefield', options.valueField); target.attr('textfield', options.textField); target.empty(); var option = $('<option></option>'); option.attr('value', ''); option.text(options.placeholder); target.append(option); //4.判斷用戶傳過來的參數列表裡面是否包含數據data數據集,如果包含,不用發ajax從後台取,否則否送ajax從後台取數據 if (options.data) { init(target, options.data); } else { //var param = {}; options.onBeforeLoad.call(target, options.param); if (!options.url) return; if (typeof options.param == "string"){ options.param = JSON.parse(options.param); } $.getJSON(options.url, options.param, function (data) { init(target, data); }); } function init(target, data) { $.each(data, function (i, item) { var option = $('<option></option>'); option.attr('value', item[options.valueField]); option.text(item[options.textField]); target.append(option); }); options.onLoadSuccess.call(target); } target.unbind("change"); target.on("change", function (e) { if (options.onChange) return options.onChange(target.val()); }); } //5.如果傳過來的是字符串,代表調用方法。 $.fn.combobox.methods = { getValue: function (jq) { return jq.val(); }, setValue: function (jq, param) { jq.val(param); }, load: function (jq, url) { $.getJSON(url, function (data) { jq.empty(); var option = $('<option></option>'); option.attr('value', ''); option.text('請選擇'); jq.append(option); $.each(data, function (i, item) { var option = $('<option></option>'); option.attr('value', item[jq.attr('valuefield')]); option.text(item[jq.attr('textfield')]); jq.append(option); }); }); } }; //6.默認參數列表 $.fn.combobox.defaults = { url: null, param: null, data: null, valueField: 'value', textField: 'text', placeholder: '請選擇', onBeforeLoad: function (param) { }, onLoadSuccess: function () { }, onChange: function (value) { } }; //這一段是新加的,在頁面初始化完成之後調用初始化方法 $(document).ready(function () { $('.combobox').each(function () { var $combobox = $(this); $.fn.combobox.call($combobox, $combobox.data()); }) }); })(jQuery); 

大部分代碼與先前幾乎一致,我們重點看最底下這段:

 //這一段是新加的,在頁面初始化完成之後調用初始化方法 $(document).ready(function () { $('.combobox').each(function () { var $combobox = $(this); $.fn.combobox.call($combobox, $combobox.data()); }) }); 

很明顯,它是在頁面初始化完成後,透過樣式選擇器去初始化組件。這裡用了 each,若頁面上有多個 .combobox 樣式,就會依序初始化每一個。而 $.fn.combobox.call($combobox, $combobox.data()); 則透過 call 方法呼叫 combobox 的初始化,兩個參數分別對應:

1)當前初始化的 jQuery 對象;

2)參數列表——這裡透過 $combobox.data() 取得的正是 HTML 中的所有 data-* 屬性,並將它們作為參數傳入初始化方法。

2、在 HTML 中以 data-* 初始化

 <select id="Search_" name="Search_province" class="form-control combobox" data-url="/Home/GetProvince" data-param='{"type":"0"}' data-text-field="Name" data-value-field="Id"> </select> 

指定 data-* 屬性。由於初始化是靠 .combobox 樣式選擇器來觸發,因此若想用 data-* 做初始化,就必須設定 class="combobox",後端才抓得到需要初始化的標籤。

3、後端 C# 方法

 public class HomeController : Controller { public List<string> lstProvince = new List<string>() { "北京市", "天津市", "重慶市", "上海市", "河北省", "山西省", "遼寧省", "吉林省", "黑龍江省", "江蘇省", "浙江省", "安徽省", "福建省", "江西省", "山東省", "河南省", "湖北省", "湖南省", "廣東省", "海南省", "四川省", "貴州省", "雲南省", "陝西省", "甘肅省", "青海省", "台灣省", "內蒙古自治區", "廣西壯族自治區", "西藏自治區", "寧夏回族自治區", "新疆維吾爾自治區", "香港特別行政區", "澳門特別行政區" }; public JsonResult GetProvince(string type) { var lstRes = new List<Province>(); for (var i = 0; i < 10; i++) { var oModel = new Province(); oModel.Id = i; oModel.Name = lstProvince[i]; lstRes.Add(oModel); } return Json(lstRes, JsonRequestBehavior.AllowGet); } } public class Province { public int Id { get; set; } public string Name { get; set; } } 

這是測試用的代碼,沒有太多需要多說的地方。

4、調試效果

最終得到的效果:

如此一來,就基本完成了透過 data-* 來初始化組件的目標。

三、總結

本文簡單示範了 jQuery data() 方法結合 HTML5 data-* 屬性的用法,基本上能達到「不用多寫一行 JS 就能初始化標籤」的效果。使用時只要引入 jquery.js 與 jquery.extension.js 即可。不過要留意,這畢竟是 HTML5 的特性,對瀏覽器版本會有一定要求。此用法雖屬初階,但應付簡單組件的初始化已經綽綽有餘。文中若有理解不到位之處,也歡迎大家指正。

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