自動完成(Autocomplete)是搜尋框、輸入欄位最常見的輔助功能。bassistance.de 的 jQuery Autocomplete 是早期相當流行的一個實作,設定項目齊全,這裡把用法整理一遍。
<script type="text/javascript" src="/js/jquery-1.4.2.min.js"></script> <script type="text/javascript" src="/js/jquery.autocomplete.min.js"></script> <link rel="Stylesheet" href="/js/jquery.autocomplete.css" />
三個檔案缺一不可,特別是 CSS——少了它,提示列表會變成沒有定位的裸清單。
$(function() {
var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" ");
$('#keyword').autocomplete(data).result(function(event, data, formatted) {
alert(data);
});
});
資料來源只是一個字串陣列,輸入時就會即時比對並顯示提示。
result 是這個外掛的核心方法,在使用者選定某個項目時觸發。三個參數分別是事件物件、選中的原始資料、以及格式化後的文字。
var emails = [
{ name: "Peter Pan", to: "peter@pan.de" },
{ name: "Molly", to: "molly@yahoo.com" },
{ name: "Forneria Marconi", to: "live@japan.jp" },
{ name: "Master <em>Sync</em>", to: "205bw@samsung.com" },
{ name: "Dr. <strong>Tech</strong> de Log", to: "g15@logitech.com" },
{ name: "Don Corleone", to: "don@vegas.com" },
{ name: "Mc Chick", to: "info@donalds.org" },
{ name: "Donnie Darko", to: "dd@timeshift.info" },
{ name: "Quake The Net", to: "webmaster@quakenet.org" },
{ name: "Dr. Write", to: "write@writable.com" },
{ name: "GG Bond", to: "Bond@qq.com" },
{ name: "Zhuzhu Xia", to: "zhuzhu@qq.com" }
];
$(function() {
$('#keyword').autocomplete(emails, {
max: 12, // 列表最多顯示幾筆
minChars: 0, // 至少輸入幾字才啟動
width: 400, // 提示寬度,溢出隱藏
scrollHeight: 300, // 提示高度,溢出顯示捲軸
matchContains: true, // 包含比對
autoFill: false, // 自動填入
formatItem: function(row, i, max) {
return i + '/' + max + ':"' + row.name + '"[' + row.to + ']';
},
formatMatch: function(row, i, max) {
return row.name + row.to;
},
formatResult: function(row) {
return row.to;
}
}).result(function(event, row, formatted) {
alert(row.to);
});
});
這 trio 是自訂提示資訊的關鍵,很容易搞混,釐清如下:
記法:formatItem 管顯示、formatMatch 管比對、formatResult 管結果。三者分工明確,一旦理解就不會再混淆。
這個外掛已停止維護多年,最後版本停在 jQuery 1.4 的時代。新專案建議改用 jQuery UI 的 autocomplete,它是官方維護、支援 AJAX 資料來源、鍵盤操作與無障礙屬性都完整得多;若不使用 jQuery,也有若干輕量且持續更新的獨立套件可以考慮。
不過作為學習素材,這個外掛的設定分層設計仍然值得參考——把「顯示」「比對」「結果」三件事拆成獨立可設定的函式,是相當清晰的 API 抽象。