Suggest Framework 顧名思義,是一個仿 Google Suggest 的小框架,用來替輸入框加上提示功能。你可以在自己的網站上很輕鬆地做出「打字時下方浮出候選字」的效果,這對搜尋效率與使用者體驗都有明顯幫助。同一個頁面可以有複數個搜尋框,各自獨立設定;框架本身沒有瀏覽器限制,基本相容絕大多數瀏覽器,包括 Internet Explorer 5+(Win/Mac)、Firefox(Win/Mac)、Opera 8+ 等。
把 SuggestFramework.js 複製到伺服器,然後自己寫一份提示效果的 CSS,套用進每一個頁面即可。壓縮版已通過 Dojo ShrinkSafe 處理(https://alex.dojotoolkit.org/shrinksafe/),體積很小。
在網頁的 head 區加入兩行:
<script type="text/javascript" src="/path/to/SuggestFramework.js"></script> <script type="text/javascript">window.onload = initializeSuggestFramework;</script>
這兩行加完之後,每個有 name 屬性的文字框會多出五個可設定的屬性:
框架只送兩個參數:type(輸入框的 name)與 q(搜尋關鍵字,預設 UTF-8 編碼)。後端輸出則是一行 JavaScript 敘述。
一維陣列:
new Array("val1", "val2", "val3");
二維陣列:
new Array(
new Array("第1列第1欄", "第1列第2欄"),
new Array("第2列第1欄", "第2列第2欄"),
new Array("第3列第1欄", "第3列第2欄")
);
官方壓縮檔內附 PHP 與 ColdFusion 範例,但這個格式與平台無關,任何語言都能產生。
.SuggestFramework_List:提示內容所在的整體區域.SuggestFramework_Heading:第一筆提示(標題列).SuggestFramework_Highlighted:目前被選取、高亮的那一筆.SuggestFramework_Normal:其餘一般提示這類問題幾乎都是編碼不一致造成的,三步驟檢查:
<%@LANGUAGE="VBSCRIPT" CODEPAGE="936"%> 指令。三個地方(檔案編碼、頁面宣告、資料實際編碼)必須一致,缺一就會亂碼。這條規則不限於本框架,任何 Ajax 專案都適用。
這個框架屬於「後端輸出可執行 JavaScript」的年代產物。今天若自建類似功能,後端請輸出 JSON 而非 Array 敘述,前端用 JSON.parse 解析——同樣的效果,但不必把伺服器輸出當程式碼執行,安全性完全不同。