用到的框架是 mass Framework,當然換成 jQuery 或其他庫也完全可行,這裡沒有什麼複雜的東西,弄懂原理一下子就能做出來。往後工作上遇到做搜尋框的需求,這套思路都能派上用場。
由於沒有後端,因此取用一個物件作為本地資料庫。而我想做的其實比單純的 suggest 更高階一些,比較接近 IDE 的語法提示。目前成品已放在 GitHub 上。

裝了 Firefox 的同學可以在百度首頁查看原始碼:輸入幾個字母時,會動態產生一批 HTML。不論實作細節如何,最終成果都是一個 DIV 放在搜尋欄下方,裡面放著承載候選詞的清單,而候選詞中「非使用者輸入」的部分(也就是 JS 自動補齊的內容)會被包進 <b> 標籤裡加粗顯示。
不過我覺得用 table 太重量級,改用 ul 列表;為了讓 IE6 也支援滑過變色效果,裡面再套一層 a 標籤。為了方便取詞,還幫 a 標籤加了一個屬性,專門存放補齊後的完整詞彙:
<div id="search_wrapper"> <div> <input id="search" autocomplete="off"> </div> <div id="suggest_wrapper"> <ul id="suggest_list"> <li> <a data-value="完整的詞匯" href="javascript:void(0)"> 用戶輸入部分 <b>自動提示部分</b> </a> </li> <li> <a data-value="完整的詞匯" href="javascript:void(0)"> 用戶輸入部分 <b>自動提示部分</b> </a> </li> <!-- 更多 li,最多 10 個 --> </ul> </div> </div>
結構其實就兩塊:#search_wrapper 負責可見部分,#suggest_wrapper 則在沒有 li 子元素時不佔空間,自然顯示不出來。input 上的 autocomplete="off" 用來關掉瀏覽器自帶的提示功能。
關於 data-value:這種命名方式是 HTML5 推薦的做法,用來定義要緩存的資料。在新銳瀏覽器中,所有 data-* 屬性會被收攏到一個叫 dataset 的物件裡。例如:
<div id="司徒正美"
data-drink="coffee"
data-meal-time="12:00">12:00</div>
可以這樣存取:
var el = document.getElementById('司徒正美');
alert(el.dataset.drink); // coffee
alert(el.dataset.mealTime); // 12:00
注意命名轉換:HTML 中寫 data-meal-time,JS 中存取的屬性名是駝峰式的 mealTime。當然也可以不加屬性,直接取 a 標籤的 innerText 或 textContent。
一個容易踩的坑:完整詞彙 = 使用者輸入部分 + 自動提示部分。因此不要在 a 標籤裡塞入多餘的空白或換行,否則字串拼接會多出空格,導致後續的比對與取值失敗。
#search_wrapper {
height: 50px;
}
#search {
width: 300px;
}
#suggest_wrapper {
position: relative;
}
#suggest_list {
position: absolute;
z-index: 100;
list-style: none;
margin: 0;
padding: 0;
background: #fffafa;
border: 1px solid #ccc;
border-bottom: 0 none;
}
#suggest_list li a {
display: block;
height: 20px;
width: 304px;
color: #000;
border-bottom: 1px solid #ccc;
line-height: 20px;
text-decoration: none;
}
#suggest_list li a:hover, .glow_suggest {
background: #ffff80;
}
外層 position:relative 搭配清單的 position:absolute,讓提示層能精準疊在搜尋框下方而不佔據文件流。.glow_suggest 類別則是給鍵盤上下鍵切換時用的高亮樣式。
由於沒有後端,改用一個本地 JS 物件當資料庫。遍歷物件一般就是 obj.aaa.bbb.ccc 這樣一路點下去,而每遇到一個點號,本質上就是對當前物件做了一次 for...in 遍歷。
因此做法是:監聽輸入框內容變化,一旦發生變化就取出內容,在 for...in 迴圈中比對,凡是以輸入值開頭的屬性就取出來放進陣列,累積到十個為止,最後把這些項目拼成前述的 li 格式貼進 ul。若一開始就輸入點號,就取 window 物件的十個屬性;之後每遇到點號就切換遍歷的目標物件。
//by 司徒正美
$.require("ready,event,attr", function(){
var search = $("#search"),
hash = window,
prefix = "",
fixIE = NaN;
search.addClass("search_target");
search.input(function(){ // 監聽輸入
var input = this.value, // 原始值
val = input.slice(prefix.length), // 比較值
output = []; // 用來放置輸出內容
if (fixIE === input) {
return // IE 下即使是程式改寫 input 的值也會觸發 propertychange,
// 會干擾上下鍵操作,因此需要攔下
}
for (var prop in hash) {
if (prop.indexOf(val) === 0) { // 取得以輸入值開頭的屬性
if (output.push(
'<li><a href="javascript:void(0)" data-value="' + prefix + prop +
'">' + input + "<b>" + (prefix + prop).slice(input.length) +
"</b></a></li>"
) == 10) {
break;
}
}
}
// 向前遇到點號,或向後取消點號
if (val.charAt(val.length - 1) === "." || (input && !val)) {
var arr = input.split(".");
hash = window;
for (var j = 0; j < arr.length; j++) {
var el = arr[j];
if (el && hash[el]) {
hash = hash[el]; // 重新設定要遍歷的物件
}
}
prefix = input == "." ? "" : input;
for (prop in hash){
if (output.push(
'<li><a href="javascript:void(0)" class="search_target" data-value="' + prefix + prop +
'">' + input + "<b>" + (prefix + prop).slice(prefix.length) +
"</b></a></li>"
) == 10) {
break;
}
}
}
$("#suggest_list").html(output.join(""));
if (!input) { // 重置所有狀態
hash = window;
fixIE = prefix = output = [];
}
});
});
這段程式碼的巧妙之處在於:prefix 記住了「點號之前的部分」,hash 記住了「目前遍歷到哪個物件」。使用者輸入 $. 時,程式會把 hash 切換到 window,之後的屬性名都會被加上 $. 的 ]);
/).
前綴再顯示。而 fixIE 則是為了對付 IE 的 propertychange 事件——在 IE 下用程式改寫 input 的值同樣會觸發該事件,若不加攔截,按下上下鍵選項時會引發迴圈。
提示清單出現後,監聽方向鍵讓候選項能上下高亮並填入搜尋框。做法是定義一個外部變數存放高亮項的索引,按下鍵時減一、下鍵時加一,再用索引定位到對應的 a 標籤加上高亮類別,同時移除先前那一項。
//by 司徒正美
$.require("ready,event,attr", function(){
var search = $("#search"), hash = window, prefix = "";
search.input(function(){ /* 監聽輸入,同上 */ });
var glowIndex = -1;
$(document).keyup(function(e){ // 監聽上下鍵
if (/search_target/i.test(e.target.className)) { // 只處理特定元素,提升效能
var upOrdown = 0;
if (e.which === 38 || e.which === 104) { // up
upOrdown--;
} else if (e.which === 40 || e.which === 98) { // down
upOrdown++;
}
if (upOrdown) {
var list = $("#suggest_list a");
list.eq(glowIndex).removeClass("glow_suggest"); // 移轉高亮
glowIndex += upOrdown;
var el = list.eq(glowIndex).addClass("glow_suggest");
fixIE = el.attr("data-value");
search.val(fixIE);
if (glowIndex === list.length - 1) {
glowIndex = -1;
}
}
}
});
});
keyCode 38 與 40 分別對應上下方向鍵,104 與 98 則是數字鍵盤上的 8 與 2(舊式快捷鍵習慣)。用 /search_target/i.test() 先確認事件來源是我們关心的元素,能避免全域監聽帶來的效能浪費。
//by 司徒正美
$.require("ready,event,attr", function(){
var search = $("#search"), hash = window, prefix = "";
search.input(function(){ /* 監聽輸入 */ });
var glowIndex = -1;
$(window).keyup(function(e){ /* 監聽上下鍵 */ });
search.keyup(function(e){ // 監聽提交
var input = this.value;
if (input && (e.which == 13 || e.which == 108)) { // ENTER 鍵
alert(input); // 實際專案中考該做頁面跳轉,導向搜尋結果頁
}
});
});
這裡把提交邏輯獨立寫一個 keyup 純粹為了教學清晰,實作時可以合併成一個監聽器。
至此 suggest 效果就完成了。實際專案中的 suggest 其實更簡單:輸入框內容變化時發一個 AJAX 請求,後端回傳陣列,前端把它拼成 li 格式即可,不需要本地物件遍歷這套邏輯。真正需要花心思的反而是那些容易忽略的細節——鍵盤可操作性、IE 的事件怪癖、以及 a 標籤裡不能有多餘空白這類看似微小的約定。