DIV CSS 佈局教程網

輸入即提示的自動完成功能:suggestion.js 使用說明文件範例
編輯:關於JavaScript     

下面這份 readme 示範了怎麼把一個共用外掛的使用方式寫清楚,內容同時涵蓋「怎麼用」與「讀原始碼前該具備哪些基礎知識」兩個層次,很適合作為團隊內部文件的參考模板。

readme:

本文件記錄 suggestion.js 的功能使用說明:

複製代碼 代碼如下:

/*
* 功能:該js文件中的代碼實現了[輸入自動搜索提示]功能,如百度、google搜索框中輸入一些字符會以下拉列表形式給出一些提示,提高了用戶體驗;
* 使用技術:JQuery+Ajax
*
* 一、如何使用該功能?
* 1.使用該功能時需引入以下文件:
* 1)<link type="text/css" rel="stylesheet" href="<%=baseURL %>/appName/css/common/suggestion.css"/>
* 2)<script type="text/javascript" src="<%=baseURL %>/appName/js/common/jquery-1.9.1.js"></script>
* 3)<script type="text/javascript" src="<%=baseURL %>/appName/js/common/suggestion.js"></script>
* 2.需要在頁面中添加標簽如下所示:
* <input type="text" id="keywords_input" autocomplete="off" searchURL="<%=baseURL%>/appName/sug/getSug.spring">
* <div id="sug_layer_div"></div>
*
* 說明:
* 1).在使用該功能的頁面引入該文件,同時該功能使用了jQuery技術,依賴於jQuery文件,要在引入suggestion.js之前引入jQuery文件;
* 2).這裡假定你需要使用該功能的文本輸入框為:<input type="text">;
* 3).為該input標簽指定id為'keywords_input',如<input type="text" id="keywords_input">;
* 4).為該input標簽指定autocomplete為'off',如<input type="text" autocomplete="off">;
* 5).為該input標簽添加自定義屬性searchURL,該屬性的值為需要調用控制器方法的URL,如需要調用sugController控制器的getSug方法來返回搜索提示數據,則
* <input type="text" searchURL="<%=baseURL%>/appName/sug/getSug.spring">
* (這裡使用Spring MVC框架);
* 6).在input標簽下面加一個id為'sug_layer_div'的DIV標簽,如<div id="sug_layer_div"></div>
*
* 3.請求-響應數據格式說明:(json數據格式)
* 1)前端示例:
$.ajax({
type:"GET", //AJAX提交方式為GET提交
dataType:"json",
url:$("#keywords_input").attr("searchURL"),//處理頁面的URL地址
data:{ //要傳遞的參數
"keywords_input":escape($("#keywords_input").val())
},
success:function(data) {
var result = data.sugList;//前端需要的數據
......
}
});
* 2)後台示例:
@Controller
@RequestMapping("/el/sug")
@SuppressWarnings({"rawtypes","unchecked"})
public class SugController extends ElBaseController{
@RequestMapping("getSug")
public void getSuggestion (HttpServletRequest request ,HttpServletResponse response)throws JSONException {
log.info("<------獲取搜索提示數據---SugController.getSuggestion--------->");
JSONObject json = new JSONObject();
String errMsg = "";
List sugList = new LinkedList();
try {
String keyword = request.getParameter("keywords_input");//前端傳來的數據(輸入框中的數據)
sugList = SugService.getSuggestionList(keyword);
}catch (Exception e) {
errMsg = "獲取數據時出現異常,"+e.getMessage();
json.put("codeid","FAILURE");
}
json.put("sugList",sugList);//要響應前端的數據
ajaxResultText(response,json.toString());
}
}
*
* 二、如何了解該功能的實現?
* 閱讀本文件的代碼,你應了解以下一些基礎知識:
* 1.keyUp,keyDown等事件中一些鍵碼對:
* 按鍵 鍵碼 | 按鍵 鍵碼 | 按鍵鍵碼
* 0 48 | 9 57 | 0(數字鍵盤)96
* A 65 | Z 90 | 9(數字鍵盤)105
* BackSpace 8 | Up-Arrow 38 | Dw-Arrow 40
*
* 2.JavaScript escape()函數
* escape()函數可對字符串進行編碼,這樣就可以在所有的計算機上讀取該字符串
* 該方法不會對 ASCII字母和數字進行編碼,也不會對下面這些 ASCII標點符號進行編碼: * @ - _ + . / 。
* 其他所有的字符都會被轉義序列替換。如:escape("?!=()#%&") --> %3F%21%3D%28%29%23%25%26
*
* 3.autocomplete屬性規定輸入字段是否應該啟用自動完成功能。
* 自動完成允許浏覽器預測對字段的輸入。
* 當用戶在字段開始鍵入時,浏覽器基於之前鍵入過的值,應該顯示出在字段中填寫的選項。把該autocomplete屬性值設為'off',
* 就是要關閉浏覽器自帶的輸入提示功能
* 註釋:autocomplete屬性適用於<form>,以及下面的<input>類型:text, search, url, telephone, email, password, datepickers, range以及 color。
*
* Author:sunfei(孫飛) Date:2013.08.21
*/

這份文件之所以值得參考,是因為它不只列出步驟,還把「為什麼要設 autocomplete="off"」、「為什麼 jQuery 必須先引入」這類容易踩雷的細節寫在旁邊;最後那段鍵碼表與 escape 說明,則讓接手的人不必重新查一遍基礎知識就能讀懂主程式。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved