原生 <select> 在很多情境下不夠用:不能搜尋、不能帶圖示、選項一多就難找、更別說要從後端動態撈資料。Select2 就是為了解決這些問題而生。本文整理它最常被用到的四個能力,以及最後一定要會的「取值與設值」。
1. 多選與數量上限


可以設定最多只能挑幾項,超過就無法再選。

2. 圖文並茂的選項

3. 遠程搜索——使用者打字的同時動態向後端要資料,並在捲到底時自動載入下一批。
輸入前:

輸入空格即可列出全部:

捲動到底自動載入剩餘項目:

輸入文字後動態向後端過濾:

更進階的客製樣板:

其實做起來不難,本質上就是「拼 HTML 字串」。
1. 多選
先引入 jQuery、Bootstrap 與 select2 的 JS/CSS,然後在 <select> 上加上 multiple,初始化時給 maximumSelectionLength 就能限制可選數量。tags: true 則允許使用者自訂選項。
<script src="~/Scripts/jquery-1.10.2.js"></script> <script src="~/Content/bootstrap/js/bootstrap.js"></script> <link href="~/Content/bootstrap/css/bootstrap.css" rel="stylesheet" /> <script src="~/Content/select2-master/dist/js/select2.js"></script> <link href="~/Content/select2-master/dist/css/select2.css" rel="stylesheet" /> <select id="sel_menu2" multiple="multiple" class="form-control"> <optgroup label="系統設置"> <option value="1">用戶管理</option> <option value="2">角色管理</option> <option value="3">部門管理</option> <option value="4">菜單管理</option> </optgroup> <optgroup label="訂單管理"> <option value="5">訂單查詢</option> <option value="6">訂單導入</option> <option value="7">訂單刪除</option> <option value="8">訂單撤銷</option> </optgroup> <optgroup label="基礎數據"> <option value="9">基礎數據維護</option> </optgroup> </select> //多選 $("#sel_menu2").select2({ tags: true, maximumSelectionLength: 3 //最多能夠選擇的個數 });
2. 圖文結合
關鍵是 templateResult(下拉清單的樣板)與 templateSelection(已選區域的樣板),兩者都指向自訂的 formatState 函式,在裡面回傳一段帶 <img> 的 HTML。
<select id="sel_menu" class="js-example-templating js-states form-control"> <optgroup label="系統設置"> <option value="1">用戶管理</option> <option value="2">角色管理</option> <option value="3">部門管理</option> <option value="4">菜單管理</option> </optgroup> <optgroup label="訂單管理"> <option value="5">訂單查詢</option> <option value="6">訂單導入</option> <option value="7">訂單刪除</option> <option value="8">訂單撤銷</option> </optgroup> <optgroup label="基礎數據"> <option value="9">基礎數據維護</option> </optgroup> </select> $(function () { //帶圖片 $("#sel_menu").select2({ templateResult: formatState, templateSelection: formatState }); }); function formatState(state) { if (!state.id) { return state.text; } var $state = $( '<span><img src="/content/images/' + state.element.value.toLowerCase() + '.ico" class="img-flag" /> ' + state.text + '</span>' ); return $state; };
3. 遠程搜索
設定 ajax 區塊即可。data 負責把使用者輸入的關鍵字與頁碼送出去,processResults 負責把後端回應轉成 select2 認得的格式,minimumInputLength 控制至少打幾個字才觸發查詢。
<select id="sel_menu3" class="js-data-example-ajax form-control"> <option value="3620194" selected="selected">請選擇</option> </select> $(function () { //遠程篩選 $("#sel_menu3").select2({ ajax: { url: "/Home/GetProvinces", dataType: 'json', delay: 250, data: function (params) { return { q: params.term, // search term page: params.page }; }, processResults: function (data, params) { params.page = params.page || 1; return { results: data.items, pagination: { more: (params.page * 10) < data.total_count } }; }, cache: true }, escapeMarkup: function (markup) { return markup; }, // let our custom formatter work minimumInputLength: 1, templateResult: formatRepoProvince, // omitted for brevity, see the source of this page templateSelection: formatRepoProvince // omitted for brevity, see the source of this page }); }); function formatRepoProvince(repo) { if (repo.loading) return repo.text; var markup = "<div>"+repo.name+"</div>"; return markup; }
這裡最該注意的是 processResults 回傳物件中的 more 屬性,它決定「還要不要顯示捲軸讓使用者繼續載入」。這個值必須和後端每次回傳的筆數對得上,否則會出現捲不到底、或明明還有資料卻不再載入的狀況。
後端(這裡用 ASP.NET MVC 舉例)大致如下:
public List<string> lstProvince = new List<string>() {"北京市","天津市","重慶市","上海市","河北省","山西省","遼寧省","吉林省","黑龍江省","江蘇省","浙江省","安徽省","福建省","江西省","山東省","河南省","湖北省","湖南省","廣東省","海南省","四川省","貴州省","雲南省","陝西省","甘肅省","青海省","台灣省","內蒙古自治區","廣西壯族自治區","西藏自治區","寧夏回族自治區","新疆維吾爾自治區","香港特別行政區","澳門特別行政區" }; public JsonResult GetProvinces(string q, string page) { var lstRes = new List<Province>(); for (var i = 0; i < 30; i++) { var oProvince = new Province(); oProvince.id = i; oProvince.name = lstProvince[i]; lstRes.Add(oProvince); } if (!string.IsNullOrEmpty(q.Trim())) { lstRes = lstRes.Where(x => x.name.Contains(q)).ToList(); } var lstCurPageRes = string.IsNullOrEmpty(page) ? lstRes.Take(10) : lstRes.Skip(Convert.ToInt32(page) * 10 - 10).Take(10); return Json(new { items = lstCurPageRes, total_count = lstRes.Count }, JsonRequestBehavior.AllowGet); }
取得選中的值——直接用 jQuery 的 val():
var oMenuIcon = $("#txt_menuicon_web").select2({ placeholder: "請選擇菜單圖標", templateResult: oInit.formatState, templateSelection: oInit.formatState }); oMenuIcon.val();
設定選中值——這裡有個關鍵:設完 val() 之後一定要 trigger("change"),否則 select2 的畫面不會更新,值改了但使用者看到的還是舊的。
var oMenuIcon = $("#txt_menuicon_web").select2({ placeholder: "請選擇菜單圖標", templateResult: oInit.formatState, templateSelection: oInit.formatState }); oMenuIcon.val("CA").trigger("change");
以上就是 Select2 最常用到的幾個能力。想更深入的話,建議直接讀官方文件;另外也可搭配 Bootstrap 的學習教程、實戰教程與外掛使用教程一起看,會更完整。