jQuery.Autocomplete输入提示/自动完成插件

最近在做一个项目，查询功能下拉列表太长，考虑到方便用户，需要有自动提示完成选择下拉列表的功能。网上的插件有几种，个人觉得bassistance.de的JQuery Autocomplete plugin比较强大，比较轻便，功能也不错。只可惜发现现在插件已经停止更新，并且该插件功能已经并入jQuery UI，http://jqueryui.com/autocomplete/

目前网上流传的大部分是v1.1版本的介绍文章，Jquery autocomplete是一个很强大的类似google suggest的自动提示插件。它几乎可以满足我们所有的需要。

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

一、JQuery Autocomplete plugin的语法

本文使用的版本：1.1

需要JQuery版本：1.2.6+

首先是最重要的方法

autocomplete( url or data, [options] )

第一个参数可以是数组或者url。options可选项，参数比较复杂：

* 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) {

//如选择后给其他控件赋值，触发别的事件等等

});

后面3个参数formatItem、formatMatch、formatResult非常有用，formatItem作用在于可以格式化列表中的条目，比如我们加了“I”，让列表里的字显示出了斜体，formatMatch是配合formatItem使用，作用在于，由于使用了formatItem，所以条目中的内容有所改变，而我们要匹配的是原始的数据，所以用formatMatch做一个调整，使之匹配原始数据，formatResult是定义最终返回的数据，比如我们还是要返回原始数据，而不是formatItem过的数据。

二、本地数据调用显示方式

<script type="text/javascript">
var websites = [
	"Google","NetEase", "Sohu", "Sina", "Sogou", "Baidu", "Tencent",
	"Taobao", "Tom", "Yahoo", "JavaEye", "Csdn", "Alipay"
];
$().ready(function() {
	$("#website").autocomplete(websites);
});
</script>

对应html页面：

<p>
<label>Web Site:</label>
<input type="text" id="website" />
<input type="button" id="getvalue" value="Get Value" />
</p>
<div id="content"></div>

以上写法可以改写为更复杂效果更丰富的写法：

$().ready(function() {
	$("#website").autocomplete(websites,{
		minChars: 0,
		max: 5,
		autoFill: true,
		mustMatch: true,
		matchContains: true,
		scrollHeight: 220,
		formatItem: function(data, i, total) {
			return "<I>"+data[0]+"</I>";
		},
		formatMatch: function(data, i, total) {
			return data[0];
		},
		formatResult: function(data) {
			return data[0];
		}
	});
});

三、调用服务器端json数据

php生成json数据的代码：

<?php
class pmc_try
{
	public $_GP;
	function __construct()
	{
		$this->_GP = array_merge($_GET,$_POST);
		pm_tpl::assign('lang',$this->lang());
	}
	public function diy(){
		 pm_tpl::display("demo_autocomplete");
	
	}
	public function ajax_diy(){
		$forums = mod_forum::get_ajx_forum_by_tpid(400);
		$output = json_encode($forums);
		echo $output;
		exit();
	}
	
	
	public function lang()
	{
		include PATH_LANG.'/common.php';
		return $_LANG;
	}
}
?>

模板页面html和js：

<!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>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<style type="text/css">
</style>
<title></title>
<script type="text/javascript" src="http://lib.sinaapp.com/js/jquery/1.7.2/jquery.min.js"></script>
<script type='text/javascript' src='./static/js/jquery-autocomplete/jquery.autocomplete.js'></script>
<script type='text/javascript' src='./static/js/jquery-autocomplete/localdata.js'></script>
<link rel="stylesheet" type="text/css" href="./static/js/jquery-autocomplete/jquery.autocomplete.css" />
</head>
<body>
<script type="text/javascript">
function initAutoComplete(json){
	$("#suggest13").autocomplete(json , {
		minChars: 0,
		max: 10,
		width:260,
		//dataType:"json",
		matchContains: true,
		matchCase: false,
		autoComplete: true,
		autoFill: false,
		scrollHeight: 220,
		mustMatch: true,
		formatItem: function(row, i, max) {
			 return row.name;
		},
		formatMatch: function(row, i, max) {
			 return row.name;
		},
		formatResult: function(row) {
			 return row.name;
		}
	});
}
$().ready(function() {
	$("#suggest1").focus().autocomplete(cities);	
	$("#suggest13").focus(function(){
		var url = "http://xxxx.com/?c=try&a=ajax_diy";
		$.post(url,{},function(data){
			initAutoComplete(data);
		},"json");
	});
	
})
</script>
	<form autocomplete="off">
		<p>
			<label>Single City (local):</label>
			<input type="text" id="suggest1" />
			<input type="button" value="Get Value" />
		</p>
		<p>
			<label>E-Mail (local):</label>
			<input type="text" id="suggest13" />
			<input type="button" value="Get Value" />
		</p>
	</form>
	
</body>
</html>

当然，如果功能上没有这么高的要求，也可以用ajax自己手写一个小的下拉菜单提示功能。可以参考技术宅男文章：http://www.cnblogs.com/quguichuan/archive/2009/09/24/1573087.html

var $autocomplete = $("<ul class='autocomplete'></ul>").hide().insertAfter("#search-text");
          $("#search-text").keyup(function() {

              $.get("e.aspx", { "search-text": $("#search-text").val() }, function(data) {

                  if (data.length) {
                      $autocomplete.empty();

                      var arr = data.substring(0, data.length - 1).split(',');
                      $.each(arr, function(index, term) {
                          $("<li></li>").text(term).appendTo($autocomplete).mouseover(function() {
                              $(this).css("background", "green");
                          }).mouseout(function() {
                              $(this).css("background", "white");
                          })
                          .click(function() {
                              $("#search-text").val(term);
                              $autocomplete.hide();
                          });
                      });
                      $autocomplete.show();
                  }

              });
          }).blur(function() {
          setTimeout(function() {
          $autocomplete.hide();
              },500);
            
          });