ComboBox 擴充自 $.fn.combo.defaults,並以 $.fn.combobox.defaults 覆寫預設值。

相依元件:combo
可以直接改寫原生 select,也可以指定一個 input:
<select id="cc" name="dept" style="width:200px;">
<option value="aa">aitem1</option>
<option>bitem2</option>
<option>bitem3</option>
</select>
$('#cc').combobox({
url: 'combobox_data.json',
valueField: 'id',
textField: 'text'
});
對應的 JSON 資料格式如下,其中 selected 為 true 的項目會成為初始選取值:
[
{ "id": 1, "text": "text1" },
{ "id": 2, "text": "text2" },
{ "id": 3, "text": "text3", "selected": true },
{ "id": 4, "text": "text4" }
]
屬性沿用 combo,以下為 combobox 新增的部分:
| 名稱 | 類型 | 說明 | 預設值 |
|---|---|---|---|
| valueField | string | 對應到 combobox 值的資料欄位名稱。 | value |
| textField | string | 對應到顯示文字的資料欄位名稱。 | text |
| mode | string | 文字變動時如何載入列表資料。若資料來自伺服器端篩選,應設為 'remote'。 | local |
| url | string | 從遠端載入列表資料的網址。 | null |
| method | string | 取得資料使用的 HTTP 方法。 | post |
| data | array | 直接載入的列表資料。 | null |
| filter | function | 當 mode 為 local 時決定如何篩選。參數為 q(使用者輸入文字)與 row(該列資料),回傳 true 表示顯示該列。 | 無 |
| formatter | function | 自訂每一列的呈現方式,參數為 row。 | 無 |
filter 的常見應用是做不分大小寫、忽略空白的模糊比對:
filter: function(q, row){
var val = q.toLowerCase();
return row.text.toLowerCase().indexOf(val) > -1;
}
| 名稱 | 參數 | 說明 |
|---|---|---|
| onLoadSuccess | none | 遠端資料載入成功時觸發。 |
| onLoadError | none | 遠端資料載入失敗時觸發。 |
| onSelect | record | 使用者選取某個列表項時觸發。 |
| onUnselect | record | 使用者取消選取時觸發。 |
| 名稱 | 參數 | 說明 |
|---|---|---|
| options | none | 回傳設定物件。 |
| getData | none | 回傳已載入的資料。 |
| loadData | data | 載入本地列表資料。 |
| reload | url | 重新向遠端請求列表資料。 |
| setValues | values | 以陣列設定多個值。 |
| setValue | value | 設定單一值。 |
| clear | none | 清除選取值。 |
| select | value | 選取指定值的選項。 |
| unselect | value | 取消選取指定值的選項。 |
資料量龐大時(例如數萬筆的產品清單),建議把 mode 設為 remote,並搭配 onSelect 或輸入事件觸發 reload,只取回符合條件的部分,避免一次把全部資料塞進瀏覽器。