jQuery自动完成插件Autocomplete使用实例

最新推荐文章于 2024-08-30 13:44:46 发布

weixin_30399155

最新推荐文章于 2024-08-30 13:44:46 发布

阅读量114

点赞数

文章标签： xhtml javascript json ViewUI

原文链接：http://www.cnblogs.com/zhuwenlong/archive/2012/12/05/2803116.html

版权

本文介绍了一个使用 jQuery 实现的自动完成组件 Autocomplete 的实例演示，包括其功能效果、数据源介绍、常用参数说明及 Demo 下载链接。通过配置文本框的自动补全、建议提示等功能，实现类似搜索引擎的智能输入体验。

摘要由CSDN通过智能技术生成

一、Autocomplete实例介绍

jQuery Autocomplete 是流行的实现自动填充功能插件，能够很好的实现输入框的自动完成(autocomplete)、建议提示(input suggest)功能，支持ajax数据加载。

用户在使用文本框搜索信息时，实现类似百度、Google文本输入框自动补全智能提示效果。

Demo功能效果如下：

二、Demo Html代码片段

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>jQuery自动完成组件Autocomplete Demo</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="jquery.autocomplete.js"></script>
<script type="text/javascript" src="localdata.js"></script>
<link rel="stylesheet" type="text/css" href="jquery.autocomplete.css" />
<script type="text/javascript">
    $().ready(function () {
        function log(event, data, formatted) {
            $("#txtSelectName").val(data.name);
            $("#txtSelectValue").val(data.value);
        }

        //objects为json数据源对象
        $("#txtSelectName").autocomplete(objects, {
            minChars: 0, //表示在自动完成激活之前填入的最小字符
            max: 5, //表示列表里的条目数
            autoFill: true, //表示自动填充
            mustMatch: false, //表示必须匹配条目,文本框里输入的内容,必须是data参数里的数据,如果不匹配,文本框就被清空
            matchContains: true, //表示包含匹配,相当于模糊匹配
            scrollHeight: 200, //表示列表显示高度,默认高度为180

            formatItem: function (row) {
                return row.name;
            },
            formatMatch: function (row) {
                return row.name;
            },
            formatResult: function (row) {
                return row.value;
            }
        });

        $(":text, textarea").result(log).next("#txtSelectValue").click(function () {
            $(this).prev().search();
        });
    });
</script>
</head>
<body>
<div id="content">jQuery自动实现<br /><br />名称：<input type="text" id="txtSelectName" /> 值：<input type="text" id="txtSelectValue" /></div>
</body>
</html>

三、数据源介绍

Demo中使用了Json数据源，Autocomplete插件同时也支持js数组和远程数据源。

var objects = [
    { name: "项目一", value: "1" },
    { name: "项目二", value: "2" },
    { name: "项目三", value: "3" },
    { name: "项目四", value: "4" },
    { name: "项目五", value: "5" },
    { name: "项目六", value: "6" },
    { name: "项目七", value: "7" },
    { name: "abc", value: "abc" },
    { name: "abce", value: "abce" },
    { name: "abcef", value: "abcef" },
    { name: "bcd", value: "bcd" },
    { name: "bcdfdsaf", value: "bcd" },
    { name: "bcdfds", value: "bcdfds" },
    { name: "cbd", value: "cbd" },
    { name: "efg", value: "efg" },
    { name: "fgdaf", value: "fgdaf" },
    { name: "fasfs", value: "fasfs" }];

四、常用参数介绍

* 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