jquery autocomplete
最近工作稍微有点清闲，经理给安排了一个实现autocomplete的样例。这个以前看到某些文章时没当回事，现在开始写的时候各种挠头。
因为之前用jQuery.UI完成了一个小的日程管理系统，发现jQuery.UI里有一个jquery.ui.autocomplete.js这个文件，我就先用这个试着完成以下，可是竟然没想到，完成autocomplete这个功能不仅仅只需要这一个文件，还需要jquery.ui.core.js, jquery.ui.widget.js, jquery.ui.position.js, jquery.ui.menu.js, 再加上jquery-1.9.0.min.js，一共有6个js文件，164KB，太庞大了，不过本着优先实现功能的原则，就先将就着吧。
到这里还没完呢，还要加载一个CSS文件，保证样式的准确性：jquery.ui.theme.css
前端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> <title>autocomplete</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Language" content="zh-CN" /> <meta name="Keywords" content="" /> <meta name="Description" content="" /> <link rel="stylesheet" href="./jquery.ui.theme.css" type="text/css" /> <style type="text/css"> .ui-autocomplete { border-radius:0; margin-left:0; padding:0; position: absolute;top: 0;left: 0;cursor: default;} .ui-autocomplete * { border-radius:0; } </style> </head> <body> <input type="text" id="keyword"/> </body> </html> <script type="text/javascript" src="./jquery-1.9.0.min.js"></script> <script type="text/javascript" src="./jquery.ui.core.js"></script> <script type="text/javascript" src="./jquery.ui.widget.js"></script> <script type="text/javascript" src="./jquery.ui.position.js"></script> <script type="text/javascript" src="./jquery.ui.menu.js"></script> <script type="text/javascript" src="./jquery.ui.autocomplete.js"></script> <script type="text/javascript"> $(function(){ $("#keyword").autocomplete({ minLength:1, source: function(request, response) { $.ajax({ url: "./php/test.php", dataType: "json", data: request, success: function( data ) { response( data ); } }); } }); }); </script>
后台PHP的代码：
<?php $g = $_REQUEST; $term = $g['term']; if(empty($term)){ exit; } $term = strtolower($term); $items = array( "Great Bittern"=>"Botaurus stellaris", "Little Grebe"=>"Tachybaptus ruficollis", "Black-necked Grebe"=>"Podiceps nigricollis", "Little Bittern"=>"Ixobrychus minutus", "Black-crowned Night Heron"=>"Nycticorax nycticorax", "Purple Heron"=>"Ardea purpurea", "White Stork"=>"Ciconia ciconia", "Spoonbill"=>"Platalea leucorodia", "Red-crested Pochard"=>"Netta rufina", "北京"=>"首都北京", "天津"=>"天津", "上海"=>"上海", ); //preg_replace("/($keyword)/i", "<b style='color:red'>\\1</b>", $rs->title) $result = array(); foreach ($items as $key=>$value) { $pos = strpos(strtolower($key), $term); if(is_bool($pos)) continue; if ($pos == 0) { //只显示首部匹配成功的 array_push($result, array("id"=>$value, "label"=>$key, "value" => strip_tags($key))); } } echo json_encode($result);
实现功能后，就需要对程序进行优化了，可是这全是jqueryui的库文件怎么办？后来还是去网上搜了一下，毕竟程序员为了提高自己，都会自己写一些这样的插件。参看这篇文章：http://www.cnblogs.com/Peter-Zhang/archive/2011/10/22/2221147.html，里面给出了插件的下载地址。我把autocomplete.js和autocomplete.css也上传到了自己的博客园，也可以从这里下载：
https://files.cnblogs.com/xumengxuan/jquery.autocomplete.js
https://files.cnblogs.com/xumengxuan/jquery.autocomplete.css
我们可以发现这次仅仅需要autocomplete.js和jquery.js就行了 ，其他的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> <title>autocomplete</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Language" content="zh-CN" /> <meta name="Keywords" content="" /> <meta name="Description" content="" /> <link rel="stylesheet" type="text/css" href="./lib/jquery.autocomplete.css" /> </head> <body> <input type="text" id="search" style="width:200px;" value=""/> </body> </html> <script type="text/javascript" src="./lib/jquery-1.8.0.min.js"></script> <script type="text/javascript" src="./lib/jquery.autocomplete.js"></script> <script type="text/javascript"> //http://www.cnblogs.com/Peter-Zhang/archive/2011/10/22/2221147.html $(function(){ $("#search").autocomplete('test.php', { dataType: "json", width: "300px", parse: function(data) { return $.map(data, function(row) { return { data: row, value: row.name, result: row.name } }); }, formatItem: function(item) { //返回结果下拉呈现的形式 //return format(item); return "<table width='300px'><tr><td align='left'>" + item.name + "</td></tr></table>"; } }).result(function(event, data){ //选择完成后执行的操作 //console.log(data); }) }) </script>
parse参数暂时还不明白是什么意思，不过删了竟然还报错。
后台的PHP文件：
<?php $q = strtolower($_GET["q"]); if (!$q) return; $items = array( "aa"=>"123", "abcd"=>"2", "bb"=>"345", "bbc"=>"235", "bcd"=>"435475", "cc"=>"4564", "ca"=>"12356", "cba"=>"3244", "ccc"=>"67755", "dbca"=>"43534", "北京"=>"北京",
"上海"=>"上海"
); $result = array(); foreach ($items as $key=>$value) { $pos = strpos(strtolower($key), $q); if(is_bool($pos)) continue; if ($pos == 0) { array_push($result, array( "name" => $key, "to" => $value )); } } echo json_encode($result); ?>
好了，一个autocomplete功能就这样完成了。当然我们在实际的应用中还会遇到autocomplete的各种变形，比如email的提示：
好吧，目前我还没有头绪用本地的数据进行填充，还是要发送到服务器，然后服务器返回一组json数据构成下拉列表。这样只需要修改后台的PHP文件即可，
<?php $q = strtolower($_GET["q"]); if (!$q) return; $items = array("@163.com", "@qq.com", "@126.com", "@hotmail.com", "@gmail.com"); $result = array(); foreach ($items as $key=>$value) { array_push($result, array( "name" => $q . $value, )); } echo json_encode($result); ?>
OK，email提示也做好了。
* 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)
此事件会在用户选中某一项后触发，参数为：
event: 事件对象. event.type为result.
data: 选中的数据行.
formatted:formatResult函数返回的值
例如：
$("#singleBirdRemote").result(function(event, data, formatted) {
//如选择后给其他控件赋值，触发别的事件等等
});
