`

jQuery UI Autocomplete 详解

 
阅读更多
jQuery UI Autocomplete是jQuery UI的自动完成组件,是我用过的最强大、最灵活的Autocomplete,
它支持本地的Array/JSON数组、通过ajax请求的Array/JSON数组、JSONP、以及Function(最灵活)等方式来获取数据。
支持的数据源
jQuery UI Autocomplete主要支持字符串Array、JSON两种数据格式。
普通的Array格式没有什么特殊的,如下:
  ["cnblogs","博客园","囧月"]
对于JSON格式的Array,则要求有:label、value属性,如下:
  [{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}]
其中label属性用于显示在autocomplete弹出菜单,而value属性则是选中后给文本框赋的值。
如果没有指定其中一个属性则用另一个属性替代(即value和label值一样),如下:
  [{label: "cnblogs"}, {label: "囧月"}]
   [{value: "cnblogs"}, {value: "囧月"}]
如果label和value都没有指定,则无法用于autocomplete的提示。
另外需要注意,对于从服务器端输出的JSON的key必须用双引号,如下:
  [{"label": "博客园", "value": "cnblogs"}, {"label": "囧月", "value": "囧月"}]
否则可能会出现parsererror错误。
主要的参数

jQuery UI Autocomplete常用的参数有:
Source:用于指定数据来源,类型为String、Array、Function
             String:用于ajax请求的服务器端地址,返回Array/JSON格式
             Array:即字符串数组 或 JSON数组
             Function(request, response):通过request.term获得输入的值,
                   response([Array])来呈现数据;(JSONP是这种方式)
minLength:当输入框内字符串长度达到minLength时,激活Autocomplete
autoFocus:当Autocomplete选择菜单弹出时,自动选中第一个
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\":\"cnblogs\"},{\"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", 
             "cnblogs.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有一些事件,可用于在一些阶段进行额外的控制:
        create(event, ui):Autocomplete创建时,可以在此事件中,对外观进行一些控制
         search(event, ui): 在开始请求之前,可以在此事件中返回false来取消请求
         open(event, ui):Autocomplete的结果列表弹出时
         focus(event, ui):Autocomplete的结果列表任意一项获得焦点时,ui.item为获得焦点的项
         select(event, ui):Autocomplete的结果列表任意一项选中时,ui.item为选中的项
         close(event, ui):Autocomplete的结果列表关闭时
         change(event, ui):当值改变时,ui.item为选中的项
这些事件的ui参数的item属性(如果有的话)默认有label和value属性,不管在source中设置的数据是Array还是JSON数组,如下3种:
        ["cnblogs","博客园","囧月"]
        [{label: "博客园", value: "cnblogs"}, {label: "囧月", value: "囧月"}]
        [{label: "博客园", value: "cnblogs", 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),则需要绑定一些事件来进行额外处理:
在focus事件中返回false,避免输入框的值被autocomplete的单个值取代
在select事件中组合多个值
在元素的keydown事件做一些处理,理由同1
使用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);
        }
    }));
  

<!doctype html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>autocomplete demo</title>
    <link rel="stylesheet" href="http://code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css">
    <script src="http://code.jquery.com/jquery-1.8.3.js"></script>
    <script src="http://code.jquery.com/ui/1.9.2/jquery-ui.js"></script>
</head>
<body>
 
<label for="autocomplete">Select a programming language: </label>
<input id="autocomplete">
 
<script>
var tags = [ "c++", "java", "php", "coldfusion", "javascript", "asp", "ruby" ];
$( "#autocomplete" ).autocomplete({
    source: function( request, response ) {
            var matcher = new RegExp( "^" + $.ui.autocomplete.escapeRegex( request.term ), "i" );
            response( $.grep( tags, function( item ){
                return matcher.test( item );
            }) );
        }
});
</script>
 
</body>
</html>
 


分享到:
评论

相关推荐

    jquery ui autocomplete

    在lwme-jqueryui-demo中,我们可以找到一个简单的jQuery UI Autocomplete的演示项目。这个项目展示了如何利用Autocomplete实现一个基本的搜索功能,用户在输入框中输入关键字,系统会从预设的词汇列表中匹配并显示...

    jQuery-autoComplete-1.8.22代码例子

    《jQuery-autoComplete-1.8.22代码详解与应用》 jQuery-autoComplete是一款非常实用的前端插件,主要用于实现输入框的自动补全功能,它极大地提升了用户体验,尤其是在处理大量数据时,使得用户能够快速找到所需...

    JQuery UI之Autocomplete使用详解

    JQuery UI之Autocomplete使用详解

    jquery-autocomplete 自动填充插件参数使用说明

    《jQuery Autocomplete 插件参数使用详解》 在Web开发中,为了提升用户体验,自动填充(Autocomplete)功能被广泛应用于搜索框、表单输入等场景。jQuery库提供了一个强大的Autocomplete插件,名为jQuery UI ...

    jquery.autocomplete.js使用示例,可直接运行

    **jQuery Autocomplete.js 插件使用详解** jQuery Autocomplete.js 是一个非常实用的插件,它为HTML输入框提供了自动补全功能,极大地提升了用户体验。这个插件基于jQuery库,结合Ajax技术,能够实时从服务器获取...

    jquery.autocomplete.zip

    《jQuery.autocomplete自动提示插件详解》 在Web开发中,提供用户友好的输入提示功能是一种常见的需求,例如搜索引擎的自动补全、电子商务网站的商品搜索等。jQuery库为我们提供了丰富的插件来实现这一功能,其中`...

    jquery.autocomplete.js&css.rar

    《jQuery Autocomplete插件详解与应用实践》 在Web开发中,提高用户体验是至关重要的,而自动完成(Autocomplete)功能则是实现这一目标的有效手段之一。jQuery库中的Autocomplete插件,通过简单易用的API,帮助...

    JQuery UI 中文帮助文档

    **jQuery UI 中文帮助文档详解** jQuery UI 是一个基于 jQuery JavaScript 库的开源项目,它提供了丰富的用户界面组件,使得开发者能够轻松创建交互性强、视觉效果美观的网页应用。这个中文帮助文档是针对jQuery UI...

    jquery.autocomplete

    **jQuery Autocomplete 知识点详解** `jQuery Autocomplete` 是一个非常流行的 jQuery 插件,它为输入框提供了一个动态下拉建议的功能,让用户在输入时能够快速找到并选择匹配项。这个插件极大地提升了用户界面的...

    jQuery UI组件 jQuery UI

    **jQuery UI组件详解** jQuery UI 是一个强大的前端开发框架,基于流行的JavaScript库jQuery构建,它提供了丰富的用户界面组件,能够帮助开发者快速构建交互性、视觉吸引力强的网页应用。jQuery UI 包含了大量的...

    jquery.autocomplete js包

    **jQuery Autocomplete 知识点详解** `jQuery Autocomplete` 是一个非常流行的 jQuery 插件,主要用于实现输入框的自动补全功能。它为用户提供了一种便捷的方式,根据用户输入的部分字符快速匹配并显示相关数据,...

    jQuery-Autocomplete-exaples.rar

    **jQuery Autocomplete 插件详解** jQuery Autocomplete 是一个非常流行的 jQuery 插件,它为文本输入框提供了自动补全功能,极大地提升了用户体验。在 Web 应用中,尤其是在需要用户输入搜索关键词或选择特定项时...

    jquery自动补全插件(jquery autocomplete)

    **jQuery AutoComplete 插件详解** jQuery AutoComplete 是一个非常流行的前端插件,它为输入框提供了自动补全的功能,极大地提升了用户在网页上的输入体验。这个插件基于 jQuery 库,因此,使用前需要先引入 ...

    jquery autocomplete

    **jQuery Autocomplete 知识详解** jQuery Autocomplete 是一个非常流行的 jQuery 插件,它为输入框提供了自动补全的功能,极大地提升了用户在网站上的交互体验。这个插件源自于 jQuery UI 库,但也可以单独使用。...

    jquery-autocomplete 自动完成

    **jQuery Autocomplete 插件详解** jQuery Autocomplete 是一个非常流行的前端开发插件,它为输入框提供了自动完成的功能,极大地提升了用户在网页上的交互体验。这个插件基于JavaScript库jQuery构建,允许开发者...

    jQuery UI AutoComplete 自动完成使用小记

    《jQuery UI AutoComplete 自动完成功能详解》 jQuery UI 的 AutoComplete 是一个强大的插件,它为输入框提供了自动补全的功能,适用于各种需要实时搜索建议的场景,如搜索引擎、表单填充等。本篇文章将深入探讨...

    jquery插件-autocomplete

    **jQuery Autocomplete插件详解** 在前端开发中,jQuery库为我们提供了丰富的功能和简便的API,使得网页交互变得更加便捷。而jQuery Autocomplete插件则是一个非常实用的工具,它能够帮助用户在输入框中实现自动...

    jquery autocomplete js 文件

    **jQuery Autocomplete 知识点详解** jQuery Autocomplete 是一个非常流行且实用的插件,它为HTML输入字段提供自动完成功能。这个插件基于 jQuery 库,使得在网页中实现类似百度搜索框那样的动态下拉建议变得简单易...

    JQUERY UI 开发指南源码

    **jQuery UI 开发指南源码详解** jQuery UI 是一个基于 jQuery JavaScript 库的用户界面插件集合,提供了丰富的交互效果、可自定义的主题以及多种组件,如对话框、拖放功能、日期选择器等。本资源是《jQuery UI ...

    jqueryui需的jar包

    **jQuery UI 知识点详解** jQuery UI 是一个基于 jQuery JavaScript 库的用户界面插件集合,它提供了丰富的交互效果、可自定义的主题以及多种组件,使得开发者能够更轻松地创建具有吸引力和交互性的Web应用。这个...

Global site tag (gtag.js) - Google Analytics