首頁 > 文章 > web前端 > jQuery Autocomplete實例簡介

jQuery Autocomplete實例簡介

小云云原創: 2018-01-01 10:27:233350瀏覽

本文主要介紹了jQuery Autocomplete簡介，jQuery UI Autocomplete是jQuery UI的自動完成元件，是我用過的最強大、最靈活的Autocomplete，它支援本地的Array/JSON陣列、透過ajax請求的Array /JSON數組、JSONP、以及Function(最靈活)等方式來取得資料。

jQuery UI Autocomplete是jQuery UI的自動完成元件，是我用過的最強大、最靈活的Autocomplete，它支援本地的Array/JSON陣列、透過ajax請求的Array/JSON陣列、JSONP 、以及Function(最靈活)等方式來取得資料。

支援的資料來源

jQuery UI Autocomplete主要支援字串Array、JSON兩種資料格式。

普通的Array格式沒有什麼特殊的，如下：

["bjpowernode","动力节点","李四"]

對於JSON格式的Array，則要求有：label、value屬性，如下：

[{label: "动力节点", value: "bjpowernode"}, {label: "李四", value: "李四"}]

其中label屬性用於顯示在autocomplete彈出選單，而value屬性則是選取後給文字方塊賦的值。

如果沒有指定其中一個屬性則用另一個屬性取代(即value和label值一樣)，如下：

[{label: "bjpowernode"}, {label: "李四"}]
[{value: "bjpowernode"}, {value: "李四"}]

如果label和value都沒有指定，則無法用於autocomplete的提示。

另外要注意，對於從伺服器端輸出的JSON的key必須用雙引號，如下：

[{"label": "动力节点", "value": "bjpowernode"}, {"label": "李四", "value": "李四"}]

否則可能會出現parsererror錯誤。

主要的參數

jQuery UI Autocomplete常用的參數有：

1.Source：用於指定資料來源，類型為String、Array、Function

String：用於ajax請求的伺服器端位址，回傳Array/JSON格式
Array：即字串數組或JSON數組
Function(request, response)：透過request.term獲得輸入的值，response([Array])來呈現資料；(JSONP是這種方式)

2.minLength：當輸入框內字串長度達到minLength時，啟動Autocomplete

3.autoFocus：當Autocomplete選擇選單彈出時，自動選中第一

4.delay：也就是延遲多少毫秒啟動Autocomplete

其他不常用的就不羅列了。

使用方法

假如頁面上有以下輸入框：

<input type="text" id="autocomp" />

AJAX請求
透過指定source為伺服器端的位址來實現，如下：

$("#autocomp").autocomplete({
  source: "remote.ashx",
  minLength: 2
});

然後在伺服器端接收，並輸出對應結果，注意預設傳遞的參數名稱為term：

public void ProcessRequest(HttpContext context) {   
// 查询的参数名称默认为term   
string query = context.Request.QueryString["term"];   
context.Response.ContentType = "text/javascript";   
//输出字符串数组 或者 JSON 数组   
context.Response.Write("[{\"label\":\"动力节点\",\"value\":\"bjpowernode\"},{\"label\":\"李四\",\"value\":\"李四\"}]"); }

本地Array/JSON數組

// 本地字符串数组
var availableTags = [
  "C#",
  "C++",
  "Java",
  "JavaScript",
  "ASP",
  "ASP.NET",
  "JSP",
  "PHP",
  "Python",
  "Ruby"
];
$("#local1").autocomplete({
  source: availableTags
});
// 本地json数组
var availableTagsJSON = [
  { label: "C# Language", value: "C#" },
  { label: "C++ Language", value: "C++" },
  { label: "Java Language", value: "Java" },
  { label: "JavaScript Language", value: "JavaScript" },
  { label: "ASP.NET", value: "ASP.NET" },
  { label: "JSP", value: "JSP" },
  { label: "PHP", value: "PHP" },
  { label: "Python", value: "Python" },
  { label: "Ruby", value: "Ruby" }
];
$("#local2").autocomplete({
  source: availableTagsJSON
});

Callback Function方式

透過指定source為自訂函數來實現自訂資料的獲取，函數主要有2個參數(request,response)，分別用於取得輸入的值、呈現結果

本地Array方式取得資料（模仿新浪微博的登入）

var hosts = ["gmail.com", "live.com", "hotmail.com", "yahoo.com", "bjpowernode.com", "火星.com", "李四.com"];
$("#email1").autocomplete({
  autoFocus: true,
  source: function(request, response) {
    var term = request.term, //request.term为输入的字符串
      ix = term.indexOf("@"),
      name = term, // 用户名
      host = "", // 域名
      result = []; // 结果
 
    result.push(term);
    // result.push({ label: term, value: term }); // json格式
    if (ix > -1) {
      name = term.slice(0, ix);
      host = term.slice(ix + 1);
    }
    if (name) {
      var findedHosts = (host ? $.grep(hosts, function(value) {
        return value.indexOf(host) > -1;
      }) : hosts),
      findedResults = $.map(findedHosts, function(value) {
        return name + "@" + value; //返回字符串格式
        // return { label: name + " @ " + value, value: name + "@" + value }; // json格式
      });
      result = result.concat($.makeArray(findedResults));
    }
    response(result);//呈现结果
  }
});

JSONP方式取得資料

#直接從官方DEMO拿來的，透過發送ajax請求到遠端伺服器，然後對返回結果進行處理，最後透過response來呈現：

$("#jsonp").autocomplete({
  source: function(request, response) {
    $.ajax({
      url: "http://ws.geonames.org/searchJSON",
      dataType: "jsonp",
      data: {
        featureClass: "P",
        style: "full",
        maxRows: 12,
        name_startsWith: request.term
      },
      success: function(data) {
        response($.map(data.geonames, function(item) {
          return {
            label: item.name + (item.adminName1 ? ", " + item.adminName1 : "") + ", " + item.countryName,
            value: item.name
          }
        }));
      }
    });
  },
  minLength: 2
});

主要的事件

jQuery UI Autocomplete有一些事件，可用來在一些階段進行額外的控制：

1.create(event, ui)：Autocomplete建立時，可以在此事件中，對外觀進行一些控制

2.search(event, ui)：在開始請求之前，可以在此事件中傳回false來取消請求

3.open (event, ui)：Autocomplete的結果清單彈出時

4.focus(event, ui)：Autocomplete的結果清單任意一項獲得焦點時，ui.item為獲得焦點的項

5.select(event, ui)：Autocomplete的結果清單任一項選取時，ui.item為選取的項目

6.close(event, ui )：Autocomplete的結果清單關閉時

7.change(event, ui)：當值改變時，ui.item為選取的項目

這些事件的ui參數的item屬性（如果有的話）預設有label和value屬性，不管在source中設定的資料是Array還是JSON數組，如下3種：

["bjpowernode","动力节点","李四"]
[{label: "动力节点", value: "bjpowernode"}, {label: "李四", value: "李四"}]
[{label: "动力节点", value: "bjpowernode", id: "1"}, {label: "李四", value: "李四", id: "2"}]

假如是第三種的話，還可以得到ui.item.id的值。

這些事件可以透過2種方式來綁定，如下：

// 在参数中
$("#autocomp").autocomplete({
  source: availableTags
  , select: function(e, ui) {
   alert(ui.item.value) 
  }
});
 
// 通过bind来绑定
$("#autocomp").bind("autocompleteselect", function(e, ui) {
  alert(ui.item.value);
});

透過bind來綁定的方式使用的事件名稱為"autocomplete"+事件名稱，如"select"就是"autocompleteselect"。

多個值的Autocomplete

一般情況下，輸入框的autocomplete只需要一個值就可以(如：javascript)；假如需要多個值(如：javascript,c#,asp.net)，則需要綁定一些事件來進行額外處理：

1.在focus事件中返回false，避免輸入框的值被autocomplete的單一值取代

2.在select事件中組合多個值

3.在元素的keydown事件做一些處理，理由同1

4.使用callback function方式的source，來取得最後輸入的值，並呈現結果

#還是直接拿官方DEMO的程式碼：

// 按逗号分隔多个值
function split(val) {
  return val.split(/,\s*/);
}
// 提取输入的最后一个值
function extractLast(term) {
  return split(term).pop();
}
// 按Tab键时，取消为输入框设置value
function keyDown(event) {
  if (event.keyCode === $.ui.keyCode.TAB &&
      $(this).data("autocomplete").menu.active) {
    event.preventDefault();
  }
}
var options = {
  // 获得焦点
  focus: function() {
    // prevent value inserted on focus
    return false;
  },
  // 从autocomplete弹出菜单选择一个值时，加到输入框最后，并以逗号分隔
  select: function(event, ui) {
    var terms = split(this.value);
    // remove the current input
    terms.pop();
    // add the selected item
    terms.push(ui.item.value);
    // add placeholder to get the comma-and-space at the end
    terms.push("");
    this.value = terms.join(", ");
    return false;
  }
};
// 多个值，本地数组
$("#local3").bind("keydown", keyDown)
  .autocomplete($.extend(options, {
    minLength: 2,
    source: function(request, response) {
      // delegate back to autocomplete, but extract the last term
      response($.ui.autocomplete.filter(
        availableTags, extractLast(request.term)));
    }
  }));
// 多个值，ajax返回json
$("#ajax3").bind("keydown", keyDown)
  .autocomplete($.extend(options, {
    minLength: 2,
    source: function(request, response) {
      $.getJSON("remoteJSON.ashx", {
        term: extractLast(request.term)
      }, response);
    }
  }));

jQuery Autocomplete實例簡介

相關文章