上一篇講了分頁與 JSTree,這篇接著談編輯頁面裡出場率最高的 Select2。它在原生 select 的基礎上補齊了搜尋、多選、級聯等能力,無論功能還是操作體驗都提升不少。
1、Select2 簡介
GitHub 官網:https://select2.github.io/
範例集:https://select2.github.io/examples.html
框架裡大量使用它來呈現各種選擇情境,包括單選下拉(含級聯)、多選下拉、樹形下拉:
1)省/市/行政區的三級級聯。選省份後載入對應城市,選城市再載入下層行政區:

2)多選下拉

勾選後,未選的項目會自動移到另一側,非常直觀:

3)樹形下拉。像所屬機構、上層列表這類有層級關係的資料:


2、實際用法
1)基礎用法
用法很輕量:在原本的 select 上加一個 class 就好。
<div class="col-md-6"> <div class="form-group"> <label class="control-label col-md-4">重要級別</label> <div class="col-md-8"> <select id="Importance" name="Importance" class="form-control select2" placeholder="重要級別..."></select> </div> </div> </div> <div class="col-md-6"> <div class="form-group"> <label class="control-label col-md-4">認可程度</label> <div class="col-md-8"> <select id="Recognition" name="Recognition" class="form-control select2" placeholder="認可程度..."></select> </div> </div> </div>
固定選項直接寫 option:
<div class="col-md-6"> <div class="form-group"> <label class="control-label col-md-4">吸煙</label> <div class="col-md-8"> <select id="Smoking" name="Smoking" type="text" class="form-control select2" placeholder="吸煙..."> <option>吸煙</option> <option>不吸煙</option> </select> </div> </div> </div>
最簡單的初始化:
$(document).ready(function() { $(".js-example-basic-single").select2(); });
要開放多選,加上 multiple 屬性即可:
<select id="ResponseDemand" name="ResponseDemand" multiple="multiple" class="form-control select2"></select>
2)動態綁定資料
實務上選項多半來自資料庫,透過 Ajax 取得後再綁定。為了避免每頁重寫,我抽出一個公用函式:
//綁定字典內容到指定的Select控件 function BindSelect(ctrlName, url) { var control = $('#' + ctrlName); //設置Select2的處理 control.select2({ allowClear: true, formatResult: formatResult, formatSelection: formatSelection, escapeMarkup: function (m) { return m; } }); //綁定Ajax的內容 $.getJSON(url, function (data) { control.empty();//清空下拉框 $.each(data, function (i, item) { control.append("<option value='" + item.Value + "'> " + item.Text + "</option>"); }); }); }
再包一層,讓字典類資料只需傳型別名稱:
//綁定字典內容到指定的控件 function BindDictItem(ctrlName, dictTypeName) { var url = '/DictData/GetDictJson?dictTypeName=' + encodeURI(dictTypeName); BindSelect(ctrlName, url); }
於是初始化與級聯都寫得很乾淨。BindDictItem 綁字典,BindSelect 依 URL 取資料,on("change") 則處理聯動:
//初始化字典信息(下拉列表) function InitDictItem() { //部分賦值參考 BindDictItem("Area","市場分區"); BindDictItem("Industry", "客戶行業"); BindDictItem("Grade","客戶級別"); BindDictItem("CustomerType", "客戶類型"); BindDictItem("Source", "客戶來源"); BindDictItem("CreditStatus", "信用等級"); BindDictItem("Stage","客戶階段"); BindDictItem("Status", "客戶狀態"); BindDictItem("Importance", "重要級別"); // 綁定省份、城市、行政區(聯動處理) BindSelect("Province", "/Province/GetAllProvinceNameDictJson"); $("#Province").on("change", function (e) { var provinceName = $("#Province").val(); BindSelect("City", "/City/GetCitysByProvinceNameDictJson?provinceName="+ provinceName); }); $("#City").on("change", function (e) { var cityName = $("#City").val(); BindSelect("District", "/District/GetDistrictByCityNameDictJson?cityName="+ cityName); }); }
後端回傳的 JSON 格式如下:
[ { "Text": "", "Value": "" }, { "Text": "學術會議", "Value": "學術會議" }, { "Text": "朋友介紹", "Value": "朋友介紹" }, { "Text": "廣告媒體", "Value": "廣告媒體" } ]
前端直接取 Text 與 Value 兩個屬性組 option:
//綁定Ajax的內容 $.getJSON(url, function (data) { control.empty();//清空下拉框 $.each(data, function (i, item) { control.append("<option value='" + item.Value + "'> " + item.Text + "</option>"); }); });
對應的控制器方法:
/// <summary> /// 根據字典類型獲取對應的字典數據,方便UI控件的綁定 /// </summary> /// <param name="dictTypeName">字典類型名稱</param> /// <returns></returns> public ActionResult GetDictJson(string dictTypeName) { List<CListItem> treeList = new List<CListItem>(); CListItem pNode = new CListItem("", ""); treeList.Insert(0, pNode); Dictionary<string, string> dict = BLLFactory<DictData>.Instance.GetDictByDictType(dictTypeName); foreach (string key in dict.Keys) { treeList.Add(new CListItem(key, dict[key])); } return ToJsonContent(treeList); }
3)樹形資料的綁定
所屬公司、部門這類有層級的資料,做法相同:
//綁定添加界面的公司、部門、直屬經理 BindSelect("Company_ID", "/User/GetMyCompanyDictJson?userId="+@Session["UserId"]); $("#Company_ID").on("change", function (e) { var companyid = $("#Company_ID").val(); BindSelect("Dept_ID", "/User/GetDeptDictJson?parentId="+ companyid); }); $("#Dept_ID").on("change", function (e) { var deptid = $("#Dept_ID").val(); BindSelect("PID", "/User/GetUserDictJson?deptId="+ deptid); });
差別只在回傳的資料用縮排來表達層級:
[ { "Text": "愛奇迪集團", "Value": "1" }, { "Text": " 廣州分公司", "Value": "3" }, { "Text": " 上海分公司", "Value": "4" }, { "Text": " 北京分公司", "Value": "5" } ]
或者:
[ { "Text": "廣州分公司", "Value": "3" }, { "Text": "總經辦", "Value": "6" }, { "Text": "財務部", "Value": "7" }, { "Text": "工程部", "Value": "8" }, { "Text": "產品研發部", "Value": "9" }, { "Text": " 開發一組", "Value": "14" }, { "Text": " 開發二組", "Value": "15" }, { "Text": " 測試組", "Value": "16" }, { "Text": "市場部", "Value": "10" }, { "Text": " 市場一部", "Value": "23" }, { "Text": " 市場二部", "Value": "24" }, { "Text": "綜合部", "Value": "11" }, { "Text": "生產部", "Value": "12" }, { "Text": "人力資源部", "Value": "13" } ]
也就是說,層級關係是靠 Text 前面補空格做出來的:

老實說,這種呈現方式在視覺上不如 EasyUI 的樹形下拉漂亮,日後或許該找個更合適的 Bootstrap 外掛來做這件事。


4)賦值與清空
初始化完成後,編輯界面要能回填既有值。清空單一控件:
//清空Select2控件的值 $("#PID").select2("val", ""); $("#Company_ID").select2("val", ""); $("#Dept_ID").select2("val", "");
多個控件可用集合批次處理:
var select2Ctrl = ["Area","Industry","Grade","CustomerType","Source","CreditStatus","Stage","Status","Importance"]; $.each(select2Ctrl, function (i, item) { var ctrl = $("#" + item); ctrl.select2("val", ""); });
賦值寫法一樣:
$("#CustomerType").select2("val", info.CustomerType); $("#Grade").select2("val", info.Grade); $("#CreditStatus").select2("val", info.CreditStatus); $("#Importance").select2("val", info.Importance); $("#IsPublic").select2("val", info.IsPublic);
級聯的部分要記得串上 trigger('change'),才會觸發下游重新載入:
$("#Province").select2("val", info.Province).trigger('change');//聯動 $("#City").select2("val", info.City).trigger('change');//聯動 $("#District").select2("val", info.District); $("#Company_ID1").select2("val", info.Company_ID).trigger('change'); $("#Dept_ID1").select2("val", info.Dept_ID).trigger('change'); $("#PID1").select2("val", info.PID);
最後放幾張整體畫面:



以上就是 Select2 在專案中的完整用法整理,希望對大家有幫助。