在許多帶搜索功能的網站裡,都會有一個「自動完成」的搜索框:當你輸入關鍵詞時,它會即時下拉提示相關的搜索詞,幫助用戶更快找到想要的結果。這種交互非常友善,值得採用。本文分上下兩篇來實現它,本篇先講客戶端。
實現這個功能需要服務端配合:客戶端透過腳本展示從服務端取得的數據。先看客戶端的 HTML:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>搜索詞自動完成</title> <style type="text/css"> #search{ text-align: center; position:relative; } .autocomplete{ border: 1px solid #9ACCFB; background-color: white; text-align: left; } .autocomplete li{ list-style-type: none; } .clickable { cursor: default; } .highlight { background-color: #9ACCFB; } </style> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript"> $(function(){ //取得div層 var $search = $('#search'); //取得輸入框JQuery對象 var $searchInput = $search.find('#search-text'); //關閉浏覽器提供給輸入框的自動完成 $searchInput.attr('autocomplete','off'); //創建自動完成的下拉列表,用於顯示服務器返回的數據,插入在搜索按鈕的後面,等顯示的時候再調整位置 var $autocomplete = $('<div class="autocomplete"></div>') .hide() .insertAfter('#submit'); //清空下拉列表的內容並且隱藏下拉列表區 var clear = function(){ $autocomplete.empty().hide(); }; //注冊事件,當輸入框失去焦點的時候清空下拉列表並隱藏 $searchInput.blur(function(){ setTimeout(clear,500); }); //下拉列表中高亮的項目的索引,當顯示下拉列表項的時候,移動鼠標或者鍵盤的上下鍵就會移動高亮的項目,想百度搜索那樣 var selectedItem = null; //timeout的ID var timeoutid = null; //設置下拉項的高亮背景 var setSelectedItem = function(item){ //更新索引變量 selectedItem = item ; //按上下鍵是循環顯示的,小於0就置成最大的值,大於最大值就置成0 if(selectedItem < 0){ selectedItem = $autocomplete.find('li').length - 1; } else if(selectedItem > $autocomplete.find('li').length-1 ) { selectedItem = 0; } //首先移除其他列表項的高亮背景,然後再高亮當前索引的背景 $autocomplete.find('li').removeClass('highlight') .eq(selectedItem).addClass('highlight'); }; var ajax_request = function(){ //ajax服務端通信 $.ajax({ 'url':'/test/index.jsp', //服務器的地址 'data':{'search-text':$searchInput.val()}, //參數 'dataType':'json', //返回數據類型 'type':'POST', //請求類型 'success':function(data){ if(data.length) { //遍歷data,添加到自動完成區 $.each(data, function(index,term) { //創建li標簽,添加到下拉列表中 $('<li></li>').text(term).appendTo($autocomplete) .addClass('clickable') .hover(function(){ //下拉列表每一項的事件,鼠標移進去的操作 $(this).siblings().removeClass('highlight'); $(this).addClass('highlight'); selectedItem = index; },function(){ //下拉列表每一項的事件,鼠標離開的操作 $(this).removeClass('highlight'); //當鼠標離開時索引置-1,當作標記 selectedItem = -1; }) .click(function(){ //鼠標單擊下拉列表的這一項的話,就將這一項的值添加到輸入框中 $searchInput.val(term); //清空並隱藏下拉列表 $autocomplete.empty().hide(); }); });//事件注冊完畢 //設置下拉列表的位置,然後顯示下拉列表 var ypos = $searchInput.position().top; var xpos = $searchInput.position().left; $autocomplete.css('width',$searchInput.css('width')); $autocomplete.css({'position':'relative','left':xpos + "px",'top':ypos +"px"}); setSelectedItem(0); //顯示下拉列表 $autocomplete.show(); } } }); }; //對輸入框進行事件注冊 $searchInput .keyup(function(event) { //字母數字,退格,空格 if(event.keyCode > 40 || event.keyCode == 8 || event.keyCode ==32) { //首先刪除下拉列表中的信息 $autocomplete.empty().hide(); clearTimeout(timeoutid); timeoutid = setTimeout(ajax_request,100); } else if(event.keyCode == 38){ //上 //selectedItem = -1 代表鼠標離開 if(selectedItem == -1){ setSelectedItem($autocomplete.find('li').length-1); } else { //索引減1 setSelectedItem(selectedItem - 1); } event.preventDefault(); } else if(event.keyCode == 40) { //下 //selectedItem = -1 代表鼠標離開 if(selectedItem == -1){ setSelectedItem(0); } else { //索引加1 setSelectedItem(selectedItem + 1); } event.preventDefault(); } }) .keypress(function(event){ //enter鍵 if(event.keyCode == 13) { //列表為空或者鼠標離開導致當前沒有索引值 if($autocomplete.find('li').length == 0 || selectedItem == -1) { return; } $searchInput.val($autocomplete.find('li').eq(selectedItem).text()); $autocomplete.empty().hide(); event.preventDefault(); } }) .keydown(function(event){ //esc鍵 if(event.keyCode == 27 ) { $autocomplete.empty().hide(); event.preventDefault(); } }); //注冊窗口大小改變的事件,重新調整下拉列表的位置 $(window).resize(function() { var ypos = $searchInput.position().top; var xpos = $searchInput.position().left; $autocomplete.css('width',$searchInput.css('width')); $autocomplete.css({'position':'relative','left':xpos + "px",'top':ypos +"px"}); }); }); </script> </head> <body> <div id = "search"> <label for="search-text">請輸入關鍵詞</label><input type="text" id="search-text" name="search-text" /> <input type="button" id="submit" value="搜索"/> </div> </body> </html>
服務端這裡用 JSP 示範(也可以用 PHP,關鍵是回傳數據):
<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%> <% String []words = {"amani","abc","apple","abstract","an","bike","byebye", "beat","be","bing","come","cup","class","calendar","china"}; if(request.getParameter("search-text") != null) { String key = request.getParameter("search-text"); if(key.length() != 0){ String json="["; for(int i = 0; i < words.length; i++) { if(words[i].startsWith(key)){ json += "\""+ words[i] + "\"" + ","; } } json = json.substring(0,json.length()-1>0?json.length()-1:1); json += "]"; System.out.println("json:" + json); out.println(json); } } %>
整個思路其實相當清晰。首先在輸入框上綁定 keyup 事件,在事件中透過 Ajax 向服務端請求 JSON 數據;拿到數據後,為每一項創建一個 li 標籤,並在其上綁定 click 事件,這樣點擊任意一項就能把該詞填回輸入框。鍵盤導航的關鍵是記錄當前高亮的索引值 selectedItem,透過上下鍵改變索引、相應調整背景高亮,並做到循環選擇。此外,程式碼還用一個 100 毫秒的 setTimeout 做「防抖」處理,避免用戶快速輸入時頻繁發請求。
下拉列表的位置會根據輸入框的位置動態設置,並在瀏覽器視窗 resize 時重新校正,確保提示框始終緊貼輸入框。以上就是客戶端與服務端配合實現搜索框自動完成的核心代碼,希望對大家有所幫助,下篇我們再來探討更進一步的優化。