天天看點

jquery-autocomplete 使用手冊

jquery-autocomplete學習

一、用前必備

官方網站:

目前版本:1.0.2

需要JQuery版本:1.2.6

二、使用

<script src="./jquery-1.3.2.js" type="text/javascript"></script>

<script src="./jquery.autocomplete.js" type="text/javascript"></script>

<link rel="stylesheet" href="./jquery.autocomplete.css" />

autocomplete( url or data, options ) Returns: jQuery

讓一個input或textarea有autocomplete功能

例子

Js代碼

var data = "Core Selectors Attributes Traversing Manipulation CSS Events Effects Ajax Utilities".split(" ");  

$("#example").autocomplete(data);

以上的例子就是為id為example添加autocomplete

var emails = [

    { name: "Peter Pan", to: "" },

    { name: "Molly", to: "" },

    { name: "Forneria Marconi", to: "" },

    { name: "Master <em>Sync</em>", to: "" },

    { name: "Dr. <strong>Tech</strong> de Log", to: "" },

    { name: "Don Corleone", to: "" },

    { name: "Mc Chick", to: "" },

    { name: "Donnie Darko", to: "" },

    { name: "Quake The Net", to: "" },

    { name: "Dr. Write", to: "" }

];

//emails的數組格式如上,formatItem代表的是顯示的格式,formatMatch表示比對的内容,formatResult表示結果的内容

$("#suggest13").autocomplete(emails, {

    minChars: 0,

    width: 310,

    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;

    }

});

三、參數說明:

* minChars (Number):

    在觸發autoComplete前使用者至少需要輸入的字元數.Default: 1,如果設為0,在輸入框内輕按兩下或者删除輸入框内内容時顯示清單

* width (Number):

    指定下拉框的寬度. Default: input元素的寬度

* max (Number):

    autoComplete下拉顯示項目的個數.Default: 10

* delay (Number):

    擊鍵後激活autoComplete的延遲時間(機關毫秒).Default: 遠端為400 本地10

* autoFill (Boolean):

    要不要在使用者選擇時自動将使用者目前滑鼠所在的值填入到input框. Default: false

* mustMatch (Booolean):

    如果設定為true,autoComplete隻會允許比對的結果出現在輸入框,所有當使用者輸入的是非法字元時将會得不到下拉框.Default: false

* matchContains (Boolean):

    決定比較時是否要在字元串内部檢視比對,如ba是否與foo bar中的ba比對.使用緩存時比較重要.不要和autofill混用.Default: false

* selectFirst (Boolean):

    如果設定成true,在使用者鍵入tab或return鍵時autoComplete下拉清單的第一個值将被自動選擇,盡管它沒被手工選中(用鍵盤或滑鼠).當然如果使用者選中某個項目,那麼就用使用者選中的值. Default: true

* cacheLength (Number):

    緩存的長度.即對從資料庫中取到的結果集要緩存多少條記錄.設成1為不緩存.Default: 10

* matchSubset (Boolean):

    autoComplete可不可以使用對伺服器查詢的緩存,如果緩存對foo的查詢結果,那麼如果使用者輸入foo就不需要再進行檢索了,直接使用緩存.通常是打開這個選項以減輕伺服器的負擔以提高性能.隻會在緩存長度大于1時有效.Default: true

* matchCase (Boolean):

    比較是否開啟大小寫敏感開關.使用緩存時比較重要.如果你了解上一個選項,這個也就不難了解,就好比foot要不要到FOO的緩存中去找.Default: false

* multiple (Boolean):

    是否允許輸入多個值即多次使用autoComplete以輸入多個值. Default: false

* multipleSeparator (String):

    如果是多選時,用來分開各個選擇的字元. Default: ","

* scroll (Boolean):

    當結果集大于預設高度時是否使用卷軸顯示 Default: true

* scrollHeight (Number):

    自動完成提示的卷軸高度用像素大小表示 Default: 180  

* formatItem (Function):

    為每個要顯示的項目使用進階标簽.即對結果中的每一行都會調用這個函數,傳回值将用LI元素包含顯示在下拉清單中. Autocompleter會提供三個參數(row, i, max): 傳回的結果數組, 目前處理的行數(即第幾個項目,是從1開始的自然數), 目前結果數組元素的個數即項目的個數. Default: none, 表示不指定自定義的處理函數,這樣下拉清單中的每一行隻包含一個值.

* formatResult (Function):

    和formatItem類似,但可以将将要輸入到input文本框内的值進行格式化.同樣有三個參數,和formatItem一樣.Default: none,表示要麼是隻有資料,要麼是使用formatItem提供的值.

* formatMatch (Function):

    對每一行資料使用此函數格式化需要查詢的資料格式. 傳回值是給内部搜尋算法使用的. 參數值row

* extraParams (Object):

    為背景(一般是服務端的腳本)提供更多的參數.和通常的作法一樣是使用一個鍵值對對象.如果傳過去的值是{ bar:4 },将會被autocompleter解析成my_autocomplete_backend.php?q=foo&bar=4 (假設目前使用者輸入了foo). Default: {}

* result (handler) Returns: jQuery

    此事件會在使用者選中某一項後觸發,參數為:

    event: 事件對象. event.type為result.

    data: 選中的資料行.

    formatted:formatResult函數傳回的值

    例如:

    $("#singleBirdRemote").result(function(event, data, formatted) {

//如選擇後給其他控件指派,觸發别的事件等等

四、注意問題:

1.網上有人說對中文的檢索時處理有問題,經過測試此版本沒有問題^-^

2.在使用遠端位址時,它預設傳入的參數是:q(輸入值),limit(傳回結果的最大值),可以使用extraParams傳入其他的參數

3.autocomplete在使用ajax傳遞參數時,預設使用了get方式傳遞,也實在是沒有找到可以通過參數送出post方式的辦法。

解決方式1:在使用ajax的get方式傳遞中文時,使用new String(request.getParameter("q").getBytes("iso8859-1"),"utf-8")獲得參數值

解決方式2:修改jquery.autocomplete.js代碼,把get方式修改為post方式,然後參見之前ajax解決中文亂碼的問題的